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

public abstract Class KeywordGroup

extends AbstractGroup
Class Inheritance
Known Direct Subclasses
org.jabref.model.groups.LastNameGroup, org.jabref.model.groups.RegexKeywordGroup, org.jabref.model.groups.WordKeywordGroup
Imports
java.util.Objects, org.jabref.model.entry.field.Field

Matches entries based on a search phrase relative to the content in a specified field.

Field Summary

Modifier and TypeField and Description
protected final boolean
protected final String
protected final Field
Inherited from org.jabref.model.groups.AbstractGroup:
colorcontextdescriptioniconNameisExpandedname

Constructor Summary

AccessConstructor and Description
public
KeywordGroup(String name, GroupHierarchyType context, Field searchField, String searchExpression, boolean caseSensitive)

Method Summary

Modifier and TypeMethod and Description
public boolean
equals(Object o)

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

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

public String
public Field
public int
hashCode()

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

Returns a hash code value for this object.

public boolean
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.

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

Field Detail

caseSensitiveback to summary
protected final boolean caseSensitive
searchExpressionback to summary
protected final String searchExpression
searchFieldback to summary
protected final Field searchField

Constructor Detail

KeywordGroupback to summary
public KeywordGroup(String name, GroupHierarchyType context, Field searchField, String searchExpression, boolean caseSensitive)

Method Detail

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.

Annotations
@Override
getSearchExpressionback to summary
public String getSearchExpression()
getSearchFieldback to summary
public Field getSearchField()
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.
Annotations
@Override
isCaseSensitiveback to summary
public boolean isCaseSensitive()
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