nl.inl.blacklab.resultproperty

Class DocPropertyStoredField

java.lang.Object

nl.inl.blacklab.resultproperty.DocProperty

nl.inl.blacklab.resultproperty.DocPropertyStoredField

All Implemented Interfaces:

Serializable, Comparator<DocResult>, ResultProperty<DocResult>

public class DocPropertyStoredField
extends DocProperty

For grouping DocResult objects by the value of a stored field in the Lucene documents. The field name is given when instantiating this class, and might be "author", "year", and such.

See Also:

Serialized Form

Field Summary

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

logger, reverse

Constructor Summary

Constructors

Constructor and Description
DocPropertyStoredField(BlackLabIndex index, String fieldName)
DocPropertyStoredField(BlackLabIndex index, String fieldName, String friendlyName)
DocPropertyStoredField(DocPropertyStoredField prop, boolean invert)

Method Summary

Modifier and Type	Method and Description
boolean	canConstructQuery(BlackLabIndex index, PropertyValue value) Can we create a query matching the specified value for our property?
int	compare(DocResult a, DocResult b) Compares two docs on this property
int	compare(int docId1, int docId2) Compares two docs on this property
static DocPropertyStoredField	deserialize(BlackLabIndex index, String info)
boolean	equals(Object obj)
PropertyValueString	get(DocResult result) Get the desired grouping/sorting property from the DocResult object
String	get(int docId)
String	get(PropertyValueDoc doc)
int	hashCode()
String	name() Get the name of the property
org.apache.lucene.search.Query	query(BlackLabIndex index, PropertyValue value) Generate a query matching the specified value for our property.
DocProperty	reverse() Reverse the comparison.
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.DocProperty

getFacetsUrlParam, isReverse, serializeReverse, 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

DocPropertyStoredField

public DocPropertyStoredField(DocPropertyStoredField prop,
                              boolean invert)

DocPropertyStoredField

public DocPropertyStoredField(BlackLabIndex index,
                              String fieldName)

DocPropertyStoredField

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

Method Detail

get

public String get(int docId)

get

public String get(PropertyValueDoc doc)

get

public PropertyValueString get(DocResult result)

Description copied from class: DocProperty

Get the desired grouping/sorting property from the DocResult object

Specified by:

get in interface ResultProperty<DocResult>

Specified by:

get in class DocProperty

Parameters:

result - the result to get the grouping property for

Returns:

the grouping property. e.g. this might be "Harry Mulisch" when grouping on author.

compare

public int compare(int docId1,
                   int docId2)

Compares two docs on this property

Parameters:

docId1 - first doc

docId2 - second doc

Returns:

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

compare

public int compare(DocResult a,
                   DocResult b)

Compares two docs on this property

Specified by:

compare in interface Comparator<DocResult>

Specified by:

compare in interface ResultProperty<DocResult>

Overrides:

compare in class DocProperty

Parameters:

a - first doc

b - second doc

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

Specified by:

name in class DocProperty

Returns:

name

deserialize

public static DocPropertyStoredField deserialize(BlackLabIndex index,
                                                 String info)

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

Specified by:

serialize in class DocProperty

Returns:

the String representation of this HitProperty

reverse

public DocProperty reverse()

Description copied from class: DocProperty

Reverse the comparison.

Specified by:

reverse in interface ResultProperty<DocResult>

Specified by:

reverse in class DocProperty

Returns:

document property with the comparison reversed

hashCode

public int hashCode()

Specified by:

hashCode in interface ResultProperty<DocResult>

Overrides:

hashCode in class DocProperty

equals

public boolean equals(Object obj)

Specified by:

equals in interface Comparator<DocResult>

Specified by:

equals in interface ResultProperty<DocResult>

Overrides:

equals in class DocProperty

query

public org.apache.lucene.search.Query query(BlackLabIndex index,
                                            PropertyValue value)

Description copied from class: DocProperty

Generate a query matching the specified value for our property.

Specified by:

query in class DocProperty

Parameters:

index - our index (for finding field properties such as tokenized or not, analyzer, unknown value)

value - value to match

Returns:

query

canConstructQuery

public boolean canConstructQuery(BlackLabIndex index,
                                 PropertyValue value)

Description copied from class: DocProperty

Can we create a query matching the specified value for our property?

Overrides:

canConstructQuery in class DocProperty

Parameters:

index - our index (for finding field properties such as tokenized or not, analyzer, unknown value)

value - value to match

Returns:

true if we can, false if we can't