nl.inl.blacklab.resultproperty

Class HitPropertyHitPosition

java.lang.Object

nl.inl.blacklab.resultproperty.HitProperty

nl.inl.blacklab.resultproperty.HitPropertyHitPosition

All Implemented Interfaces:

Serializable, Comparator<Hit>, ResultProperty<Hit>

public class HitPropertyHitPosition
extends HitProperty

A hit property for sorting on hit token position. Usually to be combined with sorting on document id, for a fast and reproducible sort.

See Also:

Serialized Form

Field Summary

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

contexts, hits, logger, reverse

Constructor Summary

Constructors

Constructor and Description
HitPropertyHitPosition()

Method Summary

Modifier and Type	Method and Description
int	compare(Hit a, Hit b) Compares two hits on this property.
HitProperty	copyWith(Results<Hit> newHits, Contexts contexts, boolean invert) Produce a copy of this HitProperty object with a different Hits and Contexts object.
PropertyValueInt	get(Hit result) Get the property value for a specific result.
String	name() Get the name of the property
String	serialize() Serialize this HitProperty so we can deserialize it later (to pass it via URL, for example)

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

copyWith, deserialize, deserialize, docPropsOnly, docPropValues, equals, hashCode, isReverse, needsContext, needsContextSize, reverse, serializeReverse, setContextIndices, setContexts, sortDescendingByDefault, 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, 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

HitPropertyHitPosition

public HitPropertyHitPosition()

Method Detail

copyWith

public HitProperty copyWith(Results<Hit> newHits,
                            Contexts contexts,
                            boolean invert)

Description copied from class: HitProperty

Produce a copy of this HitProperty object with a different Hits and Contexts object.

Specified by:

copyWith in class HitProperty

Parameters:

newHits - new Hits to use, or null to inherit

contexts - new Contexts to use, or null to inherit

invert - true if we should invert the previous sort order; false to keep it the same

Returns:

the new HitProperty object

get

public PropertyValueInt get(Hit result)

Description copied from interface: ResultProperty

Get the property value for a specific result.

Specified by:

get in interface ResultProperty<Hit>

Specified by:

get in class HitProperty

Parameters:

result - result to get property value for

Returns:

property value

name

public String name()

Description copied from interface: ResultProperty

Get the name of the property

Specified by:

name in interface ResultProperty<Hit>

Specified by:

name in class HitProperty

Returns:

name

compare

public int compare(Hit a,
                   Hit 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<Hit>

Specified by:

compare in interface ResultProperty<Hit>

Overrides:

compare in class HitProperty

Parameters:

a - first hit

b - second hit

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

Specified by:

serialize in class HitProperty

Returns:

the String representation of this HitProperty