nl.inl.blacklab.resultproperty

Class HitPropertyContextWords

java.lang.Object

nl.inl.blacklab.resultproperty.HitProperty

nl.inl.blacklab.resultproperty.HitPropertyContextWords

All Implemented Interfaces:

Serializable, Comparator<Hit>, ResultProperty<Hit>

public class HitPropertyContextWords
extends HitProperty

A hit property for grouping on the context of the hit. Requires HitConcordances as input (so we have the hit text available).

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HitPropertyContextWords.ContextPart A stretch of words from the (surroundings of) the matched text.
static class	HitPropertyContextWords.ContextStart A location in the hit context to start a stretch of words from.

Field Summary

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

contexts, hits, logger, reverse

Constructor Summary

Constructors

Constructor and Description
HitPropertyContextWords(BlackLabIndex index, Annotation annotation, MatchSensitivity sensitivity, List<HitPropertyContextWords.ContextPart> words)
HitPropertyContextWords(BlackLabIndex index, Annotation annotation, MatchSensitivity sensitivity, String wordSpec)

Method Summary

Modifier and Type	Method and Description
HitProperty	copyWith(Results<Hit> newHits, Contexts contexts, boolean invert) Produce a copy of this HitProperty object with a different Hits and Contexts object.
boolean	equals(Object obj)
PropertyValueContextWords	get(Hit hit) Get the property value for a specific result.
int	hashCode()
String	name() Get the name of the property
List<Annotation>	needsContext() Retrieve context from which field(s) prior to sorting/grouping on this 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

compare, copyWith, deserialize, deserialize, docPropsOnly, docPropValues, isReverse, 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

HitPropertyContextWords

public HitPropertyContextWords(BlackLabIndex index,
                               Annotation annotation,
                               MatchSensitivity sensitivity,
                               String wordSpec)

HitPropertyContextWords

public HitPropertyContextWords(BlackLabIndex index,
                               Annotation annotation,
                               MatchSensitivity sensitivity,
                               List<HitPropertyContextWords.ContextPart> words)

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 PropertyValueContextWords get(Hit hit)

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:

hit - result to get property value for

Returns:

property value

needsContext

public List<Annotation> needsContext()

Description copied from class: HitProperty

Retrieve context from which field(s) prior to sorting/grouping on this property?

Overrides:

needsContext in class HitProperty

Returns:

null if no context is required, the fieldnames otherwise

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

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

hashCode

public int hashCode()

Specified by:

hashCode in interface ResultProperty<Hit>

Overrides:

hashCode in class HitProperty

equals

public boolean equals(Object obj)

Specified by:

equals in interface Comparator<Hit>

Specified by:

equals in interface ResultProperty<Hit>

Overrides:

equals in class HitProperty