com.exalead.search.v30

Class ConcatValueFacet

java.lang.Object

com.exalead.search.v30.FacetView

com.exalead.search.v30.Facet

com.exalead.search.v30.VirtualFacet

com.exalead.search.v30.ConcatValueFacet

All Implemented Interfaces:

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

public class ConcatValueFacet
extends VirtualFacet
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.VirtualFacet

VirtualFacet.Transformer<T>, 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
static int	DEFAULT_HITS_MAX_CATEGORIES
java.lang.String	fieldA
java.lang.String	fieldB
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
ConcatValueFacet()
ConcatValueFacet(ConcatValueFacet o) Copy constructor
ConcatValueFacet(java.lang.String id, java.lang.String virtualRoot, java.lang.String fieldA, java.lang.String fieldB)

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

fieldA

public java.lang.String fieldA

fieldB

public java.lang.String fieldB

hitsMaxCategories

public int hitsMaxCategories

DEFAULT_HITS_MAX_CATEGORIES

public static final int DEFAULT_HITS_MAX_CATEGORIES

See Also:

Constant Field Values

Constructor Detail

ConcatValueFacet

public ConcatValueFacet()

ConcatValueFacet

public ConcatValueFacet(java.lang.String id,
                        java.lang.String virtualRoot,
                        java.lang.String fieldA,
                        java.lang.String fieldB)

ConcatValueFacet

public ConcatValueFacet(ConcatValueFacet o)

Copy constructor

Method Detail

withVirtualRoot

public ConcatValueFacet withVirtualRoot(java.lang.String virtualRoot)

Overrides:

withVirtualRoot in class VirtualFacet

withId

public ConcatValueFacet withId(java.lang.String id)

Overrides:

withId in class VirtualFacet

withType

public ConcatValueFacet withType(java.lang.String type)

Overrides:

withType in class VirtualFacet

withIndex

public ConcatValueFacet withIndex(int index)

Overrides:

withIndex in class VirtualFacet

withIndex

public ConcatValueFacet withIndex(java.lang.Integer index)

Overrides:

withIndex in class VirtualFacet

withRefinementPolicy

public ConcatValueFacet withRefinementPolicy(java.lang.String refinementPolicy)

Overrides:

withRefinementPolicy in class VirtualFacet

withImplementation

public ConcatValueFacet withImplementation(java.lang.String implementation)

Overrides:

withImplementation in class VirtualFacet

withDataModelState

public ConcatValueFacet withDataModelState(java.lang.String dataModelState)

Overrides:

withDataModelState in class VirtualFacet

withFromDataModel

public ConcatValueFacet withFromDataModel(Facet fromDataModel)

Overrides:

withFromDataModel in class VirtualFacet

withDataModelClass

public ConcatValueFacet withDataModelClass(java.lang.String dataModelClass)

Overrides:

withDataModelClass in class VirtualFacet

withDataModelProperty

public ConcatValueFacet withDataModelProperty(java.lang.String dataModelProperty)

Overrides:

withDataModelProperty in class VirtualFacet

withInNavigation

public ConcatValueFacet withInNavigation(boolean inNavigation)

Overrides:

withInNavigation in class VirtualFacet

withInNavigation

public ConcatValueFacet withInNavigation(java.lang.Boolean inNavigation)

Overrides:

withInNavigation in class VirtualFacet

withInHits

public ConcatValueFacet withInHits(boolean inHits)

Overrides:

withInHits in class VirtualFacet

withInHits

public ConcatValueFacet withInHits(java.lang.Boolean inHits)

Overrides:

withInHits in class VirtualFacet

withAggregationFunction

public ConcatValueFacet withAggregationFunction(AggregationFunction... __values)

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

Overrides:

withAggregationFunction in class VirtualFacet

withAggregationFunction

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

Overrides:

withAggregationFunction in class VirtualFacet

withAdditionalFacetView

public ConcatValueFacet withAdditionalFacetView(AdditionalFacetView... __values)

Overrides:

withAdditionalFacetView in class VirtualFacet

withAdditionalFacetView

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

Overrides:

withAdditionalFacetView in class VirtualFacet

withMaxSliceCategories

public ConcatValueFacet withMaxSliceCategories(int maxSliceCategories)

Overrides:

withMaxSliceCategories in class VirtualFacet

withMaxSliceCategories

public ConcatValueFacet withMaxSliceCategories(java.lang.Integer maxSliceCategories)

Overrides:

withMaxSliceCategories in class VirtualFacet

withMinDocsPerCategory

public ConcatValueFacet withMinDocsPerCategory(int minDocsPerCategory)

Overrides:

withMinDocsPerCategory in class VirtualFacet

withMinDocsPerCategory

public ConcatValueFacet withMinDocsPerCategory(java.lang.Integer minDocsPerCategory)

Overrides:

withMinDocsPerCategory in class VirtualFacet

withMaxCategories

public ConcatValueFacet withMaxCategories(int maxCategories)

Overrides:

withMaxCategories in class VirtualFacet

withMaxCategories

public ConcatValueFacet withMaxCategories(java.lang.Integer maxCategories)

Overrides:

withMaxCategories in class VirtualFacet

withMaxCategoriesPerLevel

public ConcatValueFacet withMaxCategoriesPerLevel(int maxCategoriesPerLevel)

Overrides:

withMaxCategoriesPerLevel in class VirtualFacet

withMaxCategoriesPerLevel

public ConcatValueFacet withMaxCategoriesPerLevel(java.lang.Integer maxCategoriesPerLevel)

Overrides:

withMaxCategoriesPerLevel in class VirtualFacet

withSortFunction

public ConcatValueFacet withSortFunction(java.lang.String sortFunction)

Overrides:

withSortFunction in class VirtualFacet

withSortAggregationFunction

public ConcatValueFacet withSortAggregationFunction(java.lang.String sortAggregationFunction)

Overrides:

withSortAggregationFunction in class VirtualFacet

withExplicitSortOrderValues

public ConcatValueFacet withExplicitSortOrderValues(java.lang.String explicitSortOrderValues)

Overrides:

withExplicitSortOrderValues in class VirtualFacet

withReverse

public ConcatValueFacet withReverse(boolean reverse)

Overrides:

withReverse in class VirtualFacet

withReverse

public ConcatValueFacet withReverse(java.lang.Boolean reverse)

Overrides:

withReverse in class VirtualFacet

withAggregateScores

@Deprecated
public ConcatValueFacet withAggregateScores(boolean aggregateScores)

Deprecated.

Overrides:

withAggregateScores in class VirtualFacet

withAggregateScores

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

Deprecated.

Overrides:

withAggregateScores in class VirtualFacet

setFieldA

public void setFieldA(java.lang.String fieldA)

The Value field on which to perform the synthesis.

getFieldA

public java.lang.String getFieldA()

The Value field on which to perform the synthesis.

withFieldA

public ConcatValueFacet withFieldA(java.lang.String fieldA)

setFieldB

public void setFieldB(java.lang.String fieldB)

The Value field on which to perform the synthesis.

getFieldB

public java.lang.String getFieldB()

The Value field on which to perform the synthesis.

withFieldB

public ConcatValueFacet withFieldB(java.lang.String fieldB)

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 ConcatValueFacet withHitsMaxCategories(int hitsMaxCategories)

withHitsMaxCategories

public ConcatValueFacet withHitsMaxCategories(java.lang.Integer hitsMaxCategories)

makeCopy

public ConcatValueFacet makeCopy()

Creates and returns a deep copy of this ConcatValueFacet.

Overrides:

makeCopy in class VirtualFacet

readFrom

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

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

Overrides:

writeTo in class VirtualFacet

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this ConcatValueFacet.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this ConcatValueFacet.

Overrides:

toString in class VirtualFacet

check

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

Checks this ConcatValueFacet.

Specified by:

check in interface com.exalead.util.Checkable

Overrides:

check in class VirtualFacet

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