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

public Class AutomaticDateGroup

extends AutomaticGroup
Class Inheritance
Imports
java.util.LinkedHashSet, .Objects, .Set, org.jabref.model.entry.BibEntry, org.jabref.model.entry.field.Field

Field Summary

Modifier and TypeField and Description
private final Field
private final DateGranularity

Constructor Summary

AccessConstructor and Description
public
public

Method Summary

Modifier and TypeMethod and Description
public Set<GroupTreeNode>
public AbstractGroup
public boolean
equals(Object o)

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

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

public Field

Returns:

The field (e.g., StandardField.DATE or StandardField.YEAR)
getField
()

Gets the field used for date extraction.

public DateGranularity

Returns:

The granularity (YEAR, MONTH, or FULL_DATE)
getGranularity
()

Gets the granularity level for date grouping.

public int
hashCode()

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

Returns a hash code value for this object.

Inherited from org.jabref.model.groups.AutomaticGroup:
containscreateSubgroupsisDynamic

Field Detail

fieldback to summary
private final Field field
granularityback to summary
private final DateGranularity granularity

Constructor Detail

AutomaticDateGroupback to summary
public AutomaticDateGroup(String name, GroupHierarchyType context, Field field)
AutomaticDateGroupback to summary
public AutomaticDateGroup(String name, GroupHierarchyType context, Field field, DateGranularity granularity)

Method Detail

createSubgroupsback to summary
public Set<GroupTreeNode> createSubgroups(BibEntry entry)

Implements abstract org.jabref.model.groups.AutomaticGroup.createSubgroups.

Annotations
@Override
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.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
getFieldback to summary
public Field getField()

Gets the field used for date extraction. Required by GroupSerializer for serialization.

Returns:Field

The field (e.g., StandardField.DATE or StandardField.YEAR)

getGranularityback to summary
public DateGranularity getGranularity()

Gets the granularity level for date grouping. Required by GroupSerializer for serialization.

Returns:DateGranularity

The granularity (YEAR, MONTH, or FULL_DATE)

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