JabRef 6.0-beta.1 · org.jabref.model.groups.SearchGroup

Modifier and Type	Field and Description
private static final Logger	LOGGER
private final Set<String>	matchedEntries
private SearchQuery	searchQuery

Access	Constructor and Description
public	SearchGroup(String name, GroupHierarchyType context, String searchExpression, EnumSet<SearchFlags> searchFlags)

Modifier and Type	Method and Description
public boolean	contains(BibEntry entry) Implements abstract org.jabref.model.groups.AbstractGroup.contains.
public AbstractGroup	deepCopy() Implements abstract org.jabref.model.groups.AbstractGroup.deepCopy.
public boolean	equals(Object o) Overrides org.jabref.model.groups.AbstractGroup.equals. Indicates whether some other object is "equal to" this one.
public String	getSearchExpression()
public EnumSet<SearchFlags>	getSearchFlags()
public SearchQuery	getSearchQuery()
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 void	setMatchedEntries(Collection<String> entriesId)
public void	setSearchExpression(String searchExpression) Used by `org.jabref.gui.importer.actions.SearchGroupsMigrationAction` to update the search expression.
public String	toString() Overrides org.jabref.model.groups.AbstractGroup.toString. Returns a string representation of the object.
public void	updateMatches(BibEntry entry, boolean matched)

LOGGER	back to summary
private static final Logger LOGGER

matchedEntries	back to summary
private final Set<String> matchedEntries

searchQuery	back to summary
private SearchQuery searchQuery

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

Method Detail

contains	back to summary
public boolean contains(BibEntry entry) Implements abstract org.jabref.model.groups.AbstractGroup.contains. Annotations @Override

contains

back to summary

public boolean contains(BibEntry entry)

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

Annotations

@Override

deepCopy	back to summary
public AbstractGroup deepCopy() Implements abstract org.jabref.model.groups.AbstractGroup.deepCopy. Annotations @Override

deepCopy

back to summary

public AbstractGroup deepCopy()

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

Annotations

@Override

equals back to summary

equals	back 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

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

getSearchExpression	back to summary
public String getSearchExpression()

getSearchFlags	back to summary
public EnumSet<SearchFlags> getSearchFlags()

getSearchQuery	back to summary
public SearchQuery getSearchQuery()

hashCode back to summary

hashCode	back 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

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

isDynamic	back 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

isDynamic

back 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

setMatchedEntries	back to summary
public void setMatchedEntries(Collection<String> entriesId)

setSearchExpression	back to summary
public void setSearchExpression(String searchExpression) Used by `org.jabref.gui.importer.actions.SearchGroupsMigrationAction` to update the search expression. Do not use otherwise.

toString back to summary

toString	back 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. Annotations @Override

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.

Annotations

@Override

updateMatches	back to summary
public void updateMatches(BibEntry entry, boolean matched)

public Class SearchGroup

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail