com.exalead.search.v30

Class MultiDimensionFacet

java.lang.Object

com.exalead.search.v30.FacetView

com.exalead.search.v30.Facet

com.exalead.search.v30.MultiDimensionFacet

All Implemented Interfaces:

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

public class MultiDimensionFacet
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
boolean	additionalTreeRepresentation
static boolean	DEFAULT_ADDITIONAL_TREE_REPRESENTATION
static boolean	DEFAULT_WITH_ADDITIONAL_TREE_REPRESENTATION_DIM_SWITCH
java.util.List<MultiFacetDimension>	multiFacetDimension
java.lang.String	virtualRoot
boolean	withAdditionalTreeRepresentationDimSwitch

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
MultiDimensionFacet()
MultiDimensionFacet(MultiDimensionFacet o) Copy constructor
MultiDimensionFacet(java.lang.String id, java.lang.String virtualRoot)

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 MultiDimensionFacet.
static MultiDimensionFacet	fromString(java.lang.String s) String representation of this MultiDimensionFacet.
java.util.List<MultiFacetDimension>	getMultiFacetDimension()
java.lang.String	getVirtualRoot() The virtual root used for the tree representation.
boolean	isAdditionalTreeRepresentation()
boolean	isWithAdditionalTreeRepresentationDimSwitch() Adds a '__dimension_switch__' virtual category between each dimension of the tree reprentation. This is required if you're working with hierarhical dimensions.
MultiDimensionFacet	makeCopy() Creates and returns a deep copy of this MultiDimensionFacet.
static MultiDimensionFacet	readFrom(java.io.InputStream is) Read this MultiDimensionFacet from an XML fragment.
void	setAdditionalTreeRepresentation(boolean additionalTreeRepresentation)
void	setVirtualRoot(java.lang.String virtualRoot) The virtual root used for the tree representation.
void	setWithAdditionalTreeRepresentationDimSwitch(boolean withAdditionalTreeRepresentationDimSwitch) Adds a '__dimension_switch__' virtual category between each dimension of the tree reprentation. This is required if you're working with hierarhical dimensions.
java.lang.String	toString() String representation of this MultiDimensionFacet.
MultiDimensionFacet	withAdditionalFacetView(AdditionalFacetView... __values)
MultiDimensionFacet	withAdditionalFacetView(java.util.Collection<AdditionalFacetView> __values)
MultiDimensionFacet	withAdditionalTreeRepresentation(boolean additionalTreeRepresentation)
MultiDimensionFacet	withAdditionalTreeRepresentation(java.lang.Boolean additionalTreeRepresentation)
MultiDimensionFacet	withAggregateScores(boolean aggregateScores) Deprecated.
MultiDimensionFacet	withAggregateScores(java.lang.Boolean aggregateScores) Deprecated.
MultiDimensionFacet	withAggregationFunction(AggregationFunction... __values) A numerical computation to perform on hits matching each value of the facet.
MultiDimensionFacet	withAggregationFunction(java.util.Collection<AggregationFunction> __values)
MultiDimensionFacet	withDataModelClass(java.lang.String dataModelClass)
MultiDimensionFacet	withDataModelProperty(java.lang.String dataModelProperty)
MultiDimensionFacet	withDataModelState(java.lang.String dataModelState)
MultiDimensionFacet	withExplicitSortOrderValues(java.lang.String explicitSortOrderValues)
MultiDimensionFacet	withFromDataModel(Facet fromDataModel)
MultiDimensionFacet	withId(java.lang.String id)
MultiDimensionFacet	withImplementation(java.lang.String implementation)
MultiDimensionFacet	withIndex(int index)
MultiDimensionFacet	withIndex(java.lang.Integer index)
MultiDimensionFacet	withInHits(boolean inHits)
MultiDimensionFacet	withInHits(java.lang.Boolean inHits)
MultiDimensionFacet	withInNavigation(boolean inNavigation)
MultiDimensionFacet	withInNavigation(java.lang.Boolean inNavigation)
MultiDimensionFacet	withMaxCategories(int maxCategories)
MultiDimensionFacet	withMaxCategories(java.lang.Integer maxCategories)
MultiDimensionFacet	withMaxCategoriesPerLevel(int maxCategoriesPerLevel)
MultiDimensionFacet	withMaxCategoriesPerLevel(java.lang.Integer maxCategoriesPerLevel)
MultiDimensionFacet	withMaxSliceCategories(int maxSliceCategories)
MultiDimensionFacet	withMaxSliceCategories(java.lang.Integer maxSliceCategories)
MultiDimensionFacet	withMinDocsPerCategory(int minDocsPerCategory)
MultiDimensionFacet	withMinDocsPerCategory(java.lang.Integer minDocsPerCategory)
MultiDimensionFacet	withMultiFacetDimension(java.util.Collection<MultiFacetDimension> __values)
MultiDimensionFacet	withMultiFacetDimension(MultiFacetDimension... __values)
MultiDimensionFacet	withRefinementPolicy(java.lang.String refinementPolicy)
MultiDimensionFacet	withReverse(boolean reverse)
MultiDimensionFacet	withReverse(java.lang.Boolean reverse)
MultiDimensionFacet	withSortAggregationFunction(java.lang.String sortAggregationFunction)
MultiDimensionFacet	withSortFunction(java.lang.String sortFunction)
MultiDimensionFacet	withType(java.lang.String type)
MultiDimensionFacet	withVirtualRoot(java.lang.String virtualRoot)
MultiDimensionFacet	withWithAdditionalTreeRepresentationDimSwitch(boolean withAdditionalTreeRepresentationDimSwitch)
MultiDimensionFacet	withWithAdditionalTreeRepresentationDimSwitch(java.lang.Boolean withAdditionalTreeRepresentationDimSwitch)
void	writeTo(java.io.OutputStream os) Write this MultiDimensionFacet 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

multiFacetDimension

public java.util.List<MultiFacetDimension> multiFacetDimension

virtualRoot

public java.lang.String virtualRoot

additionalTreeRepresentation

public boolean additionalTreeRepresentation

DEFAULT_ADDITIONAL_TREE_REPRESENTATION

public static final boolean DEFAULT_ADDITIONAL_TREE_REPRESENTATION

See Also:

Constant Field Values

withAdditionalTreeRepresentationDimSwitch

public boolean withAdditionalTreeRepresentationDimSwitch

DEFAULT_WITH_ADDITIONAL_TREE_REPRESENTATION_DIM_SWITCH

public static final boolean DEFAULT_WITH_ADDITIONAL_TREE_REPRESENTATION_DIM_SWITCH

See Also:

Constant Field Values

Constructor Detail

MultiDimensionFacet

public MultiDimensionFacet()

MultiDimensionFacet

public MultiDimensionFacet(java.lang.String id,
                           java.lang.String virtualRoot)

MultiDimensionFacet

public MultiDimensionFacet(MultiDimensionFacet o)

Copy constructor

Method Detail

withId

public MultiDimensionFacet withId(java.lang.String id)

Overrides:

withId in class Facet

withType

public MultiDimensionFacet withType(java.lang.String type)

Overrides:

withType in class Facet

withIndex

public MultiDimensionFacet withIndex(int index)

Overrides:

withIndex in class Facet

withIndex

public MultiDimensionFacet withIndex(java.lang.Integer index)

Overrides:

withIndex in class Facet

withRefinementPolicy

public MultiDimensionFacet withRefinementPolicy(java.lang.String refinementPolicy)

Overrides:

withRefinementPolicy in class Facet

withImplementation

public MultiDimensionFacet withImplementation(java.lang.String implementation)

Overrides:

withImplementation in class Facet

withDataModelState

public MultiDimensionFacet withDataModelState(java.lang.String dataModelState)

Overrides:

withDataModelState in class Facet

withFromDataModel

public MultiDimensionFacet withFromDataModel(Facet fromDataModel)

withDataModelClass

public MultiDimensionFacet withDataModelClass(java.lang.String dataModelClass)

Overrides:

withDataModelClass in class Facet

withDataModelProperty

public MultiDimensionFacet withDataModelProperty(java.lang.String dataModelProperty)

Overrides:

withDataModelProperty in class Facet

withInNavigation

public MultiDimensionFacet withInNavigation(boolean inNavigation)

Overrides:

withInNavigation in class Facet

withInNavigation

public MultiDimensionFacet withInNavigation(java.lang.Boolean inNavigation)

Overrides:

withInNavigation in class Facet

withInHits

public MultiDimensionFacet withInHits(boolean inHits)

Overrides:

withInHits in class Facet

withInHits

public MultiDimensionFacet withInHits(java.lang.Boolean inHits)

Overrides:

withInHits in class Facet

withAggregationFunction

public MultiDimensionFacet withAggregationFunction(AggregationFunction... __values)

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

Overrides:

withAggregationFunction in class Facet

withAggregationFunction

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

Overrides:

withAggregationFunction in class Facet

withAdditionalFacetView

public MultiDimensionFacet withAdditionalFacetView(AdditionalFacetView... __values)

Overrides:

withAdditionalFacetView in class Facet

withAdditionalFacetView

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

Overrides:

withAdditionalFacetView in class Facet

withMaxSliceCategories

public MultiDimensionFacet withMaxSliceCategories(int maxSliceCategories)

Overrides:

withMaxSliceCategories in class Facet

withMaxSliceCategories

public MultiDimensionFacet withMaxSliceCategories(java.lang.Integer maxSliceCategories)

Overrides:

withMaxSliceCategories in class Facet

withMinDocsPerCategory

public MultiDimensionFacet withMinDocsPerCategory(int minDocsPerCategory)

Overrides:

withMinDocsPerCategory in class Facet

withMinDocsPerCategory

public MultiDimensionFacet withMinDocsPerCategory(java.lang.Integer minDocsPerCategory)

Overrides:

withMinDocsPerCategory in class Facet

withMaxCategories

public MultiDimensionFacet withMaxCategories(int maxCategories)

Overrides:

withMaxCategories in class Facet

withMaxCategories

public MultiDimensionFacet withMaxCategories(java.lang.Integer maxCategories)

Overrides:

withMaxCategories in class Facet

withMaxCategoriesPerLevel

public MultiDimensionFacet withMaxCategoriesPerLevel(int maxCategoriesPerLevel)

Overrides:

withMaxCategoriesPerLevel in class Facet

withMaxCategoriesPerLevel

public MultiDimensionFacet withMaxCategoriesPerLevel(java.lang.Integer maxCategoriesPerLevel)

Overrides:

withMaxCategoriesPerLevel in class Facet

withSortFunction

public MultiDimensionFacet withSortFunction(java.lang.String sortFunction)

Overrides:

withSortFunction in class Facet

withSortAggregationFunction

public MultiDimensionFacet withSortAggregationFunction(java.lang.String sortAggregationFunction)

Overrides:

withSortAggregationFunction in class Facet

withExplicitSortOrderValues

public MultiDimensionFacet withExplicitSortOrderValues(java.lang.String explicitSortOrderValues)

Overrides:

withExplicitSortOrderValues in class Facet

withReverse

public MultiDimensionFacet withReverse(boolean reverse)

Overrides:

withReverse in class Facet

withReverse

public MultiDimensionFacet withReverse(java.lang.Boolean reverse)

Overrides:

withReverse in class Facet

withAggregateScores

@Deprecated
public MultiDimensionFacet withAggregateScores(boolean aggregateScores)

Deprecated.

Overrides:

withAggregateScores in class Facet

withAggregateScores

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

Deprecated.

Overrides:

withAggregateScores in class Facet

getMultiFacetDimension

public java.util.List<MultiFacetDimension> getMultiFacetDimension()

withMultiFacetDimension

public MultiDimensionFacet withMultiFacetDimension(MultiFacetDimension... __values)

withMultiFacetDimension

public MultiDimensionFacet withMultiFacetDimension(java.util.Collection<MultiFacetDimension> __values)

setVirtualRoot

public void setVirtualRoot(java.lang.String virtualRoot)

The virtual root used for the tree representation.

getVirtualRoot

public java.lang.String getVirtualRoot()

The virtual root used for the tree representation.

withVirtualRoot

public MultiDimensionFacet withVirtualRoot(java.lang.String virtualRoot)

setAdditionalTreeRepresentation

public void setAdditionalTreeRepresentation(boolean additionalTreeRepresentation)

isAdditionalTreeRepresentation

public boolean isAdditionalTreeRepresentation()

withAdditionalTreeRepresentation

public MultiDimensionFacet withAdditionalTreeRepresentation(boolean additionalTreeRepresentation)

withAdditionalTreeRepresentation

public MultiDimensionFacet withAdditionalTreeRepresentation(java.lang.Boolean additionalTreeRepresentation)

setWithAdditionalTreeRepresentationDimSwitch

public void setWithAdditionalTreeRepresentationDimSwitch(boolean withAdditionalTreeRepresentationDimSwitch)

Adds a '__dimension_switch__' virtual category between each dimension of the tree reprentation.
This is required if you're working with hierarhical dimensions.

isWithAdditionalTreeRepresentationDimSwitch

public boolean isWithAdditionalTreeRepresentationDimSwitch()

Adds a '__dimension_switch__' virtual category between each dimension of the tree reprentation.
This is required if you're working with hierarhical dimensions.

withWithAdditionalTreeRepresentationDimSwitch

public MultiDimensionFacet withWithAdditionalTreeRepresentationDimSwitch(boolean withAdditionalTreeRepresentationDimSwitch)

withWithAdditionalTreeRepresentationDimSwitch

public MultiDimensionFacet withWithAdditionalTreeRepresentationDimSwitch(java.lang.Boolean withAdditionalTreeRepresentationDimSwitch)

makeCopy

public MultiDimensionFacet makeCopy()

Creates and returns a deep copy of this MultiDimensionFacet.

Overrides:

makeCopy in class Facet

readFrom

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

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

Overrides:

writeTo in class Facet

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this MultiDimensionFacet.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this MultiDimensionFacet.

Overrides:

toString in class Facet

check

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

Checks this MultiDimensionFacet.

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