com.exalead.search.v30

Class ValueFacet

java.lang.Object

com.exalead.search.v30.FacetView

com.exalead.search.v30.Facet

com.exalead.search.v30.VirtualFacet

com.exalead.search.v30.ValueFacet

All Implemented Interfaces:

com.exalead.util.Checkable, java.io.Serializable

Direct Known Subclasses:

RelatedTermFacet

public class ValueFacet
extends VirtualFacet
implements com.exalead.util.Checkable, java.io.Serializable

Configuration for a facet.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ValueFacet.Transformer<T>
static interface	ValueFacet.Visitor

Nested classes/interfaces inherited from class com.exalead.search.v30.Facet

Facet.FromDataModel, Facet.Implementation, Facet.RefinementPolicy, Facet.Type

Nested classes/interfaces inherited from class com.exalead.search.v30.FacetView

FacetView.SortFunction

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_HITS_MAX_CATEGORIES
java.lang.String	field
int	hitsMaxCategories

Fields inherited from class com.exalead.search.v30.VirtualFacet

virtualRoot

Fields inherited from class com.exalead.search.v30.Facet

additionalFacetView, aggregationFunction, dataModelClass, dataModelProperty, dataModelState, DEFAULT_IMPLEMENTATION, DEFAULT_IN_HITS, DEFAULT_IN_NAVIGATION, DEFAULT_MAX_SLICE_CATEGORIES, DEFAULT_REFINEMENT_POLICY, fromDataModel, id, implementation, index, inHits, inNavigation, maxSliceCategories, refinementPolicy, type

Fields inherited from class com.exalead.search.v30.FacetView

aggregateScores, DEFAULT_AGGREGATE_SCORES, DEFAULT_MAX_CATEGORIES, DEFAULT_MAX_CATEGORIES_PER_LEVEL, DEFAULT_MIN_DOCS_PER_CATEGORY, DEFAULT_REVERSE, DEFAULT_SORT_FUNCTION, explicitSortOrderValues, maxCategories, maxCategoriesPerLevel, minDocsPerCategory, reverse, sortAggregationFunction, sortFunction

Constructor Summary

Constructors

Constructor and Description
ValueFacet()
ValueFacet(java.lang.String id, java.lang.String virtualRoot, java.lang.String field)
ValueFacet(ValueFacet o) Copy constructor

Method Summary

Modifier and Type	Method and Description
<T> T	accept(Facet.Transformer<T> transformer, T[] t)
void	accept(Facet.Visitor visitor)
<T> T	accept(FacetView.Transformer<T> transformer, T[] t)
void	accept(FacetView.Visitor visitor)
<T> T	accept(ValueFacet.Transformer<T> transformer, T[] t)
void	accept(ValueFacet.Visitor visitor)
<T> T	accept(VirtualFacet.Transformer<T> transformer, T[] t)
void	accept(VirtualFacet.Visitor visitor)
void	check(boolean deep, java.lang.String errorContext) Checks this ValueFacet.
static ValueFacet	fromString(java.lang.String s) String representation of this ValueFacet.
java.lang.String	getField() The Value field on which to perform the synthesis.
int	getHitsMaxCategories() Maximum number of categories displayed in hits.
ValueFacet	makeCopy() Creates and returns a deep copy of this ValueFacet.
static ValueFacet	readFrom(java.io.InputStream is) Read this ValueFacet from an XML fragment.
void	setField(java.lang.String field) The Value field on which to perform the synthesis.
void	setHitsMaxCategories(int hitsMaxCategories) Maximum number of categories displayed in hits.
java.lang.String	toString() String representation of this ValueFacet.
ValueFacet	withAdditionalFacetView(AdditionalFacetView... __values)
ValueFacet	withAdditionalFacetView(java.util.Collection<AdditionalFacetView> __values)
ValueFacet	withAggregateScores(boolean aggregateScores) Deprecated.
ValueFacet	withAggregateScores(java.lang.Boolean aggregateScores) Deprecated.
ValueFacet	withAggregationFunction(AggregationFunction... __values) A numerical computation to perform on hits matching each value of the facet.
ValueFacet	withAggregationFunction(java.util.Collection<AggregationFunction> __values)
ValueFacet	withDataModelClass(java.lang.String dataModelClass)
ValueFacet	withDataModelProperty(java.lang.String dataModelProperty)
ValueFacet	withDataModelState(java.lang.String dataModelState)
ValueFacet	withExplicitSortOrderValues(java.lang.String explicitSortOrderValues)
ValueFacet	withField(java.lang.String field)
ValueFacet	withFromDataModel(Facet fromDataModel)
ValueFacet	withHitsMaxCategories(int hitsMaxCategories)
ValueFacet	withHitsMaxCategories(java.lang.Integer hitsMaxCategories)
ValueFacet	withId(java.lang.String id)
ValueFacet	withImplementation(java.lang.String implementation)
ValueFacet	withIndex(int index)
ValueFacet	withIndex(java.lang.Integer index)
ValueFacet	withInHits(boolean inHits)
ValueFacet	withInHits(java.lang.Boolean inHits)
ValueFacet	withInNavigation(boolean inNavigation)
ValueFacet	withInNavigation(java.lang.Boolean inNavigation)
ValueFacet	withMaxCategories(int maxCategories)
ValueFacet	withMaxCategories(java.lang.Integer maxCategories)
ValueFacet	withMaxCategoriesPerLevel(int maxCategoriesPerLevel)
ValueFacet	withMaxCategoriesPerLevel(java.lang.Integer maxCategoriesPerLevel)
ValueFacet	withMaxSliceCategories(int maxSliceCategories)
ValueFacet	withMaxSliceCategories(java.lang.Integer maxSliceCategories)
ValueFacet	withMinDocsPerCategory(int minDocsPerCategory)
ValueFacet	withMinDocsPerCategory(java.lang.Integer minDocsPerCategory)
ValueFacet	withRefinementPolicy(java.lang.String refinementPolicy)
ValueFacet	withReverse(boolean reverse)
ValueFacet	withReverse(java.lang.Boolean reverse)
ValueFacet	withSortAggregationFunction(java.lang.String sortAggregationFunction)
ValueFacet	withSortFunction(java.lang.String sortFunction)
ValueFacet	withType(java.lang.String type)
ValueFacet	withVirtualRoot(java.lang.String virtualRoot)
void	writeTo(java.io.OutputStream os) Write this ValueFacet as an XML fragment

Methods inherited from class com.exalead.search.v30.VirtualFacet

getVirtualRoot, setVirtualRoot

Methods inherited from class com.exalead.search.v30.Facet

getAdditionalFacetView, getAdditionalFacetViewAsMap, getAdditionalFacetViewById, getAggregationFunction, getAggregationFunctionAsMap, getAggregationFunctionById, getDataModelClass, getDataModelProperty, getDataModelState, getFromDataModel, getId, getImplementation, getImplementationAsEnum, getIndex, getMaxSliceCategories, getRefinementPolicy, getRefinementPolicyAsEnum, getType, getTypeAsEnum, isA, isA, isA, isInHits, isInNavigation, isOneOf, isOneOf, isOneOf, removeAdditionalFacetViewById, removeAggregationFunctionById, setDataModelClass, setDataModelProperty, setDataModelState, setFromDataModel, setId, setImplementation, setImplementation, setIndex, setInHits, setInNavigation, setMaxSliceCategories, setRefinementPolicy, setRefinementPolicy, setType, setType

Methods inherited from class com.exalead.search.v30.FacetView

getExplicitSortOrderValues, getMaxCategories, getMaxCategoriesPerLevel, getMinDocsPerCategory, getSortAggregationFunction, getSortFunction, getSortFunctionAsEnum, isA, isAggregateScores, isOneOf, isReverse, setAggregateScores, setExplicitSortOrderValues, setMaxCategories, setMaxCategoriesPerLevel, setMinDocsPerCategory, setReverse, setSortAggregationFunction, setSortFunction, setSortFunction

Methods inherited from class java.lang.Object

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

Field Detail

field

public java.lang.String field

hitsMaxCategories

public int hitsMaxCategories

DEFAULT_HITS_MAX_CATEGORIES

public static final int DEFAULT_HITS_MAX_CATEGORIES

See Also:

Constant Field Values

Constructor Detail

ValueFacet

public ValueFacet()

ValueFacet

public ValueFacet(java.lang.String id,
                  java.lang.String virtualRoot,
                  java.lang.String field)

ValueFacet

public ValueFacet(ValueFacet o)

Copy constructor

Method Detail

withVirtualRoot

public ValueFacet withVirtualRoot(java.lang.String virtualRoot)

Overrides:

withVirtualRoot in class VirtualFacet

withId

public ValueFacet withId(java.lang.String id)

Overrides:

withId in class VirtualFacet

withType

public ValueFacet withType(java.lang.String type)

Overrides:

withType in class VirtualFacet

withIndex

public ValueFacet withIndex(int index)

Overrides:

withIndex in class VirtualFacet

withIndex

public ValueFacet withIndex(java.lang.Integer index)

Overrides:

withIndex in class VirtualFacet

withRefinementPolicy

public ValueFacet withRefinementPolicy(java.lang.String refinementPolicy)

Overrides:

withRefinementPolicy in class VirtualFacet

withImplementation

public ValueFacet withImplementation(java.lang.String implementation)

Overrides:

withImplementation in class VirtualFacet

withDataModelState

public ValueFacet withDataModelState(java.lang.String dataModelState)

Overrides:

withDataModelState in class VirtualFacet

withFromDataModel

public ValueFacet withFromDataModel(Facet fromDataModel)

Overrides:

withFromDataModel in class VirtualFacet

withDataModelClass

public ValueFacet withDataModelClass(java.lang.String dataModelClass)

Overrides:

withDataModelClass in class VirtualFacet

withDataModelProperty

public ValueFacet withDataModelProperty(java.lang.String dataModelProperty)

Overrides:

withDataModelProperty in class VirtualFacet

withInNavigation

public ValueFacet withInNavigation(boolean inNavigation)

Overrides:

withInNavigation in class VirtualFacet

withInNavigation

public ValueFacet withInNavigation(java.lang.Boolean inNavigation)

Overrides:

withInNavigation in class VirtualFacet

withInHits

public ValueFacet withInHits(boolean inHits)

Overrides:

withInHits in class VirtualFacet

withInHits

public ValueFacet withInHits(java.lang.Boolean inHits)

Overrides:

withInHits in class VirtualFacet

withAggregationFunction

public ValueFacet withAggregationFunction(AggregationFunction... __values)

A numerical computation to perform on hits matching each value of the facet.

Overrides:

withAggregationFunction in class VirtualFacet

withAggregationFunction

public ValueFacet withAggregationFunction(java.util.Collection<AggregationFunction> __values)

Overrides:

withAggregationFunction in class VirtualFacet

withAdditionalFacetView

public ValueFacet withAdditionalFacetView(AdditionalFacetView... __values)

Overrides:

withAdditionalFacetView in class VirtualFacet

withAdditionalFacetView

public ValueFacet withAdditionalFacetView(java.util.Collection<AdditionalFacetView> __values)

Overrides:

withAdditionalFacetView in class VirtualFacet

withMaxSliceCategories

public ValueFacet withMaxSliceCategories(int maxSliceCategories)

Overrides:

withMaxSliceCategories in class VirtualFacet

withMaxSliceCategories

public ValueFacet withMaxSliceCategories(java.lang.Integer maxSliceCategories)

Overrides:

withMaxSliceCategories in class VirtualFacet

withMinDocsPerCategory

public ValueFacet withMinDocsPerCategory(int minDocsPerCategory)

Overrides:

withMinDocsPerCategory in class VirtualFacet

withMinDocsPerCategory

public ValueFacet withMinDocsPerCategory(java.lang.Integer minDocsPerCategory)

Overrides:

withMinDocsPerCategory in class VirtualFacet

withMaxCategories

public ValueFacet withMaxCategories(int maxCategories)

Overrides:

withMaxCategories in class VirtualFacet

withMaxCategories

public ValueFacet withMaxCategories(java.lang.Integer maxCategories)

Overrides:

withMaxCategories in class VirtualFacet

withMaxCategoriesPerLevel

public ValueFacet withMaxCategoriesPerLevel(int maxCategoriesPerLevel)

Overrides:

withMaxCategoriesPerLevel in class VirtualFacet

withMaxCategoriesPerLevel

public ValueFacet withMaxCategoriesPerLevel(java.lang.Integer maxCategoriesPerLevel)

Overrides:

withMaxCategoriesPerLevel in class VirtualFacet

withSortFunction

public ValueFacet withSortFunction(java.lang.String sortFunction)

Overrides:

withSortFunction in class VirtualFacet

withSortAggregationFunction

public ValueFacet withSortAggregationFunction(java.lang.String sortAggregationFunction)

Overrides:

withSortAggregationFunction in class VirtualFacet

withExplicitSortOrderValues

public ValueFacet withExplicitSortOrderValues(java.lang.String explicitSortOrderValues)

Overrides:

withExplicitSortOrderValues in class VirtualFacet

withReverse

public ValueFacet withReverse(boolean reverse)

Overrides:

withReverse in class VirtualFacet

withReverse

public ValueFacet withReverse(java.lang.Boolean reverse)

Overrides:

withReverse in class VirtualFacet

withAggregateScores

@Deprecated
public ValueFacet withAggregateScores(boolean aggregateScores)

Deprecated.

Overrides:

withAggregateScores in class VirtualFacet

withAggregateScores

@Deprecated
public ValueFacet withAggregateScores(java.lang.Boolean aggregateScores)

Deprecated.

Overrides:

withAggregateScores in class VirtualFacet

setField

public void setField(java.lang.String field)

The Value field on which to perform the synthesis.

getField

public java.lang.String getField()

The Value field on which to perform the synthesis.

withField

public ValueFacet withField(java.lang.String field)

setHitsMaxCategories

public void setHitsMaxCategories(int hitsMaxCategories)

Maximum number of categories displayed in hits.

getHitsMaxCategories

public int getHitsMaxCategories()

Maximum number of categories displayed in hits.

withHitsMaxCategories

public ValueFacet withHitsMaxCategories(int hitsMaxCategories)

withHitsMaxCategories

public ValueFacet withHitsMaxCategories(java.lang.Integer hitsMaxCategories)

makeCopy

public ValueFacet makeCopy()

Creates and returns a deep copy of this ValueFacet.

Overrides:

makeCopy in class VirtualFacet

readFrom

public static ValueFacet readFrom(java.io.InputStream is)
                           throws javax.xml.bind.JAXBException

Read this ValueFacet from an XML fragment.

Throws:

javax.xml.bind.JAXBException

writeTo

public void writeTo(java.io.OutputStream os)
             throws javax.xml.bind.JAXBException,
                    java.io.IOException

Write this ValueFacet as an XML fragment

Overrides:

writeTo in class VirtualFacet

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

public static ValueFacet fromString(java.lang.String s)
                             throws javax.xml.bind.JAXBException,
                                    java.io.UnsupportedEncodingException

String representation of this ValueFacet.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this ValueFacet.

Overrides:

toString in class VirtualFacet

check

public void check(boolean deep,
                  java.lang.String errorContext)
           throws com.exalead.util.TypedException

Checks this ValueFacet.

Specified by:

check in interface com.exalead.util.Checkable

Overrides:

check in class VirtualFacet

Throws:

com.exalead.util.TypedException

accept

public void accept(ValueFacet.Visitor visitor)
            throws com.exalead.util.TypedException

Throws:

com.exalead.util.TypedException

accept

public void accept(VirtualFacet.Visitor visitor)
            throws com.exalead.util.TypedException

Specified by:

accept in class VirtualFacet

Throws:

com.exalead.util.TypedException

accept

public void accept(Facet.Visitor visitor)
            throws com.exalead.util.TypedException

Specified by:

accept in class Facet

Throws:

com.exalead.util.TypedException

accept

public void accept(FacetView.Visitor visitor)
            throws com.exalead.util.TypedException

Specified by:

accept in class FacetView

Throws:

com.exalead.util.TypedException

accept

public <T> T accept(ValueFacet.Transformer<T> transformer,
                    T[] t)
             throws com.exalead.util.TypedException

Throws:

com.exalead.util.TypedException

accept

public <T> T accept(VirtualFacet.Transformer<T> transformer,
                    T[] t)
             throws com.exalead.util.TypedException

Specified by:

accept in class VirtualFacet

Throws:

com.exalead.util.TypedException

accept

public <T> T accept(Facet.Transformer<T> transformer,
                    T[] t)
             throws com.exalead.util.TypedException

Specified by:

accept in class Facet

Throws:

com.exalead.util.TypedException

accept

public <T> T accept(FacetView.Transformer<T> transformer,
                    T[] t)
             throws com.exalead.util.TypedException

Specified by:

accept in class FacetView

Throws:

com.exalead.util.TypedException