Verified Owner
Top Description Inners Fields Constructors Methods
org.jabref.logic.bibtex.comparator

public Class FieldComparator

extends Object
implements Comparator<BibEntry>
Class Inheritance
All Implemented Interfaces
java.util.Comparator
Imports
java.text.Collator, .ParseException, .RuleBasedCollator, java.util.Comparator, .Locale, .Optional, org.jabref.logic.util.strings.StringUtil, org.jabref.model.entry.AuthorList, .BibEntry, .Month, org.jabref.model.entry.field.Field, .FieldProperty, .InternalField, .OrFields, .StandardField, org.jabref.model.metadata.SaveOrder

A comparator for BibEntry fields

Nested and Inner Type Summary

Modifier and TypeClass and Description
pack-priv static enum

Field Summary

Modifier and TypeField and Description
private static final Collator
private final OrFields
private final FieldComparator.FieldType
private final boolean
private final int

Constructor Summary

AccessConstructor and Description
public
public
public
FieldComparator(OrFields fields, boolean descending)

Method Summary

Modifier and TypeMethod and Description
public int
compare(BibEntry e1, BibEntry e2)

Implements java.util.Comparator.compare.

Compares its two arguments for order.

private FieldComparator.FieldType
private static Collator
private Optional<String>
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

COLLATORback to summary
private static final Collator COLLATOR
fieldsback to summary
private final OrFields fields
fieldTypeback to summary
private final FieldComparator.FieldType fieldType
isNumericback to summary
private final boolean isNumeric
multiplierback to summary
private final int multiplier

Constructor Detail

FieldComparatorback to summary
public FieldComparator(Field field)
FieldComparatorback to summary
public FieldComparator(SaveOrder.SortCriterion sortCriterion)
FieldComparatorback to summary
public FieldComparator(OrFields fields, boolean descending)

Method Detail

compareback to summary
public int compare(BibEntry e1, BibEntry e2)

Implements java.util.Comparator.compare.

Doc from java.util.Comparator.compare.

Compares its two arguments for order. Returns a negative integer, zero, or a positive integer as the first argument is less than, equal to, or greater than the second.

The implementor must ensure that signum(compare(x, y)) == -signum(compare(y, x)) for all x and y. (This implies that compare(x, y) must throw an exception if and only if compare(y, x) throws an exception.)

The implementor must also ensure that the relation is transitive: ((compare(x, y)>0) && (compare(y, z)>0)) implies compare(x, z)>0.

Finally, the implementor must ensure that compare(x, y)==0 implies that signum(compare(x, z))==signum(compare(y, z)) for all z.

Annotations
@Override
determineFieldTypeback to summary
private FieldComparator.FieldType determineFieldType()
getCollatorback to summary
private static Collator getCollator()
getFieldValueback to summary
private Optional<String> getFieldValue(BibEntry entry)
org.jabref.logic.bibtex.comparator back to summary

pack-priv final Enum FieldComparator.FieldType

extends Enum<FieldComparator.FieldType>
Class Inheritance

Field Summary

Modifier and TypeField and Description
public static final FieldComparator.FieldType
public static final FieldComparator.FieldType
public static final FieldComparator.FieldType
public static final FieldComparator.FieldType
public static final FieldComparator.FieldType

Constructor Summary

AccessConstructor and Description
private

Method Summary

Modifier and TypeMethod and Description
public static FieldComparator.FieldType
public static FieldComparator.FieldType[]
Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinaltoStringvalueOf

Field Detail

MONTHback to summary
public static final FieldComparator.FieldType MONTH
NAMEback to summary
public static final FieldComparator.FieldType NAME
OTHERback to summary
public static final FieldComparator.FieldType OTHER
TYPEback to summary
public static final FieldComparator.FieldType TYPE
YEARback to summary
public static final FieldComparator.FieldType YEAR

Constructor Detail

FieldTypeback to summary
private FieldType()

Method Detail

valueOfback to summary
public static FieldComparator.FieldType valueOf(String name)
valuesback to summary
public static FieldComparator.FieldType[] values()