public Class GroupTreeNode

Adds the specified entries to this group. If the group does not support explicit adding of entries (i.e., does not implement GroupEntryChanger), then no action is performed.

Implements abstract org.jabref.model.TreeNode.copyNode.

Doc from org.jabref.model.TreeNode.copyNode.

Creates a copy of this node, completely separated from the tree (i.e. no children and no parent)

Returns:GroupTreeNode

a deep copy of this node

Annotations

@Override

Overrides java.lang.Object.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

Determines the entries in the specified list which are matched by this group.

Parameters

entries:List<BibEntry>

list of entries to be searched

Returns:List<BibEntry>

matched entries

Determines the entries in the specified database which are matched by this group.

Parameters

database:BibDatabase

database to be searched

Returns:List<BibEntry>

matched entries

Finds a children using the given path. Each group name should be separated by PATH_DELIMITER.

The path should be generated using getPath().

Get only groups containing all the entries or just groups containing any of the

Parameters

entries:List<BibEntry>

List of BibEntry to search for

requireAll:boolean

Whether to return only groups that must contain all entries

Returns:List<GroupTreeNode>

List of GroupTreeNode containing the matches. AllEntriesGroup is always contained}

Returns the group underlying this node.

Returns:AbstractGroup

the group associated with this node

Determines all groups in the subtree starting at this node which contain the given entry.

Determines all groups in the subtree starting at this node which contain at least one of the given entries.

Get the name of the underlying group

Returns:String

String the name of the group

Get the path from the root of the tree as a string (every group name is separated by PATH_DELIMITER.

The name of the root is not included.

Creates a SearchMatcher that matches entries of this group and that takes the hierarchical information into account. I.e., it finds elements contained in this nodes group, or the union of those elements in its own group and its children's groups (recursively), or the intersection of the elements in its own group and its parent's group (depending on the hierarchical settings stored in the involved groups)

Overrides java.lang.Object.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

Returns true if the underlying groups of both GroupTreeNodes is the same.

Returns whether this group matches the specified BibEntry while taking the hierarchical information into account.

Removes the given entries from this group. If the group does not support the explicit removal of entries (i.e., does not implement GroupEntryChanger), then no action is performed.

Associates the specified group with this node.

Parameters

newGroup:AbstractGroup

the new group (has to be non-null)

Annotations

@Deprecated

Associates the specified group with this node while also providing the possibility to modify previous matched entries so that they are now matched by the new group.

Parameters

newGroup:AbstractGroup

the new group (has to be non-null)

shouldKeepPreviousAssignments:boolean

specifies whether previous matched entries should be added to the new group

shouldRemovePreviousAssignments:boolean

specifies whether previous matched entries should be removed from the old group

entriesInDatabase:List<BibEntry>

list of entries in the database

Overrides java.lang.Object.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