nl.inl.blacklab.resultproperty

Class DocProperty

java.lang.Object

nl.inl.blacklab.resultproperty.DocProperty

All Implemented Interfaces:

Serializable, Comparator<DocResult>, ResultProperty<DocResult>

Direct Known Subclasses:

DocPropertyAnnotatedFieldLength, DocPropertyDecade, DocPropertyId, DocPropertyMultiple, DocPropertyNumberOfHits, DocPropertyStoredField

public abstract class DocProperty
extends Object
implements ResultProperty<DocResult>

Abstract base class for criteria on which to group DocResult objects. Subclasses implement specific grouping criteria (number of hits, the value of a stored field in the Lucene document, ...)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.apache.logging.log4j.Logger	logger
protected boolean	reverse Reverse comparison result or not?

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DocProperty()
protected	DocProperty(DocProperty 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
static DocProperty	deserialize(BlackLabIndex index, String serialized)
boolean	equals(Object obj)
abstract PropertyValue	get(DocResult result) Get the desired grouping/sorting property from the DocResult object
static void	getFacetsUrlParam(Map<String,String> param, List<DocProperty> facets)
int	hashCode()
boolean	isReverse() Is the comparison reversed?
abstract String	name() Get the name of the property
abstract org.apache.lucene.search.Query	query(BlackLabIndex index, PropertyValue value) Generate a query matching the specified value for our property.
abstract DocProperty	reverse() Reverse the comparison.
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 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

reverse

protected boolean reverse

Reverse comparison result or not?

Constructor Detail

DocProperty

protected DocProperty(DocProperty prop,
                      boolean invert)

DocProperty

protected DocProperty()

Method Detail

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

get

public abstract PropertyValue get(DocResult result)

Get the desired grouping/sorting property from the DocResult object

Specified by:

get in interface ResultProperty<DocResult>

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>

Parameters:

a - first doc

b - second doc

Returns:

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

name

public abstract String name()

Description copied from interface: ResultProperty

Get the name of the property

Specified by:

name in interface ResultProperty<DocResult>

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

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

Returns:

either a dash or the empty string

deserialize

public static DocProperty deserialize(BlackLabIndex index,
                                      String serialized)

isReverse

public boolean isReverse()

Is the comparison reversed?

Specified by:

isReverse in interface ResultProperty<DocResult>

Returns:

true if it is, false if not

reverse

public abstract DocProperty reverse()

Reverse the comparison.

Specified by:

reverse in interface ResultProperty<DocResult>

Returns:

document property with the comparison reversed

toString

public String toString()

Specified by:

toString in interface ResultProperty<DocResult>

Overrides:

toString in class Object

getFacetsUrlParam

public static void getFacetsUrlParam(Map<String,String> param,
                                     List<DocProperty> facets)

hashCode

public int hashCode()

Specified by:

hashCode in interface ResultProperty<DocResult>

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Specified by:

equals in interface Comparator<DocResult>

Specified by:

equals in interface ResultProperty<DocResult>

Overrides:

equals in class Object

query

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

Generate a query matching the specified value for our property.

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)

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

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