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

public Class WordKeywordGroup

extends KeywordGroup
implements GroupEntryChanger
Class Inheritance
All Implemented Interfaces
org.jabref.model.groups.GroupEntryChanger
Known Direct Subclasses
org.jabref.model.groups.ExplicitGroup
Annotations
@AllowedToUseLogic:Uses StringUtil temporarily
Imports
java.util.ArrayList, .Collection, .HashSet, .List, .Objects, .Set, java.util.stream.Collectors, org.jabref.architecture.AllowedToUseLogic, org.jabref.logic.util.strings.StringUtil, org.jabref.model.FieldChange, org.jabref.model.entry.BibEntry, .KeywordList, org.jabref.model.entry.field.Field, .InternalField, org.jabref.model.entry.types.EntryType, .EntryTypeFactory, org.jabref.model.util.ListUtil, org.jspecify.annotations.NonNull

Matches entries if a given field contains a specified word.

Nested and Inner Type Summary

Modifier and TypeClass and Description
pack-priv class
pack-priv static interface
pack-priv class
pack-priv class

Field Summary

Modifier and TypeField and Description
protected final Character
private final boolean
private final WordKeywordGroup.SearchStrategy
Inherited from org.jabref.model.groups.KeywordGroup:
caseSensitivesearchExpressionsearchField

Constructor Summary

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

Method Summary

Modifier and TypeMethod and Description
public List<FieldChange>
add(@NonNull Collection<BibEntry> entriesToAdd)

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

Adds the specified entries to this group.

public boolean
private static boolean
containsCaseInsensitive(Set<String> searchIn, String[] searchWords)

public AbstractGroup
public boolean
equals(Object 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(@NonNull List<BibEntry> entriesToRemove)

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

Removes the specified entries from this group.

public WordKeywordGroup
withKeywordSeparator(Character newKeywordSeparator)

Inherited from org.jabref.model.groups.KeywordGroup:
getSearchExpressiongetSearchFieldisCaseSensitiveisDynamic

Field Detail

keywordSeparatorback to summary
protected final Character keywordSeparator
onlySplitWordsAtSeparatorback to summary
private final boolean onlySplitWordsAtSeparator
searchStrategyback to summary
private final WordKeywordGroup.SearchStrategy searchStrategy

Constructor Detail

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

Method Detail

addback to summary
public List<FieldChange> add(@NonNull 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.

Annotations
@Override
containsback to summary
public boolean contains(BibEntry entry)

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

Annotations
@Override
containsCaseInsensitiveback to summary
private static boolean containsCaseInsensitive(Set<String> searchIn, String[] searchWords)
deepCopyback to summary
public AbstractGroup deepCopy()

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

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

Annotations
@Override
hashCodeback 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.
Annotations
@Override
removeback to summary
public List<FieldChange> remove(@NonNull 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.

Annotations
@Override
withKeywordSeparatorback to summary
public WordKeywordGroup withKeywordSeparator(Character newKeywordSeparator)
org.jabref.model.groups back to summary

pack-priv Class WordKeywordGroup.KeywordListSearchStrategy

extends Object
implements SearchStrategy
Class Inheritance
  • java.lang.Object
  • org.jabref.model.groups.WordKeywordGroup.KeywordListSearchStrategy
All Implemented Interfaces
org.jabref.model.groups.WordKeywordGroup.SearchStrategy

Field Summary

Modifier and TypeField and Description
private final KeywordList

Constructor Summary

AccessConstructor and Description
pack-priv

Method Summary

Modifier and TypeMethod and Description
public boolean
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

searchWordsback to summary
private final KeywordList searchWords

Constructor Detail

KeywordListSearchStrategyback to summary
pack-priv KeywordListSearchStrategy()

Method Detail

containsback to summary
public boolean contains(BibEntry entry)

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

Annotations
@Override
org.jabref.model.groups back to summary

pack-priv Interface WordKeywordGroup.SearchStrategy

Known Direct Implementers
org.jabref.model.groups.WordKeywordGroup.StringSearchStrategy, org.jabref.model.groups.WordKeywordGroup.TypeSearchStrategy, org.jabref.model.groups.WordKeywordGroup.KeywordListSearchStrategy

Method Summary

Modifier and TypeMethod and Description
public boolean

Method Detail

containsback to summary
public boolean contains(BibEntry entry)
org.jabref.model.groups back to summary

pack-priv Class WordKeywordGroup.StringSearchStrategy

extends Object
implements SearchStrategy
Class Inheritance
  • java.lang.Object
  • org.jabref.model.groups.WordKeywordGroup.StringSearchStrategy
All Implemented Interfaces
org.jabref.model.groups.WordKeywordGroup.SearchStrategy
Annotations
@AllowedToUseLogic:Uses StringUtil temporarily

Field Summary

Modifier and TypeField and Description
private final String[]
private final Set<String>

Constructor Summary

AccessConstructor and Description
pack-priv

Method Summary

Modifier and TypeMethod and Description
public boolean
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

caseInsensitiveSearchWordsback to summary
private final String[] caseInsensitiveSearchWords
searchWordsback to summary
private final Set<String> searchWords

Constructor Detail

StringSearchStrategyback to summary
pack-priv StringSearchStrategy()

Method Detail

containsback to summary
public boolean contains(BibEntry entry)

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

Annotations
@Override
org.jabref.model.groups back to summary

pack-priv Class WordKeywordGroup.TypeSearchStrategy

extends Object
implements SearchStrategy
Class Inheritance
All Implemented Interfaces
org.jabref.model.groups.WordKeywordGroup.SearchStrategy

Field Summary

Modifier and TypeField and Description
pack-priv Set<EntryType>

Constructor Summary

AccessConstructor and Description
pack-priv

Method Summary

Modifier and TypeMethod and Description
public boolean
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

searchWordsback to summary
pack-priv Set<EntryType> searchWords

Constructor Detail

TypeSearchStrategyback to summary
pack-priv TypeSearchStrategy()

Method Detail

containsback to summary
public boolean contains(BibEntry entry)

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

Annotations
@Override