nl.inl.blacklab.resultproperty

Class DocPropertyMultiple

java.lang.Object

nl.inl.blacklab.resultproperty.DocProperty

nl.inl.blacklab.resultproperty.DocPropertyMultiple

All Implemented Interfaces:

Serializable, Iterable<DocProperty>, Comparator<DocResult>, ResultProperty<DocResult>

public class DocPropertyMultiple
extends DocProperty
implements Iterable<DocProperty>

A collection of GroupProperty's identifying a particular group.

See Also:

Serialized Form

Field Summary

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

logger, reverse

Constructor Summary

Constructors

Constructor and Description
DocPropertyMultiple(DocProperty... criteria) Quick way to create group criteria.
DocPropertyMultiple(List<DocProperty> criteria) Quick way to create group criteria.

Method Summary

Modifier and Type	Method and Description
void	addCriterium(DocProperty crit)
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 DocPropertyMultiple	deserialize(BlackLabIndex index, String info)
boolean	equals(Object obj)
PropertyValueMultiple	get(DocResult result) Get the desired grouping/sorting property from the DocResult object
int	hashCode()
boolean	isCompound()
Iterator<DocProperty>	iterator()
String	name() Get the name of the property
List<DocProperty>	props()
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)
String	toString()

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

getFacetsUrlParam, isReverse, serializeReverse, sortDescendingByDefault

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

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

ignoreSensitivity, propNames

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

DocPropertyMultiple

public DocPropertyMultiple(List<DocProperty> criteria)

Quick way to create group criteria. Just call this method with the GroupCriterium object(s) you want.

Parameters:

criteria - the desired criteria

DocPropertyMultiple

public DocPropertyMultiple(DocProperty... criteria)

Quick way to create group criteria. Just call this method with the GroupCriterium object(s) you want.

Parameters:

criteria - the desired criteria

Method Detail

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

addCriterium

public void addCriterium(DocProperty crit)

toString

public String toString()

Specified by:

toString in interface ResultProperty<DocResult>

Overrides:

toString in class DocProperty

iterator

public Iterator<DocProperty> iterator()

Specified by:

iterator in interface Iterable<DocProperty>

get

public PropertyValueMultiple 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

isCompound

public boolean isCompound()

Specified by:

isCompound in interface ResultProperty<DocResult>

props

public List<DocProperty> props()

Specified by:

props in interface ResultProperty<DocResult>

deserialize

public static DocPropertyMultiple deserialize(BlackLabIndex index,
                                              String info)

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

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