JabRef 5.15 · org.jabref.model.groups.WordKeywordGroup

Modifier and Type	Class and Description
pack-priv class	WordKeywordGroup.KeywordListSearchStrategy
pack-priv static interface	WordKeywordGroup.SearchStrategy
pack-priv class	WordKeywordGroup.StringSearchStrategy
pack-priv class	WordKeywordGroup.TypeSearchStrategy

Field Summary

Modifier and Type	Field and Description
protected final Character	keywordSeparator
private final boolean	onlySplitWordsAtSeparator
private final WordKeywordGroup.SearchStrategy	searchStrategy

Inherited from org.jabref.model.groups.KeywordGroup:: caseSensitive searchExpression searchField

Constructor Summary

Access	Constructor and Description
public	WordKeywordGroup(String name, GroupHierarchyType context, Field searchField, String searchExpression, boolean caseSensitive, Character keywordSeparator, boolean onlySplitWordsAtSeparator)

Method Summary

Modifier and Type	Method and Description
public List<FieldChange>	add(Collection<BibEntry> entriesToAdd) Implements org.jabref.model.groups.GroupEntryChanger.add. Adds the specified entries to this group.
public boolean	contains(BibEntry entry) Implements abstract org.jabref.model.groups.AbstractGroup.contains.
private static boolean	containsCaseInsensitive(Set<String> searchIn, Collection<String> searchFor)
private static boolean	containsCaseInsensitive(Set<String> searchIn, String searchFor)
public AbstractGroup	deepCopy() Implements abstract org.jabref.model.groups.AbstractGroup.deepCopy.
public boolean	equals(Object the reference object with which to compare. o) Overrides org.jabref.model.groups.KeywordGroup.equals. Indicates whether some other object is "equal to" this one.
public int	hashCode() Overrides org.jabref.model.groups.KeywordGroup.hashCode. Returns a hash code value for this object.
public List<FieldChange>	remove(List<BibEntry> entriesToRemove) Implements org.jabref.model.groups.GroupEntryChanger.remove. Removes the specified entries from this group.

Inherited from org.jabref.model.groups.KeywordGroup:: getSearchExpression getSearchField isCaseSensitive isDynamic

Field Detail

keywordSeparator	back to summary
protected final Character keywordSeparator

onlySplitWordsAtSeparator	back to summary
private final boolean onlySplitWordsAtSeparator

searchStrategy	back to summary
private final WordKeywordGroup.SearchStrategy searchStrategy

Constructor Detail

WordKeywordGroup	back to summary
public WordKeywordGroup(String name, GroupHierarchyType context, Field searchField, String searchExpression, boolean caseSensitive, Character keywordSeparator, boolean onlySplitWordsAtSeparator)

Method Detail

add	back to summary
public List<FieldChange> add(Collection<BibEntry> entriesToAdd) Implements org.jabref.model.groups.GroupEntryChanger.add. Doc from org.jabref.model.groups.GroupEntryChanger.add. Adds the specified entries to this group. Returns:List<FieldChange> If this group or one or more entries was/were modified as a result of this operation, a list of changes is returned. Annotations @Override

add

back to summary

public List<FieldChange> add(Collection<BibEntry> entriesToAdd)

Implements org.jabref.model.groups.GroupEntryChanger.add.

Doc from org.jabref.model.groups.GroupEntryChanger.add.

Adds the specified entries to this group.

Returns:List<FieldChange>

If this group or one or more entries was/were modified as a result of this operation, a list of changes is returned.

Annotations

@Override

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

contains

back 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

containsCaseInsensitive	back to summary
private static boolean containsCaseInsensitive(Set<String> searchIn, Collection<String> searchFor)

containsCaseInsensitive	back to summary
private static boolean containsCaseInsensitive(Set<String> searchIn, String searchFor)

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

deepCopy

back 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

equals back to summary

equals	back to summary
public boolean equals(Object o) Overrides org.jabref.model.groups.KeywordGroup.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

public boolean equals(Object o)

Overrides org.jabref.model.groups.KeywordGroup.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

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides org.jabref.model.groups.KeywordGroup.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

public int hashCode()

Overrides org.jabref.model.groups.KeywordGroup.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

remove	back to summary
public List<FieldChange> remove(List<BibEntry> entriesToRemove) Implements org.jabref.model.groups.GroupEntryChanger.remove. Doc from org.jabref.model.groups.GroupEntryChanger.remove. Removes the specified entries from this group. Returns:List<FieldChange> If this group or one or more entries was/were modified as a result of this operation, a list of changes is returned. Annotations @Override

remove

back to summary

public List<FieldChange> remove(List<BibEntry> entriesToRemove)

Implements org.jabref.model.groups.GroupEntryChanger.remove.

Doc from org.jabref.model.groups.GroupEntryChanger.remove.

Removes the specified entries from this group.

Returns:List<FieldChange>

If this group or one or more entries was/were modified as a result of this operation, a list of changes is returned.

Annotations

@Override

Field Summary

Modifier and Type	Field and Description
private final KeywordList	searchWords

Access	Constructor and Description
pack-priv	KeywordListSearchStrategy()

Method Summary

Modifier and Type	Method and Description
public boolean	contains(BibEntry entry) Implements org.jabref.model.groups.WordKeywordGroup.SearchStrategy.contains.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

searchWords	back to summary
private final KeywordList searchWords

Constructor Detail

KeywordListSearchStrategy	back to summary
pack-priv KeywordListSearchStrategy()

Method Detail

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

contains

back to summary

public boolean contains(BibEntry entry)

Implements org.jabref.model.groups.WordKeywordGroup.SearchStrategy.contains.

Annotations

@Override

Method Summary

Modifier and Type	Method and Description
public boolean	contains(BibEntry entry)

Method Detail

contains	back to summary
public boolean contains(BibEntry entry)

Modifier and Type	Field and Description
pack-priv Set<String>	searchWords

Access	Constructor and Description
pack-priv	StringSearchStrategy()

Method Summary

Modifier and Type	Method and Description
public boolean	contains(BibEntry entry) Implements org.jabref.model.groups.WordKeywordGroup.SearchStrategy.contains.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

searchWords	back to summary
pack-priv Set<String> searchWords

Constructor Detail

StringSearchStrategy	back to summary
pack-priv StringSearchStrategy()

Method Detail

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

contains

back to summary

public boolean contains(BibEntry entry)

Implements org.jabref.model.groups.WordKeywordGroup.SearchStrategy.contains.

Annotations

@Override

Modifier and Type	Field and Description
pack-priv Set<EntryType>	searchWords

Access	Constructor and Description
pack-priv	TypeSearchStrategy()

Method Summary

Modifier and Type	Method and Description
public boolean	contains(BibEntry entry) Implements org.jabref.model.groups.WordKeywordGroup.SearchStrategy.contains.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

searchWords	back to summary
pack-priv Set<EntryType> searchWords

Constructor Detail

TypeSearchStrategy	back to summary
pack-priv TypeSearchStrategy()

Method Detail

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

contains

back to summary

public boolean contains(BibEntry entry)

Implements org.jabref.model.groups.WordKeywordGroup.SearchStrategy.contains.

Annotations

@Override

public Class WordKeywordGroup

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv Class WordKeywordGroup.KeywordListSearchStrategy

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv Interface WordKeywordGroup.SearchStrategy

Method Summary

Method Detail

pack-priv Class WordKeywordGroup.StringSearchStrategy

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv Class WordKeywordGroup.TypeSearchStrategy

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail