nl.inl.blacklab.resultproperty

Class DocGroupPropertySize

java.lang.Object

nl.inl.blacklab.resultproperty.GroupProperty<DocResult,DocGroup>

nl.inl.blacklab.resultproperty.DocGroupProperty

nl.inl.blacklab.resultproperty.DocGroupPropertySize

All Implemented Interfaces:

Serializable, Comparator<DocGroup>, ResultProperty<DocGroup>

public class DocGroupPropertySize
extends DocGroupProperty

See Also:

Serialized Form

Field Summary

Fields inherited from class nl.inl.blacklab.resultproperty.GroupProperty

reverse

Constructor Summary

Constructors

Constructor and Description
DocGroupPropertySize()

Method Summary

Modifier and Type	Method and Description
int	compare(DocGroup a, DocGroup b) Compares two groups on this property
PropertyValueInt	get(DocGroup result) Get the property value for a specific result.
String	name() Get the name of the property
DocGroupPropertySize	reverse() Reverse the comparison.
String	serialize() Serialize this HitProperty so we can deserialize it later (to pass it via URL, for example)
protected boolean	sortDescendingByDefault() Is the default for this property to sort descending? This is usually a good default for "group size" or "number of hits".

Methods inherited from class nl.inl.blacklab.resultproperty.DocGroupProperty

deserialize, identity, isReverse, serializeReverse, size, toString

Methods inherited from class nl.inl.blacklab.resultproperty.GroupProperty

equals, hashCode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface nl.inl.blacklab.resultproperty.ResultProperty

ignoreSensitivity, isCompound, propNames, props

Methods inherited from interface java.util.Comparator

comparing, comparing, comparingDouble, comparingInt, comparingLong, naturalOrder, nullsFirst, nullsLast, reversed, reverseOrder, thenComparing, thenComparing, thenComparing, thenComparingDouble, thenComparingInt, thenComparingLong

Constructor Detail

DocGroupPropertySize

public DocGroupPropertySize()

Method Detail

sortDescendingByDefault

protected boolean sortDescendingByDefault()

Description copied from class: GroupProperty

Is the default for this property to sort descending? This is usually a good default for "group size" or "number of hits".

Overrides:

sortDescendingByDefault in class GroupProperty<DocResult,DocGroup>

Returns:

whether to sort descending by default

get

public PropertyValueInt get(DocGroup result)

Description copied from interface: ResultProperty

Get the property value for a specific result.

Specified by:

get in interface ResultProperty<DocGroup>

Specified by:

get in class DocGroupProperty

Parameters:

result - result to get property value for

Returns:

property value

compare

public int compare(DocGroup a,
                   DocGroup b)

Description copied from class: DocGroupProperty

Compares two groups on this property

Specified by:

compare in interface Comparator<DocGroup>

Specified by:

compare in interface ResultProperty<DocGroup>

Specified by:

compare in class DocGroupProperty

Parameters:

a - first group

b - second group

Returns:

0 if equal, negative if a < b, positive if a > b.

serialize

public String serialize()

Description copied from interface: ResultProperty

Serialize this HitProperty so we can deserialize it later (to pass it via URL, for example)

Specified by:

serialize in interface ResultProperty<DocGroup>

Specified by:

serialize in class DocGroupProperty

Returns:

the String representation of this HitProperty

reverse

public DocGroupPropertySize reverse()

Description copied from class: DocGroupProperty

Reverse the comparison.

Specified by:

reverse in interface ResultProperty<DocGroup>

Specified by:

reverse in class DocGroupProperty

Returns:

doc group property with reversed comparison

name

public String name()

Description copied from interface: ResultProperty

Get the name of the property

Returns:

name