nl.inl.blacklab.resultproperty

Interface ResultProperty<T>

Type Parameters:

T - type of result

All Superinterfaces:

Comparator<T>, Serializable

All Known Implementing Classes:

DocGroupProperty, DocGroupPropertyIdentity, DocGroupPropertySize, DocProperty, DocPropertyAnnotatedFieldLength, DocPropertyDecade, DocPropertyId, DocPropertyMultiple, DocPropertyNumberOfHits, DocPropertyStoredField, GroupProperty, HitGroupProperty, HitGroupPropertyIdentity, HitGroupPropertySize, HitProperty, HitPropertyContextBase, HitPropertyContextWords, HitPropertyDoc, HitPropertyDocumentDecade, HitPropertyDocumentId, HitPropertyDocumentStoredField, HitPropertyHitPosition, HitPropertyHitText, HitPropertyLeftContext, HitPropertyMultiple, HitPropertyRightContext, HitPropertyWordLeft, HitPropertyWordRight

public interface ResultProperty<T>
extends Comparator<T>, Serializable

Property of some result (i.e. hit, group, groupOfGroups)

Method Summary

Modifier and Type	Method and Description
int	compare(T a, T b) Compares two hits on this property.
boolean	equals(Object obj)
PropertyValue	get(T hit) Get the property value for a specific result.
int	hashCode()
static String	ignoreSensitivity(String info) Strip sensitivity information.
default boolean	isCompound()
boolean	isReverse() Is the comparison reversed?
String	name() Get the name of the property
default List<String>	propNames() Get the names of all (sub-)properties separately.
default List<? extends ResultProperty<T>>	props()
ResultProperty<T>	reverse() Reverse the sort order of this hit property.
String	serialize() Serialize this HitProperty so we can deserialize it later (to pass it via URL, for example)
String	serializeReverse()
String	toString()

Methods inherited from interface java.util.Comparator

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

Method Detail

ignoreSensitivity

static String ignoreSensitivity(String info)

Strip sensitivity information. When deserializing, we ignore sensitivity option for non-context properties. Eventually, we will implement this for these properties.

Parameters:

info - input string

Returns:

stripped string

get

PropertyValue get(T hit)

Get the property value for a specific result.

Parameters:

hit - result to get property value for

Returns:

property value

compare

int compare(T a,
            T b)

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<T>

Parameters:

a - first hit

b - second hit

Returns:

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

name

String name()

Get the name of the property

Returns:

name

serialize

String serialize()

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

Returns:

the String representation of this HitProperty

reverse

ResultProperty<T> reverse()

Reverse the sort order of this hit property.

Returns:

a new hit property with the sort order reversed

isReverse

boolean isReverse()

Is the comparison reversed?

Returns:

true if it is, false if not

toString

String toString()

Overrides:

toString in class Object

propNames

default List<String> propNames()

Get the names of all (sub-)properties separately.

Returns:

the list

hashCode

int hashCode()

Overrides:

hashCode in class Object

equals

boolean equals(Object obj)

Specified by:

equals in interface Comparator<T>

Overrides:

equals in class Object

isCompound

default boolean isCompound()

props

default List<? extends ResultProperty<T>> props()

serializeReverse

String serializeReverse()