nl.inl.blacklab.resultproperty

Class GroupProperty<T,G extends Group<T>>

java.lang.Object

nl.inl.blacklab.resultproperty.GroupProperty<T,G>

Type Parameters:

T - type of result, e.g. Hit

G - group type, e.g. HitGroup

All Implemented Interfaces:

Serializable, Comparator<G>, ResultProperty<G>

Direct Known Subclasses:

DocGroupProperty, HitGroupProperty

public abstract class GroupProperty<T,G extends Group<T>>
extends Object
implements ResultProperty<G>

Abstract base class for a property of a group op results.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	reverse Reverse comparison result or not?

Constructor Summary

Constructors

Constructor and Description
GroupProperty()

Method Summary

Modifier and Type	Method and Description
abstract int	compare(G a, G b) Compares two hits on this property.
boolean	equals(Object obj)
abstract PropertyValue	get(G result) Get the property value for a specific result.
int	hashCode()
boolean	isReverse() Is the comparison reversed?
abstract GroupProperty<T,G>	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
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".
String	toString()

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

Field Detail

reverse

protected boolean reverse

Reverse comparison result or not?

Constructor Detail

GroupProperty

public GroupProperty()

Method Detail

sortDescendingByDefault

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".

Returns:

whether to sort descending by default

get

public abstract PropertyValue get(G result)

Description copied from interface: ResultProperty

Get the property value for a specific result.

Specified by:

get in interface ResultProperty<G extends Group<T>>

Parameters:

result - result to get property value for

Returns:

property value

compare

public abstract int compare(G a,
                            G b)

Description copied from interface: ResultProperty

Compares two hits on this property. The default implementation uses get() to compare the two hits. Subclasses may override this method to provide a more efficient implementation. Note that we use Object as the type instead of Hit to save on run-time type checking. We know (slash hope :-) that this method is only ever called to compare Hits.

Specified by:

compare in interface Comparator<G extends Group<T>>

Specified by:

compare in interface ResultProperty<G extends Group<T>>

Parameters:

a - first hit

b - second hit

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<G extends Group<T>>

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<G extends Group<T>>

Returns:

either a dash or the empty string

isReverse

public boolean isReverse()

Is the comparison reversed?

Specified by:

isReverse in interface ResultProperty<G extends Group<T>>

Returns:

true if it is, false if not

reverse

public abstract GroupProperty<T,G> reverse()

Reverse the comparison.

Specified by:

reverse in interface ResultProperty<G extends Group<T>>

Returns:

reversed group property

toString

public String toString()

Specified by:

toString in interface ResultProperty<G extends Group<T>>

Overrides:

toString in class Object

hashCode

public int hashCode()

Specified by:

hashCode in interface ResultProperty<G extends Group<T>>

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Specified by:

equals in interface Comparator<G extends Group<T>>

Specified by:

equals in interface ResultProperty<G extends Group<T>>

Overrides:

equals in class Object