nl.inl.blacklab.resultproperty

Class HitPropertyDocumentStoredField

java.lang.Object

nl.inl.blacklab.resultproperty.HitProperty

nl.inl.blacklab.resultproperty.HitPropertyDocumentStoredField

All Implemented Interfaces:

Serializable, Comparator<Hit>, ResultProperty<Hit>

public class HitPropertyDocumentStoredField
extends HitProperty

A hit property for grouping on a stored field in the corresponding Lucene document.

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
HitPropertyDocumentStoredField(BlackLabIndex index, String fieldName)
HitPropertyDocumentStoredField(BlackLabIndex index, String fieldName, String friendlyName)

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.
DocProperty	docPropsOnly() Return only the DocProperty portion (if any) of this HitProperty, if any.
PropertyValue	docPropValues(PropertyValue value) Return only the values corresponding to DocProperty's of the given PropertyValue, if any.
boolean	equals(Object obj)
PropertyValueString	get(Hit result) Get the property value for a specific result.
int	hashCode()
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, 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

HitPropertyDocumentStoredField

public HitPropertyDocumentStoredField(BlackLabIndex index,
                                      String fieldName,
                                      String friendlyName)

HitPropertyDocumentStoredField

public HitPropertyDocumentStoredField(BlackLabIndex index,
                                      String fieldName)

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

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.

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

docPropsOnly

public DocProperty docPropsOnly()

Description copied from class: HitProperty

Return only the DocProperty portion (if any) of this HitProperty, if any. E.g. if this is a HitPropertyMultiple of HitPropertyContextWords and HitPropertyDocumentStoredField, return the latter as a DocPropertyStoredField. This is used for calculting the relative frequency when grouping on a metadata field.

Overrides:

docPropsOnly in class HitProperty

Returns:

metadata portion of this property, or null if there is none

docPropValues

public PropertyValue docPropValues(PropertyValue value)

Description copied from class: HitProperty

Return only the values corresponding to DocProperty's of the given PropertyValue, if any. E.g. if this is a HitPropertyMultiple of HitPropertyContextWords and HitPropertyDocumentStoredField, return the latter of the two values in the supplied PropertyValue. This is used for calculating the relative frequency when grouping on a metadata field.

Overrides:

docPropValues in class HitProperty

Parameters:

value - value to extract the values corresponding to DocProperty's from

Returns:

metadata portion of this value, or null if there is none