com.exalead.search.v30

Class OptimizedEnumFacet

java.lang.Object

com.exalead.search.v30.FacetView

com.exalead.search.v30.Facet

com.exalead.search.v30.OptimizedEnumFacet

All Implemented Interfaces:

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

public class OptimizedEnumFacet
extends Facet
implements com.exalead.util.Checkable, java.io.Serializable

Configuration for a facet.

See Also:

Serialized Form

Nested Class Summary

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

Facet.FromDataModel, Facet.Implementation, Facet.RefinementPolicy, Facet.Transformer<T>, Facet.Type, Facet.Visitor

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

FacetView.SortFunction

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	enumFacetId
java.lang.String	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
OptimizedEnumFacet()
OptimizedEnumFacet(OptimizedEnumFacet 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)
void	check(boolean deep, java.lang.String errorContext) Checks this OptimizedEnumFacet.
static OptimizedEnumFacet	fromString(java.lang.String s) String representation of this OptimizedEnumFacet.
java.lang.String	getEnumFacetId() Id of the referred EnumFacet.
java.lang.String	getVirtualRoot() The root of the resulting 'virtual' category.
OptimizedEnumFacet	makeCopy() Creates and returns a deep copy of this OptimizedEnumFacet.
static OptimizedEnumFacet	readFrom(java.io.InputStream is) Read this OptimizedEnumFacet from an XML fragment.
void	setEnumFacetId(java.lang.String enumFacetId) Id of the referred EnumFacet.
void	setVirtualRoot(java.lang.String virtualRoot) The root of the resulting 'virtual' category.
java.lang.String	toString() String representation of this OptimizedEnumFacet.
OptimizedEnumFacet	withAdditionalFacetView(AdditionalFacetView... __values)
OptimizedEnumFacet	withAdditionalFacetView(java.util.Collection<AdditionalFacetView> __values)
OptimizedEnumFacet	withAggregateScores(boolean aggregateScores) Deprecated.
OptimizedEnumFacet	withAggregateScores(java.lang.Boolean aggregateScores) Deprecated.
OptimizedEnumFacet	withAggregationFunction(AggregationFunction... __values) A numerical computation to perform on hits matching each value of the facet.
OptimizedEnumFacet	withAggregationFunction(java.util.Collection<AggregationFunction> __values)
OptimizedEnumFacet	withDataModelClass(java.lang.String dataModelClass)
OptimizedEnumFacet	withDataModelProperty(java.lang.String dataModelProperty)
OptimizedEnumFacet	withDataModelState(java.lang.String dataModelState)
OptimizedEnumFacet	withEnumFacetId(java.lang.String enumFacetId)
OptimizedEnumFacet	withExplicitSortOrderValues(java.lang.String explicitSortOrderValues)
OptimizedEnumFacet	withFromDataModel(Facet fromDataModel)
OptimizedEnumFacet	withId(java.lang.String id)
OptimizedEnumFacet	withImplementation(java.lang.String implementation)
OptimizedEnumFacet	withIndex(int index)
OptimizedEnumFacet	withIndex(java.lang.Integer index)
OptimizedEnumFacet	withInHits(boolean inHits)
OptimizedEnumFacet	withInHits(java.lang.Boolean inHits)
OptimizedEnumFacet	withInNavigation(boolean inNavigation)
OptimizedEnumFacet	withInNavigation(java.lang.Boolean inNavigation)
OptimizedEnumFacet	withMaxCategories(int maxCategories)
OptimizedEnumFacet	withMaxCategories(java.lang.Integer maxCategories)
OptimizedEnumFacet	withMaxCategoriesPerLevel(int maxCategoriesPerLevel)
OptimizedEnumFacet	withMaxCategoriesPerLevel(java.lang.Integer maxCategoriesPerLevel)
OptimizedEnumFacet	withMaxSliceCategories(int maxSliceCategories)
OptimizedEnumFacet	withMaxSliceCategories(java.lang.Integer maxSliceCategories)
OptimizedEnumFacet	withMinDocsPerCategory(int minDocsPerCategory)
OptimizedEnumFacet	withMinDocsPerCategory(java.lang.Integer minDocsPerCategory)
OptimizedEnumFacet	withRefinementPolicy(java.lang.String refinementPolicy)
OptimizedEnumFacet	withReverse(boolean reverse)
OptimizedEnumFacet	withReverse(java.lang.Boolean reverse)
OptimizedEnumFacet	withSortAggregationFunction(java.lang.String sortAggregationFunction)
OptimizedEnumFacet	withSortFunction(java.lang.String sortFunction)
OptimizedEnumFacet	withType(java.lang.String type)
OptimizedEnumFacet	withVirtualRoot(java.lang.String virtualRoot)
void	writeTo(java.io.OutputStream os) Write this OptimizedEnumFacet as an XML fragment

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

virtualRoot

public java.lang.String virtualRoot

enumFacetId

public java.lang.String enumFacetId

Constructor Detail

OptimizedEnumFacet

public OptimizedEnumFacet()

OptimizedEnumFacet

public OptimizedEnumFacet(OptimizedEnumFacet o)

Copy constructor

Method Detail

withId

public OptimizedEnumFacet withId(java.lang.String id)

Overrides:

withId in class Facet

withType

public OptimizedEnumFacet withType(java.lang.String type)

Overrides:

withType in class Facet

withIndex

public OptimizedEnumFacet withIndex(int index)

Overrides:

withIndex in class Facet

withIndex

public OptimizedEnumFacet withIndex(java.lang.Integer index)

Overrides:

withIndex in class Facet

withRefinementPolicy

public OptimizedEnumFacet withRefinementPolicy(java.lang.String refinementPolicy)

Overrides:

withRefinementPolicy in class Facet

withImplementation

public OptimizedEnumFacet withImplementation(java.lang.String implementation)

Overrides:

withImplementation in class Facet

withDataModelState

public OptimizedEnumFacet withDataModelState(java.lang.String dataModelState)

Overrides:

withDataModelState in class Facet

withFromDataModel

public OptimizedEnumFacet withFromDataModel(Facet fromDataModel)

withDataModelClass

public OptimizedEnumFacet withDataModelClass(java.lang.String dataModelClass)

Overrides:

withDataModelClass in class Facet

withDataModelProperty

public OptimizedEnumFacet withDataModelProperty(java.lang.String dataModelProperty)

Overrides:

withDataModelProperty in class Facet

withInNavigation

public OptimizedEnumFacet withInNavigation(boolean inNavigation)

Overrides:

withInNavigation in class Facet

withInNavigation

public OptimizedEnumFacet withInNavigation(java.lang.Boolean inNavigation)

Overrides:

withInNavigation in class Facet

withInHits

public OptimizedEnumFacet withInHits(boolean inHits)

Overrides:

withInHits in class Facet

withInHits

public OptimizedEnumFacet withInHits(java.lang.Boolean inHits)

Overrides:

withInHits in class Facet

withAggregationFunction

public OptimizedEnumFacet withAggregationFunction(AggregationFunction... __values)

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

Overrides:

withAggregationFunction in class Facet

withAggregationFunction

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

Overrides:

withAggregationFunction in class Facet

withAdditionalFacetView

public OptimizedEnumFacet withAdditionalFacetView(AdditionalFacetView... __values)

Overrides:

withAdditionalFacetView in class Facet

withAdditionalFacetView

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

Overrides:

withAdditionalFacetView in class Facet

withMaxSliceCategories

public OptimizedEnumFacet withMaxSliceCategories(int maxSliceCategories)

Overrides:

withMaxSliceCategories in class Facet

withMaxSliceCategories

public OptimizedEnumFacet withMaxSliceCategories(java.lang.Integer maxSliceCategories)

Overrides:

withMaxSliceCategories in class Facet

withMinDocsPerCategory

public OptimizedEnumFacet withMinDocsPerCategory(int minDocsPerCategory)

Overrides:

withMinDocsPerCategory in class Facet

withMinDocsPerCategory

public OptimizedEnumFacet withMinDocsPerCategory(java.lang.Integer minDocsPerCategory)

Overrides:

withMinDocsPerCategory in class Facet

withMaxCategories

public OptimizedEnumFacet withMaxCategories(int maxCategories)

Overrides:

withMaxCategories in class Facet

withMaxCategories

public OptimizedEnumFacet withMaxCategories(java.lang.Integer maxCategories)

Overrides:

withMaxCategories in class Facet

withMaxCategoriesPerLevel

public OptimizedEnumFacet withMaxCategoriesPerLevel(int maxCategoriesPerLevel)

Overrides:

withMaxCategoriesPerLevel in class Facet

withMaxCategoriesPerLevel

public OptimizedEnumFacet withMaxCategoriesPerLevel(java.lang.Integer maxCategoriesPerLevel)

Overrides:

withMaxCategoriesPerLevel in class Facet

withSortFunction

public OptimizedEnumFacet withSortFunction(java.lang.String sortFunction)

Overrides:

withSortFunction in class Facet

withSortAggregationFunction

public OptimizedEnumFacet withSortAggregationFunction(java.lang.String sortAggregationFunction)

Overrides:

withSortAggregationFunction in class Facet

withExplicitSortOrderValues

public OptimizedEnumFacet withExplicitSortOrderValues(java.lang.String explicitSortOrderValues)

Overrides:

withExplicitSortOrderValues in class Facet

withReverse

public OptimizedEnumFacet withReverse(boolean reverse)

Overrides:

withReverse in class Facet

withReverse

public OptimizedEnumFacet withReverse(java.lang.Boolean reverse)

Overrides:

withReverse in class Facet

withAggregateScores

@Deprecated
public OptimizedEnumFacet withAggregateScores(boolean aggregateScores)

Deprecated.

Overrides:

withAggregateScores in class Facet

withAggregateScores

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

Deprecated.

Overrides:

withAggregateScores in class Facet

setVirtualRoot

public void setVirtualRoot(java.lang.String virtualRoot)

The root of the resulting 'virtual' category.

getVirtualRoot

public java.lang.String getVirtualRoot()

The root of the resulting 'virtual' category.

withVirtualRoot

public OptimizedEnumFacet withVirtualRoot(java.lang.String virtualRoot)

setEnumFacetId

public void setEnumFacetId(java.lang.String enumFacetId)

Id of the referred EnumFacet.

getEnumFacetId

public java.lang.String getEnumFacetId()

Id of the referred EnumFacet.

withEnumFacetId

public OptimizedEnumFacet withEnumFacetId(java.lang.String enumFacetId)

makeCopy

public OptimizedEnumFacet makeCopy()

Creates and returns a deep copy of this OptimizedEnumFacet.

Overrides:

makeCopy in class Facet

readFrom

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

Read this OptimizedEnumFacet 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 OptimizedEnumFacet as an XML fragment

Overrides:

writeTo in class Facet

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this OptimizedEnumFacet.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this OptimizedEnumFacet.

Overrides:

toString in class Facet

check

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

Checks this OptimizedEnumFacet.

Specified by:

check in interface com.exalead.util.Checkable

Overrides:

check in class Facet

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