public class Hierarchical2DFacet extends VirtualFacet implements com.exalead.util.Checkable, java.io.Serializable
Modifier and Type | Class and Description |
---|---|
static class |
Hierarchical2DFacet.SecondarySortFunction |
VirtualFacet.Transformer<T>, VirtualFacet.Visitor
Facet.FromDataModel, Facet.Implementation, Facet.RefinementPolicy, Facet.Type
FacetView.SortFunction
Modifier and Type | Field and Description |
---|---|
static boolean |
DEFAULT_HIERARCHICAL2_D_FACET_REPRESENTATION |
static boolean |
DEFAULT_SECONDARY_REVERSE |
static java.lang.String |
DEFAULT_SECONDARY_SORT_FUNCTION |
static boolean |
DEFAULT_WITH_DIM_SWITCH |
boolean |
hierarchical2DFacetRepresentation |
java.lang.String |
id1 |
java.lang.String |
id2 |
java.lang.String |
secondaryExplicitSortOrderValues |
boolean |
secondaryReverse |
java.lang.String |
secondarySortAggregationFunction |
java.lang.String |
secondarySortFunction |
boolean |
withDimSwitch |
virtualRoot
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
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 and Description |
---|
Hierarchical2DFacet() |
Hierarchical2DFacet(Hierarchical2DFacet o)
Copy constructor
|
Hierarchical2DFacet(java.lang.String id,
java.lang.String virtualRoot,
java.lang.String id1,
java.lang.String id2) |
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(VirtualFacet.Transformer<T> transformer,
T[] t) |
void |
accept(VirtualFacet.Visitor visitor) |
void |
check(boolean deep,
java.lang.String errorContext)
Checks this Hierarchical2DFacet.
|
static Hierarchical2DFacet |
fromString(java.lang.String s)
String representation of this Hierarchical2DFacet.
|
java.lang.String |
getId1()
id of the first facet on which to perform the synthesis
|
java.lang.String |
getId2()
id of the second facet on which to perform the synthesis
|
java.lang.String |
getSecondaryExplicitSortOrderValues()
The ordered list of values used to sort, comma-separated (use the backslash to escape a comma)
|
java.lang.String |
getSecondarySortAggregationFunction()
The aggregation function used to sort by aggregation values.
|
java.lang.String |
getSecondarySortFunction()
The function to use to sort on the second dimension (see 'sortFunction' in Facet).
|
Hierarchical2DFacet.SecondarySortFunction |
getSecondarySortFunctionAsEnum()
The function to use to sort on the second dimension (see 'sortFunction' in Facet).
|
static boolean |
isA(java.lang.String str,
Hierarchical2DFacet.SecondarySortFunction item) |
boolean |
isHierarchical2DFacetRepresentation()
Enables the use of asHierarchical2DFacet() in search client.
|
static boolean |
isOneOf(java.lang.String str,
Hierarchical2DFacet.SecondarySortFunction... items) |
boolean |
isSecondaryReverse()
Reverses the secondary sort (see 'reverse' in Facet).
|
boolean |
isWithDimSwitch()
Adds a '__dimension_switch__' virtual category between categories of the first and second dimensions.
|
Hierarchical2DFacet |
makeCopy()
Creates and returns a deep copy of this Hierarchical2DFacet.
|
static Hierarchical2DFacet |
readFrom(java.io.InputStream is)
Read this Hierarchical2DFacet from an XML fragment.
|
void |
setHierarchical2DFacetRepresentation(boolean hierarchical2DFacetRepresentation)
Enables the use of asHierarchical2DFacet() in search client.
|
void |
setId1(java.lang.String id1)
id of the first facet on which to perform the synthesis
|
void |
setId2(java.lang.String id2)
id of the second facet on which to perform the synthesis
|
void |
setSecondaryExplicitSortOrderValues(java.lang.String secondaryExplicitSortOrderValues)
The ordered list of values used to sort, comma-separated (use the backslash to escape a comma)
|
void |
setSecondaryReverse(boolean secondaryReverse)
Reverses the secondary sort (see 'reverse' in Facet).
|
void |
setSecondarySortAggregationFunction(java.lang.String secondarySortAggregationFunction)
The aggregation function used to sort by aggregation values.
|
void |
setSecondarySortFunction(Hierarchical2DFacet.SecondarySortFunction item)
The function to use to sort on the second dimension (see 'sortFunction' in Facet).
|
void |
setSecondarySortFunction(java.lang.String secondarySortFunction)
The function to use to sort on the second dimension (see 'sortFunction' in Facet).
|
void |
setWithDimSwitch(boolean withDimSwitch)
Adds a '__dimension_switch__' virtual category between categories of the first and second dimensions.
|
java.lang.String |
toString()
String representation of this Hierarchical2DFacet.
|
Hierarchical2DFacet |
withAdditionalFacetView(AdditionalFacetView... __values) |
Hierarchical2DFacet |
withAdditionalFacetView(java.util.Collection<AdditionalFacetView> __values) |
Hierarchical2DFacet |
withAggregateScores(boolean aggregateScores)
Deprecated.
|
Hierarchical2DFacet |
withAggregateScores(java.lang.Boolean aggregateScores)
Deprecated.
|
Hierarchical2DFacet |
withAggregationFunction(AggregationFunction... __values)
A numerical computation to perform on hits matching each value of the facet.
|
Hierarchical2DFacet |
withAggregationFunction(java.util.Collection<AggregationFunction> __values) |
Hierarchical2DFacet |
withDataModelClass(java.lang.String dataModelClass) |
Hierarchical2DFacet |
withDataModelProperty(java.lang.String dataModelProperty) |
Hierarchical2DFacet |
withDataModelState(java.lang.String dataModelState) |
Hierarchical2DFacet |
withExplicitSortOrderValues(java.lang.String explicitSortOrderValues) |
Hierarchical2DFacet |
withFromDataModel(Facet fromDataModel) |
Hierarchical2DFacet |
withHierarchical2DFacetRepresentation(boolean hierarchical2DFacetRepresentation) |
Hierarchical2DFacet |
withHierarchical2DFacetRepresentation(java.lang.Boolean hierarchical2DFacetRepresentation) |
Hierarchical2DFacet |
withId(java.lang.String id) |
Hierarchical2DFacet |
withId1(java.lang.String id1) |
Hierarchical2DFacet |
withId2(java.lang.String id2) |
Hierarchical2DFacet |
withImplementation(java.lang.String implementation) |
Hierarchical2DFacet |
withIndex(int index) |
Hierarchical2DFacet |
withIndex(java.lang.Integer index) |
Hierarchical2DFacet |
withInHits(boolean inHits) |
Hierarchical2DFacet |
withInHits(java.lang.Boolean inHits) |
Hierarchical2DFacet |
withInNavigation(boolean inNavigation) |
Hierarchical2DFacet |
withInNavigation(java.lang.Boolean inNavigation) |
Hierarchical2DFacet |
withMaxCategories(int maxCategories) |
Hierarchical2DFacet |
withMaxCategories(java.lang.Integer maxCategories) |
Hierarchical2DFacet |
withMaxCategoriesPerLevel(int maxCategoriesPerLevel) |
Hierarchical2DFacet |
withMaxCategoriesPerLevel(java.lang.Integer maxCategoriesPerLevel) |
Hierarchical2DFacet |
withMaxSliceCategories(int maxSliceCategories) |
Hierarchical2DFacet |
withMaxSliceCategories(java.lang.Integer maxSliceCategories) |
Hierarchical2DFacet |
withMinDocsPerCategory(int minDocsPerCategory) |
Hierarchical2DFacet |
withMinDocsPerCategory(java.lang.Integer minDocsPerCategory) |
Hierarchical2DFacet |
withRefinementPolicy(java.lang.String refinementPolicy) |
Hierarchical2DFacet |
withReverse(boolean reverse) |
Hierarchical2DFacet |
withReverse(java.lang.Boolean reverse) |
Hierarchical2DFacet |
withSecondaryExplicitSortOrderValues(java.lang.String secondaryExplicitSortOrderValues) |
Hierarchical2DFacet |
withSecondaryReverse(boolean secondaryReverse) |
Hierarchical2DFacet |
withSecondaryReverse(java.lang.Boolean secondaryReverse) |
Hierarchical2DFacet |
withSecondarySortAggregationFunction(java.lang.String secondarySortAggregationFunction) |
Hierarchical2DFacet |
withSecondarySortFunction(java.lang.String secondarySortFunction) |
Hierarchical2DFacet |
withSortAggregationFunction(java.lang.String sortAggregationFunction) |
Hierarchical2DFacet |
withSortFunction(java.lang.String sortFunction) |
Hierarchical2DFacet |
withType(java.lang.String type) |
Hierarchical2DFacet |
withVirtualRoot(java.lang.String virtualRoot) |
Hierarchical2DFacet |
withWithDimSwitch(boolean withDimSwitch) |
Hierarchical2DFacet |
withWithDimSwitch(java.lang.Boolean withDimSwitch) |
void |
writeTo(java.io.OutputStream os)
Write this Hierarchical2DFacet as an XML fragment
|
getVirtualRoot, setVirtualRoot
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
getExplicitSortOrderValues, getMaxCategories, getMaxCategoriesPerLevel, getMinDocsPerCategory, getSortAggregationFunction, getSortFunction, getSortFunctionAsEnum, isA, isAggregateScores, isOneOf, isReverse, setAggregateScores, setExplicitSortOrderValues, setMaxCategories, setMaxCategoriesPerLevel, setMinDocsPerCategory, setReverse, setSortAggregationFunction, setSortFunction, setSortFunction
public java.lang.String id1
public java.lang.String id2
public boolean withDimSwitch
public static final boolean DEFAULT_WITH_DIM_SWITCH
public java.lang.String secondarySortFunction
public static final java.lang.String DEFAULT_SECONDARY_SORT_FUNCTION
public boolean secondaryReverse
public static final boolean DEFAULT_SECONDARY_REVERSE
public java.lang.String secondarySortAggregationFunction
public java.lang.String secondaryExplicitSortOrderValues
public boolean hierarchical2DFacetRepresentation
public static final boolean DEFAULT_HIERARCHICAL2_D_FACET_REPRESENTATION
public Hierarchical2DFacet()
public Hierarchical2DFacet(java.lang.String id, java.lang.String virtualRoot, java.lang.String id1, java.lang.String id2)
public Hierarchical2DFacet(Hierarchical2DFacet o)
public static boolean isA(java.lang.String str, Hierarchical2DFacet.SecondarySortFunction item)
public static boolean isOneOf(java.lang.String str, Hierarchical2DFacet.SecondarySortFunction... items)
public void setSecondarySortFunction(Hierarchical2DFacet.SecondarySortFunction item)
public Hierarchical2DFacet.SecondarySortFunction getSecondarySortFunctionAsEnum()
public Hierarchical2DFacet withVirtualRoot(java.lang.String virtualRoot)
withVirtualRoot
in class VirtualFacet
public Hierarchical2DFacet withId(java.lang.String id)
withId
in class VirtualFacet
public Hierarchical2DFacet withType(java.lang.String type)
withType
in class VirtualFacet
public Hierarchical2DFacet withIndex(int index)
withIndex
in class VirtualFacet
public Hierarchical2DFacet withIndex(java.lang.Integer index)
withIndex
in class VirtualFacet
public Hierarchical2DFacet withRefinementPolicy(java.lang.String refinementPolicy)
withRefinementPolicy
in class VirtualFacet
public Hierarchical2DFacet withImplementation(java.lang.String implementation)
withImplementation
in class VirtualFacet
public Hierarchical2DFacet withDataModelState(java.lang.String dataModelState)
withDataModelState
in class VirtualFacet
public Hierarchical2DFacet withFromDataModel(Facet fromDataModel)
withFromDataModel
in class VirtualFacet
public Hierarchical2DFacet withDataModelClass(java.lang.String dataModelClass)
withDataModelClass
in class VirtualFacet
public Hierarchical2DFacet withDataModelProperty(java.lang.String dataModelProperty)
withDataModelProperty
in class VirtualFacet
public Hierarchical2DFacet withInNavigation(boolean inNavigation)
withInNavigation
in class VirtualFacet
public Hierarchical2DFacet withInNavigation(java.lang.Boolean inNavigation)
withInNavigation
in class VirtualFacet
public Hierarchical2DFacet withInHits(boolean inHits)
withInHits
in class VirtualFacet
public Hierarchical2DFacet withInHits(java.lang.Boolean inHits)
withInHits
in class VirtualFacet
public Hierarchical2DFacet withAggregationFunction(AggregationFunction... __values)
withAggregationFunction
in class VirtualFacet
public Hierarchical2DFacet withAggregationFunction(java.util.Collection<AggregationFunction> __values)
withAggregationFunction
in class VirtualFacet
public Hierarchical2DFacet withAdditionalFacetView(AdditionalFacetView... __values)
withAdditionalFacetView
in class VirtualFacet
public Hierarchical2DFacet withAdditionalFacetView(java.util.Collection<AdditionalFacetView> __values)
withAdditionalFacetView
in class VirtualFacet
public Hierarchical2DFacet withMaxSliceCategories(int maxSliceCategories)
withMaxSliceCategories
in class VirtualFacet
public Hierarchical2DFacet withMaxSliceCategories(java.lang.Integer maxSliceCategories)
withMaxSliceCategories
in class VirtualFacet
public Hierarchical2DFacet withMinDocsPerCategory(int minDocsPerCategory)
withMinDocsPerCategory
in class VirtualFacet
public Hierarchical2DFacet withMinDocsPerCategory(java.lang.Integer minDocsPerCategory)
withMinDocsPerCategory
in class VirtualFacet
public Hierarchical2DFacet withMaxCategories(int maxCategories)
withMaxCategories
in class VirtualFacet
public Hierarchical2DFacet withMaxCategories(java.lang.Integer maxCategories)
withMaxCategories
in class VirtualFacet
public Hierarchical2DFacet withMaxCategoriesPerLevel(int maxCategoriesPerLevel)
withMaxCategoriesPerLevel
in class VirtualFacet
public Hierarchical2DFacet withMaxCategoriesPerLevel(java.lang.Integer maxCategoriesPerLevel)
withMaxCategoriesPerLevel
in class VirtualFacet
public Hierarchical2DFacet withSortFunction(java.lang.String sortFunction)
withSortFunction
in class VirtualFacet
public Hierarchical2DFacet withSortAggregationFunction(java.lang.String sortAggregationFunction)
withSortAggregationFunction
in class VirtualFacet
public Hierarchical2DFacet withExplicitSortOrderValues(java.lang.String explicitSortOrderValues)
withExplicitSortOrderValues
in class VirtualFacet
public Hierarchical2DFacet withReverse(boolean reverse)
withReverse
in class VirtualFacet
public Hierarchical2DFacet withReverse(java.lang.Boolean reverse)
withReverse
in class VirtualFacet
@Deprecated public Hierarchical2DFacet withAggregateScores(boolean aggregateScores)
withAggregateScores
in class VirtualFacet
@Deprecated public Hierarchical2DFacet withAggregateScores(java.lang.Boolean aggregateScores)
withAggregateScores
in class VirtualFacet
public void setId1(java.lang.String id1)
public java.lang.String getId1()
public Hierarchical2DFacet withId1(java.lang.String id1)
public void setId2(java.lang.String id2)
public java.lang.String getId2()
public Hierarchical2DFacet withId2(java.lang.String id2)
public void setWithDimSwitch(boolean withDimSwitch)
public boolean isWithDimSwitch()
public Hierarchical2DFacet withWithDimSwitch(boolean withDimSwitch)
public Hierarchical2DFacet withWithDimSwitch(java.lang.Boolean withDimSwitch)
public void setSecondarySortFunction(java.lang.String secondarySortFunction)
public java.lang.String getSecondarySortFunction()
public Hierarchical2DFacet withSecondarySortFunction(java.lang.String secondarySortFunction)
public void setSecondaryReverse(boolean secondaryReverse)
public boolean isSecondaryReverse()
public Hierarchical2DFacet withSecondaryReverse(boolean secondaryReverse)
public Hierarchical2DFacet withSecondaryReverse(java.lang.Boolean secondaryReverse)
public void setSecondarySortAggregationFunction(java.lang.String secondarySortAggregationFunction)
public java.lang.String getSecondarySortAggregationFunction()
public Hierarchical2DFacet withSecondarySortAggregationFunction(java.lang.String secondarySortAggregationFunction)
public void setSecondaryExplicitSortOrderValues(java.lang.String secondaryExplicitSortOrderValues)
public java.lang.String getSecondaryExplicitSortOrderValues()
public Hierarchical2DFacet withSecondaryExplicitSortOrderValues(java.lang.String secondaryExplicitSortOrderValues)
public void setHierarchical2DFacetRepresentation(boolean hierarchical2DFacetRepresentation)
public boolean isHierarchical2DFacetRepresentation()
public Hierarchical2DFacet withHierarchical2DFacetRepresentation(boolean hierarchical2DFacetRepresentation)
public Hierarchical2DFacet withHierarchical2DFacetRepresentation(java.lang.Boolean hierarchical2DFacetRepresentation)
public Hierarchical2DFacet makeCopy()
makeCopy
in class VirtualFacet
public static Hierarchical2DFacet readFrom(java.io.InputStream is) throws javax.xml.bind.JAXBException
javax.xml.bind.JAXBException
public void writeTo(java.io.OutputStream os) throws javax.xml.bind.JAXBException, java.io.IOException
writeTo
in class VirtualFacet
javax.xml.bind.JAXBException
java.io.IOException
public static Hierarchical2DFacet fromString(java.lang.String s) throws javax.xml.bind.JAXBException, java.io.UnsupportedEncodingException
javax.xml.bind.JAXBException
java.io.UnsupportedEncodingException
public java.lang.String toString()
toString
in class VirtualFacet
public void check(boolean deep, java.lang.String errorContext) throws com.exalead.util.TypedException
check
in interface com.exalead.util.Checkable
check
in class VirtualFacet
com.exalead.util.TypedException
public void accept(VirtualFacet.Visitor visitor) throws com.exalead.util.TypedException
accept
in class VirtualFacet
com.exalead.util.TypedException
public void accept(Facet.Visitor visitor) throws com.exalead.util.TypedException
public void accept(FacetView.Visitor visitor) throws com.exalead.util.TypedException
public <T> T accept(VirtualFacet.Transformer<T> transformer, T[] t) throws com.exalead.util.TypedException
accept
in class VirtualFacet
com.exalead.util.TypedException
public <T> T accept(Facet.Transformer<T> transformer, T[] t) throws com.exalead.util.TypedException
public <T> T accept(FacetView.Transformer<T> transformer, T[] t) throws com.exalead.util.TypedException
Copyright © 2013 Dassault Systèmes, All Rights Reserved.