net.sf.jabref.groups

Class SearchGroup

java.lang.Object

net.sf.jabref.groups.AbstractGroup

net.sf.jabref.groups.SearchGroup

All Implemented Interfaces:

SearchRule

public class SearchGroup
extends AbstractGroup
implements SearchRule

Author:

jzieren TODO To change the template for this generated type comment go to Window - Preferences - Java - Code Style - Code Templates

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ID

Fields inherited from class net.sf.jabref.groups.AbstractGroup

INCLUDING, INDEPENDENT, m_context, m_name, QUOTE_CHAR, REFINING, SEPARATOR

Constructor Summary

Constructors

Constructor and Description
SearchGroup(java.lang.String name, java.lang.String searchExpression, boolean caseSensitive, boolean regExp, int context) Creates a SearchGroup with the specified properties.

Method Summary

Modifier and Type	Method and Description
javax.swing.undo.AbstractUndoableEdit	add(BibtexEntry[] entries) Adds the specified entries to this group.
int	applyRule(java.util.Map<java.lang.String,java.lang.String> searchOptions, BibtexEntry entry)
boolean	contains(BibtexEntry entry)
boolean	contains(java.util.Map<java.lang.String,java.lang.String> searchOptions, BibtexEntry entry)
AbstractGroup	deepCopy()
protected static java.lang.String	describeNode(antlr.collections.AST node, boolean regExp, boolean not, boolean and, boolean or)
boolean	equals(java.lang.Object o)
static AbstractGroup	fromString(java.lang.String s, BibtexDatabase db, int version) Parses s and recreates the SearchGroup from it.
java.lang.String	getDescription() Returns a lengthy textual description of this instance (for the groups editor).
static java.lang.String	getDescriptionForPreview(java.lang.String expr, antlr.collections.AST ast, boolean caseSensitive, boolean regExp)
java.lang.String	getSearchExpression()
SearchRule	getSearchRule()
java.lang.String	getShortDescription() Returns a short description of the group in HTML (for a tooltip).
java.lang.String	getTypeId()
boolean	isCaseSensitive()
boolean	isDynamic() Returns true if this group is dynamic, i.e.
boolean	isRegExp()
javax.swing.undo.AbstractUndoableEdit	remove(BibtexEntry[] entries) Removes the specified entries from this group.
boolean	supportsAdd()
boolean	supportsRemove()
java.lang.String	toString() Returns a String representation of this object that can be used to reconstruct it.
boolean	validateSearchStrings(java.util.Map<java.lang.String,java.lang.String> searchStrings)

Methods inherited from class net.sf.jabref.groups.AbstractGroup

containsAll, containsAny, getHierarchicalContext, getName, refreshForNewDatabase, setHierarchicalContext, setName

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

ID

public static final java.lang.String ID

See Also:

Constant Field Values

Constructor Detail

SearchGroup

public SearchGroup(java.lang.String name,
                   java.lang.String searchExpression,
                   boolean caseSensitive,
                   boolean regExp,
                   int context)

Creates a SearchGroup with the specified properties.

Method Detail

fromString

public static AbstractGroup fromString(java.lang.String s,
                                       BibtexDatabase db,
                                       int version)
                                throws java.lang.Exception

Parses s and recreates the SearchGroup from it.

Parameters:

s - The String representation obtained from SearchGroup.toString(), or null if incompatible

Throws:

java.lang.Exception

getTypeId

public java.lang.String getTypeId()

Specified by:

getTypeId in class AbstractGroup

getSearchRule

public SearchRule getSearchRule()

Specified by:

getSearchRule in class AbstractGroup

Returns:

A search rule that will identify this group's entries.

See Also:

AbstractGroup.getSearchRule()

toString

public java.lang.String toString()

Returns a String representation of this object that can be used to reconstruct it.

Overrides:

toString in class java.lang.Object

getSearchExpression

public java.lang.String getSearchExpression()

supportsAdd

public boolean supportsAdd()

Specified by:

supportsAdd in class AbstractGroup

Returns:

true if this type of group supports the explicit adding of entries.

supportsRemove

public boolean supportsRemove()

Specified by:

supportsRemove in class AbstractGroup

Returns:

true if this type of group supports the explicit removal of entries.

add

public javax.swing.undo.AbstractUndoableEdit add(BibtexEntry[] entries)

Description copied from class: AbstractGroup

Adds the specified entries to this group.

Specified by:

add in class AbstractGroup

Returns:

If this group or one or more entries was/were modified as a result of this operation, an object is returned that allows to undo this change. null is returned otherwise.

remove

public javax.swing.undo.AbstractUndoableEdit remove(BibtexEntry[] entries)

Description copied from class: AbstractGroup

Removes the specified entries from this group.

Specified by:

remove in class AbstractGroup

Returns:

If this group or one or more entries was/were modified as a result of this operation, an object is returned that allows to undo this change. null is returned otherwise.

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

contains

public boolean contains(java.util.Map<java.lang.String,java.lang.String> searchOptions,
                        BibtexEntry entry)

Specified by:

contains in class AbstractGroup

Parameters:

searchOptions - The search options to apply.

Returns:

true if this group contains the specified entry, false otherwise.

contains

public boolean contains(BibtexEntry entry)

Specified by:

contains in class AbstractGroup

Returns:

true if this group contains the specified entry, false otherwise.

applyRule

public int applyRule(java.util.Map<java.lang.String,java.lang.String> searchOptions,
                     BibtexEntry entry)

Specified by:

applyRule in interface SearchRule

deepCopy

public AbstractGroup deepCopy()

Specified by:

deepCopy in class AbstractGroup

Returns:

A deep copy of this object.

isCaseSensitive

public boolean isCaseSensitive()

isRegExp

public boolean isRegExp()

isDynamic

public boolean isDynamic()

Description copied from class: AbstractGroup

Returns true if this group is dynamic, i.e. uses a search definition or equiv. that might match new entries, or false if this group contains a fixed set of entries and thus will never match a new entry that was not explicitly added to it.

Specified by:

isDynamic in class AbstractGroup

getDescription

public java.lang.String getDescription()

Description copied from class: AbstractGroup

Returns a lengthy textual description of this instance (for the groups editor). The text is formatted in HTML.

Specified by:

getDescription in class AbstractGroup

getDescriptionForPreview

public static java.lang.String getDescriptionForPreview(java.lang.String expr,
                                                        antlr.collections.AST ast,
                                                        boolean caseSensitive,
                                                        boolean regExp)

describeNode

protected static java.lang.String describeNode(antlr.collections.AST node,
                                               boolean regExp,
                                               boolean not,
                                               boolean and,
                                               boolean or)

getShortDescription

public java.lang.String getShortDescription()

Description copied from class: AbstractGroup

Returns a short description of the group in HTML (for a tooltip).

Specified by:

getShortDescription in class AbstractGroup

validateSearchStrings

public boolean validateSearchStrings(java.util.Map<java.lang.String,java.lang.String> searchStrings)

Specified by:

validateSearchStrings in interface SearchRule