Top Description Fields Constructors Methods
org.jabref.model.groups

public Class SearchGroup

extends AbstractGroup
Class Inheritance
Imports
java.util.EnumSet, .Objects, org.jabref.model.entry.BibEntry, org.jabref.model.search.GroupSearchQuery, org.jabref.model.search.rules.SearchRules.SearchFlags, org.slf4j.Logger, .LoggerFactory

This group matches entries by a complex search pattern, which might include conditions about the values of multiple fields.

Field Summary

Modifier and TypeField and Description
private static final Logger
private final GroupSearchQuery
Inherited from org.jabref.model.groups.AbstractGroup:
colorcontextdescriptioniconNameisExpandedname

Constructor Summary

AccessConstructor and Description
public
SearchGroup(String name, GroupHierarchyType context, String searchExpression, EnumSet<SearchRules.SearchFlags> searchFlags)

Method Summary

Modifier and TypeMethod and Description
public boolean
public AbstractGroup
public boolean
equals(Object
the reference object with which to compare.
o
)

Overrides org.jabref.model.groups.AbstractGroup.equals.

Indicates whether some other object is "equal to" this one.

public String
public EnumSet<SearchRules.SearchFlags>
public int
hashCode()

Overrides org.jabref.model.groups.AbstractGroup.hashCode.

Returns a hash code value for this object.

public boolean
isDynamic()

Implements abstract org.jabref.model.groups.AbstractGroup.isDynamic.

Returns true if this group is dynamic, i.e. uses a search definition or equiv.

public String
toString()

Overrides org.jabref.model.groups.AbstractGroup.toString.

Returns a string representation of the object.

Inherited from org.jabref.model.groups.AbstractGroup:
containsAllcontainsAnygetColorgetDescriptiongetHierarchicalContextgetIconNamegetNameisExpandedisMatchnamePropertysetColorsetColorsetDescriptionsetExpandedsetIconName

Field Detail

LOGGERback to summary
private static final Logger LOGGER
queryback to summary
private final GroupSearchQuery query

Constructor Detail

SearchGroupback to summary
public SearchGroup(String name, GroupHierarchyType context, String searchExpression, EnumSet<SearchRules.SearchFlags> searchFlags)

Method Detail

containsback to summary
public boolean contains(BibEntry entry)

Implements abstract org.jabref.model.groups.AbstractGroup.contains.

Returns:boolean

Doc from org.jabref.model.groups.AbstractGroup.contains.

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

Annotations
@Override
deepCopyback to summary
public AbstractGroup deepCopy()

Implements abstract org.jabref.model.groups.AbstractGroup.deepCopy.

Returns:AbstractGroup

Doc from org.jabref.model.groups.AbstractGroup.deepCopy.

A deep copy of this object.

Annotations
@Override
equalsback to summary
public boolean equals(Object o)

Overrides org.jabref.model.groups.AbstractGroup.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
o:Object

the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations
@Override
getSearchExpressionback to summary
public String getSearchExpression()
getSearchFlagsback to summary
public EnumSet<SearchRules.SearchFlags> getSearchFlags()
hashCodeback to summary
public int hashCode()

Overrides org.jabref.model.groups.AbstractGroup.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Returns:int

a hash code value for this object

Annotations
@Override
isDynamicback to summary
public boolean isDynamic()

Implements abstract org.jabref.model.groups.AbstractGroup.isDynamic.

Doc from org.jabref.model.groups.AbstractGroup.isDynamic.

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.

Annotations
@Override
toStringback to summary
public String toString()

Overrides org.jabref.model.groups.AbstractGroup.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations
@Override