Package org.apache.solr.handler.component

Class QueryElevationComponent.Elevation

java.lang.Object

org.apache.solr.handler.component.QueryElevationComponent.Elevation

Enclosing class:

QueryElevationComponent

protected static class QueryElevationComponent.Elevation
extends Object

Elevation of some documents in search results, with potential exclusion of others. Immutable.

Field Summary

Fields

Modifier and Type	Field	Description
Set<org.apache.lucene.util.BytesRef>	elevatedIds
Set<org.apache.lucene.util.BytesRef>	excludedIds
org.apache.lucene.search.TermQuery[]	excludeQueries
org.apache.lucene.search.BooleanQuery	includeQuery

Constructor Summary

Constructors

Modifier	Constructor	Description
	Elevation(Set<org.apache.lucene.util.BytesRef> elevatedIds, Set<org.apache.lucene.util.BytesRef> excludedIds, String queryFieldName)	Constructs an elevation.
protected	Elevation(Set<org.apache.lucene.util.BytesRef> elevatedIds, org.apache.lucene.search.BooleanQuery includeQuery, Set<org.apache.lucene.util.BytesRef> excludedIds, org.apache.lucene.search.TermQuery[] excludeQueries)

Method Summary

Modifier and Type	Method	Description
protected QueryElevationComponent.Elevation	mergeWith(QueryElevationComponent.Elevation elevation)	Merges this QueryElevationComponent.Elevation with another and creates a new QueryElevationComponent.Elevation.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

elevatedIds

public final Set<org.apache.lucene.util.BytesRef> elevatedIds

includeQuery

public final org.apache.lucene.search.BooleanQuery includeQuery

excludedIds

public final Set<org.apache.lucene.util.BytesRef> excludedIds

excludeQueries

public final org.apache.lucene.search.TermQuery[] excludeQueries

Constructor Detail

Elevation

public Elevation(Set<org.apache.lucene.util.BytesRef> elevatedIds,
                 Set<org.apache.lucene.util.BytesRef> excludedIds,
                 String queryFieldName)

Constructs an elevation.

Parameters:

elevatedIds - The ids of the elevated documents that should appear on top of search results, in configured order; can be null.

excludedIds - The ids of the excluded documents that should not appear in search results; can be null.

queryFieldName - The field name to use to create query terms.

Elevation

protected Elevation(Set<org.apache.lucene.util.BytesRef> elevatedIds,
                    org.apache.lucene.search.BooleanQuery includeQuery,
                    Set<org.apache.lucene.util.BytesRef> excludedIds,
                    org.apache.lucene.search.TermQuery[] excludeQueries)

Method Detail

mergeWith

protected QueryElevationComponent.Elevation mergeWith(QueryElevationComponent.Elevation elevation)

Merges this QueryElevationComponent.Elevation with another and creates a new QueryElevationComponent.Elevation.

Returns:

A new instance containing the merging of the two elevations; or directly this elevation if the other is null.

toString

public String toString()

Overrides:

toString in class Object