HitProperty (BlackLab 2.0.0 API)

java.lang.Object
- nl.inl.blacklab.resultproperty.HitProperty

All Implemented Interfaces:

Serializable, Comparator<Hit>, ResultProperty<Hit>

Direct Known Subclasses:

HitPropertyContextBase, HitPropertyContextWords, HitPropertyDoc, HitPropertyDocumentDecade, HitPropertyDocumentId, HitPropertyDocumentStoredField, HitPropertyHitPosition, HitPropertyMultiple
```
public abstract class HitProperty
extends Object
implements ResultProperty<Hit>
```
Abstract base class for a property of a hit, like document title, hit text, right context, etc.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected Contexts`	`contexts` Hit contexts, if any
`protected Results<Hit>`	`hits` The Hits object we're looking at
`protected static org.apache.logging.log4j.Logger`	`logger`
`protected boolean`	`reverse` Reverse comparison result or not?

Constructor Summary

Constructors
Constructor and Description

HitProperty()

Constructors
Constructor and Description
`HitProperty()`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
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)` Produce a copy of this HitProperty object with a different Hits and Contexts object.
`abstract HitProperty`	`copyWith(Results<Hit> newHits, Contexts contexts, boolean invert)` Produce a copy of this HitProperty object with a different Hits and Contexts object.
`static HitProperty`	`deserialize(BlackLabIndex index, AnnotatedField field, String serialized)` Convert the String representation of a HitProperty back into the HitProperty
`static HitProperty`	`deserialize(Results<Hit> hits, String serialized)`
`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)`
`abstract PropertyValue`	`get(Hit hit)` Get the property value for a specific result.
`int`	`hashCode()`
`boolean`	`isReverse()` Is the comparison reversed?
`abstract String`	`name()` Get the name of the property
`List<Annotation>`	`needsContext()` Retrieve context from which field(s) prior to sorting/grouping on this property?
`ContextSize`	`needsContextSize(BlackLabIndex index)` If this property need context(s), how large should they be?
`HitProperty`	`reverse()` Reverse the sort order of this hit property.
`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 void`	`setContextIndices(List<Integer> contextIndices)` For HitProperties that need context, sets the context indices that correspond to the context(s) they need in the result set.
`protected HitProperty`	`setContexts(Contexts contexts)` Set contexts to use.
`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, 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
  - logger
```
protected static final org.apache.logging.log4j.Logger logger
```
  - hits
```
protected Results<Hit> hits
```
    The Hits object we're looking at
  - reverse
```
protected boolean reverse
```
    Reverse comparison result or not?
  - contexts
```
protected Contexts contexts
```
    Hit contexts, if any
- Constructor Detail
  - HitProperty
```
public HitProperty()
```
- Method Detail
  - deserialize
```
public static HitProperty deserialize(Results<Hit> hits,
                                      String serialized)
```
  - deserialize
```
public static HitProperty deserialize(BlackLabIndex index,
                                      AnnotatedField field,
                                      String serialized)
```
    Convert the String representation of a HitProperty back into the HitProperty
    
    Parameters:
    
    index - our index
    
    field - field we're searching
    
    serialized - the serialized object
    
    Returns:
    
    the HitProperty object, or null if it could not be deserialized
  - 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
  - setContexts
```
protected HitProperty setContexts(Contexts contexts)
```
    Set contexts to use. Only ever used by constructor, so doesn't break immutability.
    
    Parameters:
    
    contexts - contexts to use, or null for none
  - setContextIndices
```
protected void setContextIndices(List<Integer> contextIndices)
```
    For HitProperties that need context, sets the context indices that correspond to the context(s) they need in the result set. Only needed if the context indices differ from the assumed default of 0, 1, 2, ... Only called from the HitPropertyMultiple#copyWith(Hits, Contexts, boolean), so doesn't break immutability.
    
    Parameters:
    
    contextIndices - the indices, in the same order as reported by needsContext().
  - get
```
public abstract PropertyValue get(Hit hit)
```
    Description copied from interface: ResultProperty
    
    Get the property value for a specific result.
    
    Specified by:
    
    get in interface ResultProperty<Hit>
    
    Parameters:
    
    hit - 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>
    
    Parameters:
    
    a - first hit
    
    b - second hit
    
    Returns:
    
    0 if equal, negative if a < b, positive if a > b.
  - needsContext
```
public List<Annotation> needsContext()
```
    Retrieve context from which field(s) prior to sorting/grouping on this property?
    
    Returns:
    
    null if no context is required, the fieldnames otherwise
  - needsContextSize
```
public ContextSize needsContextSize(BlackLabIndex index)
```
    If this property need context(s), how large should they be?
    
    Parameters:
    
    index - index, so we can find the default context size if we need to
    
    Returns:
    
    required context size
  - name
```
public abstract String name()
```
    Description copied from interface: ResultProperty
    
    Get the name of the property
    
    Specified by:
    
    name in interface ResultProperty<Hit>
    
    Returns:
    
    name
  - 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<Hit>
    
    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<Hit>
    
    Returns:
    
    either a dash or the empty string
  - reverse
```
public HitProperty reverse()
```
    Description copied from interface: ResultProperty
    
    Reverse the sort order of this hit property.
    
    Specified by:
    
    reverse in interface ResultProperty<Hit>
    
    Returns:
    
    a new hit property with the sort order reversed
  - copyWith
```
public HitProperty copyWith(Results<Hit> newHits,
                            Contexts contexts)
```
    Produce a copy of this HitProperty object with a different Hits and Contexts object.
    
    Parameters:
    
    newHits - new Hits to use
    
    contexts - new Contexts to use, or null for none
    
    Returns:
    
    the new HitProperty object
  - copyWith
```
public abstract HitProperty copyWith(Results<Hit> newHits,
                                     Contexts contexts,
                                     boolean invert)
```
    Produce a copy of this HitProperty object with a different Hits and Contexts object.
    
    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
  - isReverse
```
public boolean isReverse()
```
    Description copied from interface: ResultProperty
    
    Is the comparison reversed?
    
    Specified by:
    
    isReverse in interface ResultProperty<Hit>
    
    Returns:
    
    true if it is, false if not
  - toString
```
public String toString()
```
    Specified by:
    
    toString in interface ResultProperty<Hit>
    
    Overrides:
    
    toString in class Object
  - hashCode
```
public int hashCode()
```
    Specified by:
    
    hashCode in interface ResultProperty<Hit>
    
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Specified by:
    
    equals in interface Comparator<Hit>
    
    Specified by:
    
    equals in interface ResultProperty<Hit>
    
    Overrides:
    
    equals in class Object
  - docPropsOnly
```
public DocProperty docPropsOnly()
```
    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.
    
    Returns:
    
    metadata portion of this property, or null if there is none
  - docPropValues
```
public PropertyValue docPropValues(PropertyValue value)
```
    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.
    
    Parameters:
    
    value - value to extract the values corresponding to DocProperty's from
    
    Returns:
    
    metadata portion of this value, or null if there is none

Class HitProperty

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface nl.inl.blacklab.resultproperty.ResultProperty

Methods inherited from interface java.util.Comparator

Field Detail

logger

hits

reverse

contexts

Constructor Detail

HitProperty

Method Detail

deserialize

deserialize

sortDescendingByDefault

setContexts

setContextIndices

get

compare

needsContext

needsContextSize

name

serialize

serializeReverse

reverse

copyWith

copyWith

isReverse

toString

hashCode

equals

docPropsOnly

docPropValues