com.exalead.search.v30

Class VirtualFacet

java.lang.Object

com.exalead.search.v30.FacetView

com.exalead.search.v30.Facet

com.exalead.search.v30.VirtualFacet

All Implemented Interfaces:

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

Direct Known Subclasses:

AutoTileGeoFacet, AutoTileGeoV2Facet, ConcatValueFacet, DateFacet, DynamicDateFacet, ExplicitGeoFacet, Hierarchical2DFacet, LuaFacet, NumericalFacet, ValueFacet

public abstract class VirtualFacet
extends Facet
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	VirtualFacet.Transformer<T>
static interface	VirtualFacet.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
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
VirtualFacet()
VirtualFacet(VirtualFacet o) Copy constructor

Method Summary

Modifier and Type	Method and Description
abstract <T> T	accept(VirtualFacet.Transformer<T> transformer, T[] t)
abstract void	accept(VirtualFacet.Visitor visitor)
void	check(boolean deep, java.lang.String errorContext) Checks this VirtualFacet.
static VirtualFacet	fromString(java.lang.String s) String representation of this VirtualFacet.
java.lang.String	getVirtualRoot() Path for the resulting root 'virtual' category.
VirtualFacet	makeCopy()
static VirtualFacet	readFrom(java.io.InputStream is) Read this VirtualFacet from an XML fragment.
void	setVirtualRoot(java.lang.String virtualRoot) Path for the resulting root 'virtual' category.
java.lang.String	toString() String representation of this VirtualFacet.
VirtualFacet	withAdditionalFacetView(AdditionalFacetView... __values)
VirtualFacet	withAdditionalFacetView(java.util.Collection<AdditionalFacetView> __values)
VirtualFacet	withAggregateScores(boolean aggregateScores) Deprecated.
VirtualFacet	withAggregateScores(java.lang.Boolean aggregateScores) Deprecated.
VirtualFacet	withAggregationFunction(AggregationFunction... __values) A numerical computation to perform on hits matching each value of the facet.
VirtualFacet	withAggregationFunction(java.util.Collection<AggregationFunction> __values)
VirtualFacet	withDataModelClass(java.lang.String dataModelClass)
VirtualFacet	withDataModelProperty(java.lang.String dataModelProperty)
VirtualFacet	withDataModelState(java.lang.String dataModelState)
VirtualFacet	withExplicitSortOrderValues(java.lang.String explicitSortOrderValues)
VirtualFacet	withFromDataModel(Facet fromDataModel)
VirtualFacet	withId(java.lang.String id)
VirtualFacet	withImplementation(java.lang.String implementation)
VirtualFacet	withIndex(int index)
VirtualFacet	withIndex(java.lang.Integer index)
VirtualFacet	withInHits(boolean inHits)
VirtualFacet	withInHits(java.lang.Boolean inHits)
VirtualFacet	withInNavigation(boolean inNavigation)
VirtualFacet	withInNavigation(java.lang.Boolean inNavigation)
VirtualFacet	withMaxCategories(int maxCategories)
VirtualFacet	withMaxCategories(java.lang.Integer maxCategories)
VirtualFacet	withMaxCategoriesPerLevel(int maxCategoriesPerLevel)
VirtualFacet	withMaxCategoriesPerLevel(java.lang.Integer maxCategoriesPerLevel)
VirtualFacet	withMaxSliceCategories(int maxSliceCategories)
VirtualFacet	withMaxSliceCategories(java.lang.Integer maxSliceCategories)
VirtualFacet	withMinDocsPerCategory(int minDocsPerCategory)
VirtualFacet	withMinDocsPerCategory(java.lang.Integer minDocsPerCategory)
VirtualFacet	withRefinementPolicy(java.lang.String refinementPolicy)
VirtualFacet	withReverse(boolean reverse)
VirtualFacet	withReverse(java.lang.Boolean reverse)
VirtualFacet	withSortAggregationFunction(java.lang.String sortAggregationFunction)
VirtualFacet	withSortFunction(java.lang.String sortFunction)
VirtualFacet	withType(java.lang.String type)
VirtualFacet	withVirtualRoot(java.lang.String virtualRoot)
void	writeTo(java.io.OutputStream os)

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

accept, accept, 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

accept, accept, 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

Constructor Detail

VirtualFacet

public VirtualFacet()

VirtualFacet

public VirtualFacet(VirtualFacet o)

Copy constructor

Method Detail

withId

public VirtualFacet withId(java.lang.String id)

Overrides:

withId in class Facet

withType

public VirtualFacet withType(java.lang.String type)

Overrides:

withType in class Facet

withIndex

public VirtualFacet withIndex(int index)

Overrides:

withIndex in class Facet

withIndex

public VirtualFacet withIndex(java.lang.Integer index)

Overrides:

withIndex in class Facet

withRefinementPolicy

public VirtualFacet withRefinementPolicy(java.lang.String refinementPolicy)

Overrides:

withRefinementPolicy in class Facet

withImplementation

public VirtualFacet withImplementation(java.lang.String implementation)

Overrides:

withImplementation in class Facet

withDataModelState

public VirtualFacet withDataModelState(java.lang.String dataModelState)

Overrides:

withDataModelState in class Facet

withFromDataModel

public VirtualFacet withFromDataModel(Facet fromDataModel)

withDataModelClass

public VirtualFacet withDataModelClass(java.lang.String dataModelClass)

Overrides:

withDataModelClass in class Facet

withDataModelProperty

public VirtualFacet withDataModelProperty(java.lang.String dataModelProperty)

Overrides:

withDataModelProperty in class Facet

withInNavigation

public VirtualFacet withInNavigation(boolean inNavigation)

Overrides:

withInNavigation in class Facet

withInNavigation

public VirtualFacet withInNavigation(java.lang.Boolean inNavigation)

Overrides:

withInNavigation in class Facet

withInHits

public VirtualFacet withInHits(boolean inHits)

Overrides:

withInHits in class Facet

withInHits

public VirtualFacet withInHits(java.lang.Boolean inHits)

Overrides:

withInHits in class Facet

withAggregationFunction

public VirtualFacet withAggregationFunction(AggregationFunction... __values)

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

Overrides:

withAggregationFunction in class Facet

withAggregationFunction

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

Overrides:

withAggregationFunction in class Facet

withAdditionalFacetView

public VirtualFacet withAdditionalFacetView(AdditionalFacetView... __values)

Overrides:

withAdditionalFacetView in class Facet

withAdditionalFacetView

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

Overrides:

withAdditionalFacetView in class Facet

withMaxSliceCategories

public VirtualFacet withMaxSliceCategories(int maxSliceCategories)

Overrides:

withMaxSliceCategories in class Facet

withMaxSliceCategories

public VirtualFacet withMaxSliceCategories(java.lang.Integer maxSliceCategories)

Overrides:

withMaxSliceCategories in class Facet

withMinDocsPerCategory

public VirtualFacet withMinDocsPerCategory(int minDocsPerCategory)

Overrides:

withMinDocsPerCategory in class Facet

withMinDocsPerCategory

public VirtualFacet withMinDocsPerCategory(java.lang.Integer minDocsPerCategory)

Overrides:

withMinDocsPerCategory in class Facet

withMaxCategories

public VirtualFacet withMaxCategories(int maxCategories)

Overrides:

withMaxCategories in class Facet

withMaxCategories

public VirtualFacet withMaxCategories(java.lang.Integer maxCategories)

Overrides:

withMaxCategories in class Facet

withMaxCategoriesPerLevel

public VirtualFacet withMaxCategoriesPerLevel(int maxCategoriesPerLevel)

Overrides:

withMaxCategoriesPerLevel in class Facet

withMaxCategoriesPerLevel

public VirtualFacet withMaxCategoriesPerLevel(java.lang.Integer maxCategoriesPerLevel)

Overrides:

withMaxCategoriesPerLevel in class Facet

withSortFunction

public VirtualFacet withSortFunction(java.lang.String sortFunction)

Overrides:

withSortFunction in class Facet

withSortAggregationFunction

public VirtualFacet withSortAggregationFunction(java.lang.String sortAggregationFunction)

Overrides:

withSortAggregationFunction in class Facet

withExplicitSortOrderValues

public VirtualFacet withExplicitSortOrderValues(java.lang.String explicitSortOrderValues)

Overrides:

withExplicitSortOrderValues in class Facet

withReverse

public VirtualFacet withReverse(boolean reverse)

Overrides:

withReverse in class Facet

withReverse

public VirtualFacet withReverse(java.lang.Boolean reverse)

Overrides:

withReverse in class Facet

withAggregateScores

@Deprecated
public VirtualFacet withAggregateScores(boolean aggregateScores)

Deprecated.

Overrides:

withAggregateScores in class Facet

withAggregateScores

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

Deprecated.

Overrides:

withAggregateScores in class Facet

setVirtualRoot

public void setVirtualRoot(java.lang.String virtualRoot)

Path for the resulting root 'virtual' category. When using a virtual facet (a facet which is not stored in a category field), all created categories are attached to a virtual root path.
For example: Top/VirtualRoot/[0;5]

getVirtualRoot

public java.lang.String getVirtualRoot()

Path for the resulting root 'virtual' category. When using a virtual facet (a facet which is not stored in a category field), all created categories are attached to a virtual root path.
For example: Top/VirtualRoot/[0;5]

withVirtualRoot

public VirtualFacet withVirtualRoot(java.lang.String virtualRoot)

makeCopy

public VirtualFacet makeCopy()

Overrides:

makeCopy in class Facet

readFrom

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

Read this VirtualFacet 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

Overrides:

writeTo in class Facet

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this VirtualFacet.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this VirtualFacet.

Overrides:

toString in class Facet

check

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

Checks this VirtualFacet.

Specified by:

check in interface com.exalead.util.Checkable

Overrides:

check in class Facet

Throws:

com.exalead.util.TypedException

accept

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

Throws:

com.exalead.util.TypedException

accept

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

Throws:

com.exalead.util.TypedException