nl.inl.blacklab.resultproperty

Class HitGroupProperty

java.lang.Object

nl.inl.blacklab.resultproperty.GroupProperty<Hit,HitGroup>

nl.inl.blacklab.resultproperty.HitGroupProperty

All Implemented Interfaces:

Serializable, Comparator<HitGroup>, ResultProperty<HitGroup>

Direct Known Subclasses:

HitGroupPropertyIdentity, HitGroupPropertySize

public abstract class HitGroupProperty
extends GroupProperty<Hit,HitGroup>

Abstract base class for a property of a hit, like document title, hit text, right context, etc.

See Also:

Serialized Form

Field Summary

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

reverse

Constructor Summary

Constructors

Constructor and Description
HitGroupProperty()

Method Summary

Modifier and Type	Method and Description
abstract int	compare(HitGroup a, HitGroup b) Compares two groups on this property
static HitGroupProperty	deserialize(String serialized)
abstract PropertyValue	get(HitGroup result) Get the property value for a specific result.
static HitGroupPropertyIdentity	identity()
boolean	isReverse() Is the comparison reversed?
abstract HitGroupProperty	reverse() Reverse the comparison.
abstract String	serialize() Serialize this HitProperty so we can deserialize it later (to pass it via URL, for example)
String	serializeReverse() Used by subclasses to add a dash for reverse when serializing
static HitGroupPropertySize	size()
String	toString()

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

equals, hashCode, sortDescendingByDefault

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, name, 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

HitGroupProperty

public HitGroupProperty()

Method Detail

identity

public static HitGroupPropertyIdentity identity()

size

public static HitGroupPropertySize size()

get

public abstract PropertyValue get(HitGroup result)

Description copied from interface: ResultProperty

Get the property value for a specific result.

Specified by:

get in interface ResultProperty<HitGroup>

Specified by:

get in class GroupProperty<Hit,HitGroup>

Parameters:

result - result to get property value for

Returns:

property value

compare

public abstract int compare(HitGroup a,
                            HitGroup b)

Compares two groups on this property

Specified by:

compare in interface Comparator<HitGroup>

Specified by:

compare in interface ResultProperty<HitGroup>

Specified by:

compare in class GroupProperty<Hit,HitGroup>

Parameters:

a - first group

b - second group

Returns:

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

serialize

public abstract 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<HitGroup>

Specified by:

serialize in class GroupProperty<Hit,HitGroup>

Returns:

the String representation of this HitProperty

serializeReverse

public String serializeReverse()

Used by subclasses to add a dash for reverse when serializing

Specified by:

serializeReverse in interface ResultProperty<HitGroup>

Overrides:

serializeReverse in class GroupProperty<Hit,HitGroup>

Returns:

either a dash or the empty string

deserialize

public static HitGroupProperty deserialize(String serialized)

isReverse

public boolean isReverse()

Is the comparison reversed?

Specified by:

isReverse in interface ResultProperty<HitGroup>

Overrides:

isReverse in class GroupProperty<Hit,HitGroup>

Returns:

true if it is, false if not

reverse

public abstract HitGroupProperty reverse()

Reverse the comparison.

Specified by:

reverse in interface ResultProperty<HitGroup>

Specified by:

reverse in class GroupProperty<Hit,HitGroup>

Returns:

doc group property with reversed comparison

toString

public String toString()

Specified by:

toString in interface ResultProperty<HitGroup>

Overrides:

toString in class GroupProperty<Hit,HitGroup>