org.eclipse.smila.solr.util
Class FacetQueryConfigAdapter

java.lang.Object
  org.eclipse.smila.solr.util.FacetQueryConfigAdapter

public class FacetQueryConfigAdapter
extends java.lang.Object

The FacetQueryConfigAdapter is a helper class to configure a groupby object in SMILA record. While creating an instance of this class you have to select a facet type: Facet.SOLR is mandatory once to enable faceting. You can additionally set global parameter to this object. For every facet you want to get use the other Facet enum types. You are able to set parameter to this objects too (on a per field basis). The Facet.QUERY type also needs String array with the query. What types and parameter mean is described here: http://wiki.apache.org/solr/SimpleFacetParameters.

Author:

pwissel

Nested Class Summary

static class	FacetQueryConfigAdapter.FacetDateOther Facet date other enum.
static class	FacetQueryConfigAdapter.FacetMethod Facet method enum.
static class	FacetQueryConfigAdapter.FacetSort Facet sort enum.
static class	FacetQueryConfigAdapter.FacetType Facet type enum.

Constructor Summary

FacetQueryConfigAdapter(FacetQueryConfigAdapter.FacetType facet, java.lang.String... query)
Constructor,

Method Summary

AnyMap	getAnyMap() Get the underlying any map.
FacetQueryConfigAdapter	setFacetDateEnd(java.lang.String value) Set facet.date.end parameter.
FacetQueryConfigAdapter	setFacetDateGap(java.lang.String value) Set facet.date.gap parameter.
FacetQueryConfigAdapter	setFacetDateHardend(java.lang.Boolean value) Set facet.date.hardend parameter.
FacetQueryConfigAdapter	setFacetDateOther(FacetQueryConfigAdapter.FacetDateOther dateOther) Set facet.date.other parameter.
FacetQueryConfigAdapter	setFacetDateStart(java.lang.String value) Set facet.date.start parameter.
FacetQueryConfigAdapter	setFacetEnumCacheMinDf(int value) Set facet.enum.cache.minDf parameter.
FacetQueryConfigAdapter	setFacetLimit(int value) Set facet.limit parameter.
FacetQueryConfigAdapter	setFacetMethod(FacetQueryConfigAdapter.FacetMethod method) Set facet.method parameter.
FacetQueryConfigAdapter	setFacetMinCount(int value) Set facet.mincount parameter.
FacetQueryConfigAdapter	setFacetMissing(java.lang.Boolean value) Set facet.missing parameter.
FacetQueryConfigAdapter	setFacetOffset(int value) Set facet.offset parameter.
FacetQueryConfigAdapter	setFacetPrefix(java.lang.String value) Set facet.prefix parameter.
FacetQueryConfigAdapter	setFacetSort(FacetQueryConfigAdapter.FacetSort sort) Set facet.sort parameter.

Methods inherited from class java.lang.Object

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

Constructor Detail

FacetQueryConfigAdapter

public FacetQueryConfigAdapter(FacetQueryConfigAdapter.FacetType facet,
                               java.lang.String... query)

Constructor,

Parameters:

facet - the facet type.

query - only used for type = FacetQueryConfigAdapter.FacetType.QUERY is then the equivalent of a facet.query

Method Detail

getAnyMap

public AnyMap getAnyMap()

Get the underlying any map.

Returns:

the map.

setFacetPrefix

public FacetQueryConfigAdapter setFacetPrefix(java.lang.String value)

Set facet.prefix parameter.

Parameters:

value - the value.

Returns:

FacetQueryConfigAdapter.

setFacetSort

public FacetQueryConfigAdapter setFacetSort(FacetQueryConfigAdapter.FacetSort sort)

Set facet.sort parameter.

Parameters:

sort - the value.

Returns:

FacetQueryConfigAdapter.

setFacetLimit

public FacetQueryConfigAdapter setFacetLimit(int value)

Set facet.limit parameter.

Parameters:

value - the value.

Returns:

FacetQueryConfigAdapter.

setFacetOffset

public FacetQueryConfigAdapter setFacetOffset(int value)

Set facet.offset parameter.

Parameters:

value - the value.

Returns:

FacetQueryConfigAdapter.

setFacetMinCount

public FacetQueryConfigAdapter setFacetMinCount(int value)

Set facet.mincount parameter.

Parameters:

value - the value.

Returns:

FacetQueryConfigAdapter.

setFacetMissing

public FacetQueryConfigAdapter setFacetMissing(java.lang.Boolean value)

Set facet.missing parameter.

Parameters:

value - the value.

Returns:

FacetQueryConfigAdapter.

setFacetMethod

public FacetQueryConfigAdapter setFacetMethod(FacetQueryConfigAdapter.FacetMethod method)

Set facet.method parameter.

Parameters:

method - the value.

Returns:

FacetQueryConfigAdapter.

setFacetEnumCacheMinDf

public FacetQueryConfigAdapter setFacetEnumCacheMinDf(int value)

Set facet.enum.cache.minDf parameter.

Parameters:

value - the value.

Returns:

FacetQueryConfigAdapter.

setFacetDateStart

public FacetQueryConfigAdapter setFacetDateStart(java.lang.String value)

Set facet.date.start parameter.

Parameters:

value - the value.

Returns:

FacetQueryConfigAdapter.

setFacetDateEnd

public FacetQueryConfigAdapter setFacetDateEnd(java.lang.String value)

Set facet.date.end parameter.

Parameters:

value - the value.

Returns:

FacetQueryConfigAdapter.

setFacetDateGap

public FacetQueryConfigAdapter setFacetDateGap(java.lang.String value)

Set facet.date.gap parameter.

Parameters:

value - the value.

Returns:

FacetQueryConfigAdapter.

setFacetDateHardend

public FacetQueryConfigAdapter setFacetDateHardend(java.lang.Boolean value)

Set facet.date.hardend parameter.

Parameters:

value - the value.

Returns:

FacetQueryConfigAdapter.

setFacetDateOther

public FacetQueryConfigAdapter setFacetDateOther(FacetQueryConfigAdapter.FacetDateOther dateOther)

Set facet.date.other parameter.

Parameters:

dateOther - the value.

Returns:

FacetQueryConfigAdapter.