Modifier and Type	Class and Description
public class	SSort.SortComparator A sort comparator returned by `comparator(SStyle, LLocale, AbbreviationProvider)`

Modifier and Type	Field and Description
private final List<SKey>	keys

Access	Constructor and Description
public	SSort(Node the XML node node) Creates the sort element from an XML node

Modifier and Type	Method and Description
public SSort.SortComparator	Returns: the comparator comparator(SStyle the current citation style style, LLocale the current locale locale, AbbreviationProvider the current abbreviation provider abbreviationProvider) Creates a comparator that is able to compare `CSLItemData` objects according

keys	back to summary
private final List<SKey> keys

SSort	back to summary
public SSort(Node node) Creates the sort element from an XML node Parameters node:Node the XML node

comparator	back to summary
public SSort.SortComparator comparator(SStyle style, LLocale locale, AbbreviationProvider abbreviationProvider) Creates a comparator that is able to compare `CSLItemData` objects according Parameters style:SStyle the current citation style locale:LLocale the current locale abbreviationProvider:AbbreviationProvider the current abbreviation provider Returns:SSort.SortComparator the comparator

de.undercouch.citeproc.csl.internal back to summary

public Class SSort.SortComparator

Class Inheritance

extends Object
implements Comparator<CSLItemData>

java.lang.Object
de.undercouch.citeproc.csl.internal.SSort.SortComparator

All Implemented Interfaces

java.util.Comparator

A sort comparator returned by comparator(SStyle, LLocale, AbbreviationProvider)

Field Summary

Modifier and Type	Field and Description
private final AbbreviationProvider	abbreviationProvider
private int	citationNumberDirection
private final AlphanumComparator	comparator
private final LLocale	locale
private final SStyle	style

Constructor Summary

Access	Constructor and Description
public	SortComparator(SStyle the current citation style style, LLocale the current locale locale, AbbreviationProvider the current abbreviation provider abbreviationProvider) Create a new sort comparator

Method Summary

Modifier and Type	Method and Description
public int	compare(CSLItemData a, CSLItemData b) Implements java.util.Comparator.compare. Compares its two arguments for order.
public int	Returns: the sort direction (`1` for ascending and `-1` for descending) getCitationNumberDirection() Get the sort direction of the citation-number variable

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

Field Detail

abbreviationProvider	back to summary
private final AbbreviationProvider abbreviationProvider

citationNumberDirection	back to summary
private int citationNumberDirection

comparator	back to summary
private final AlphanumComparator comparator

locale	back to summary
private final LLocale locale

style	back to summary
private final SStyle style

Constructor Detail

SortComparator	back to summary
public SortComparator(SStyle style, LLocale locale, AbbreviationProvider abbreviationProvider) Create a new sort comparator Parameters style:SStyle the current citation style locale:LLocale the current locale abbreviationProvider:AbbreviationProvider the current abbreviation provider

SortComparator

back to summary

public SortComparator(SStyle style, LLocale locale, AbbreviationProvider abbreviationProvider)

Create a new sort comparator

Parameters

style:SStyle: the current citation style
locale:LLocale: the current locale
abbreviationProvider:AbbreviationProvider: the current abbreviation provider

Method Detail

compare back to summary

compare	back to summary
public int compare(CSLItemData a, CSLItemData b) 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

public int compare(CSLItemData a, CSLItemData b)

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

getCitationNumberDirection back to summary

getCitationNumberDirection	back to summary
public int getCitationNumberDirection() Get the sort direction of the citation-number variable Returns:int the sort direction (`1` for ascending and `-1` for descending)

public int getCitationNumberDirection()

Get the sort direction of the citation-number variable

Returns:int: the sort direction (1 for ascending and -1 for descending)

public Class SSort

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class SSort.SortComparator

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail