nl.inl.blacklab.resultproperty

Class DocPropertyNumberOfHits

java.lang.Object

nl.inl.blacklab.resultproperty.DocProperty

nl.inl.blacklab.resultproperty.DocPropertyNumberOfHits

All Implemented Interfaces:

Serializable, Comparator<DocResult>, ResultProperty<DocResult>

public class DocPropertyNumberOfHits
extends DocProperty

For grouping DocResult objects on the number of hits. This would put documents with 1 hit in a group, documents with 2 hits in another group, etc.

See Also:

Serialized Form

Field Summary

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

logger, reverse

Constructor Summary

Constructors

Constructor and Description
DocPropertyNumberOfHits()

Method Summary

Modifier and Type	Method and Description
int	compare(DocResult a, DocResult b) Compares two docs on this property
static DocPropertyNumberOfHits	deserialize()
PropertyValueInt	get(DocResult result) Get the desired grouping/sorting property from the DocResult object
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)
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".

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

canConstructQuery, deserialize, equals, getFacetsUrlParam, hashCode, isReverse, serializeReverse, 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

DocPropertyNumberOfHits

public DocPropertyNumberOfHits()

Method Detail

deserialize

public static DocPropertyNumberOfHits deserialize()

sortDescendingByDefault

protected boolean sortDescendingByDefault()

Description copied from class: DocProperty

Is the default for this property to sort descending? This is usually a good default for "group size" or "number of hits".

Overrides:

sortDescendingByDefault in class DocProperty

Returns:

whether to sort descending by default

get

public PropertyValueInt 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(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

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

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