com.exalead.mercury.mami.search.v20

Class FacetDesc

java.lang.Object

com.exalead.mercury.mami.search.v20.FacetDesc

All Implemented Interfaces:

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

public class FacetDesc
extends java.lang.Object
implements com.exalead.util.Checkable, java.io.Serializable

No documentation for this element.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
java.util.List<com.exalead.search.v30.AggregationFunction>	aggregationFunction
java.lang.String	dataModelClass
java.lang.String	dataModelProperty
static int	DEFAULT_DIMENSIONS
static boolean	DEFAULT_REFINABLE
static boolean	DEFAULT_TREE_REPRESENTATION
int	dimensions
java.lang.String	id
java.lang.String	referencesFacets
boolean	refinable
java.lang.String	refinementPolicy
boolean	treeRepresentation
java.lang.String	type
java.lang.String	virtualRoot

Constructor Summary

Constructors

Constructor and Description
FacetDesc()
FacetDesc(FacetDesc o) Copy constructor

Method Summary

Modifier and Type	Method and Description
void	check(boolean deep, java.lang.String errorContext) Checks this FacetDesc.
static FacetDesc	fromString(java.lang.String s) String representation of this FacetDesc.
java.util.List<com.exalead.search.v30.AggregationFunction>	getAggregationFunction()
java.lang.String	getDataModelClass() If this facet is defined by a data model, the class in which it's valid.
java.lang.String	getDataModelProperty() If this facet is defined by a data model, the class property in which it's valid.
int	getDimensions() Number of dimensions in this facet
java.lang.String	getId()
java.lang.String	getReferencesFacets() List of facets that this facet references
java.lang.String	getRefinementPolicy()
java.lang.String	getType() One of "category", "numerical" or "matrix"
java.lang.String	getVirtualRoot() Virtual root path of the facet.
boolean	isRefinable() Is the facet refinable?
boolean	isTreeRepresentation() Has the facet a tree representation?
FacetDesc	makeCopy() Creates and returns a deep copy of this FacetDesc.
static FacetDesc	readFrom(java.io.InputStream is) Read this FacetDesc from an XML fragment.
void	setDataModelClass(java.lang.String dataModelClass) If this facet is defined by a data model, the class in which it's valid.
void	setDataModelProperty(java.lang.String dataModelProperty) If this facet is defined by a data model, the class property in which it's valid.
void	setDimensions(int dimensions) Number of dimensions in this facet
void	setId(java.lang.String id)
void	setReferencesFacets(java.lang.String referencesFacets) List of facets that this facet references
void	setRefinable(boolean refinable) Is the facet refinable?
void	setRefinementPolicy(java.lang.String refinementPolicy)
void	setTreeRepresentation(boolean treeRepresentation) Has the facet a tree representation?
void	setType(java.lang.String type) One of "category", "numerical" or "matrix"
void	setVirtualRoot(java.lang.String virtualRoot) Virtual root path of the facet.
java.lang.String	toString() String representation of this FacetDesc.
FacetDesc	withAggregationFunction(com.exalead.search.v30.AggregationFunction... __values)
FacetDesc	withAggregationFunction(java.util.Collection<com.exalead.search.v30.AggregationFunction> __values)
FacetDesc	withDataModelClass(java.lang.String dataModelClass)
FacetDesc	withDataModelProperty(java.lang.String dataModelProperty)
FacetDesc	withDimensions(int dimensions)
FacetDesc	withDimensions(java.lang.Integer dimensions)
FacetDesc	withId(java.lang.String id)
FacetDesc	withReferencesFacets(java.lang.String referencesFacets)
FacetDesc	withRefinable(boolean refinable)
FacetDesc	withRefinable(java.lang.Boolean refinable)
FacetDesc	withRefinementPolicy(java.lang.String refinementPolicy)
FacetDesc	withTreeRepresentation(boolean treeRepresentation)
FacetDesc	withTreeRepresentation(java.lang.Boolean treeRepresentation)
FacetDesc	withType(java.lang.String type)
FacetDesc	withVirtualRoot(java.lang.String virtualRoot)
void	writeTo(java.io.OutputStream os) Write this FacetDesc as an XML fragment

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

id

public java.lang.String id

virtualRoot

public java.lang.String virtualRoot

dataModelClass

public java.lang.String dataModelClass

dataModelProperty

public java.lang.String dataModelProperty

type

public java.lang.String type

aggregationFunction

public java.util.List<com.exalead.search.v30.AggregationFunction> aggregationFunction

refinable

public boolean refinable

DEFAULT_REFINABLE

public static final boolean DEFAULT_REFINABLE

See Also:

Constant Field Values

treeRepresentation

public boolean treeRepresentation

DEFAULT_TREE_REPRESENTATION

public static final boolean DEFAULT_TREE_REPRESENTATION

See Also:

Constant Field Values

refinementPolicy

public java.lang.String refinementPolicy

dimensions

public int dimensions

DEFAULT_DIMENSIONS

public static final int DEFAULT_DIMENSIONS

See Also:

Constant Field Values

referencesFacets

public java.lang.String referencesFacets

Constructor Detail

FacetDesc

public FacetDesc()

FacetDesc

public FacetDesc(FacetDesc o)

Copy constructor

Method Detail

setId

public void setId(java.lang.String id)

getId

public java.lang.String getId()

withId

public FacetDesc withId(java.lang.String id)

setVirtualRoot

public void setVirtualRoot(java.lang.String virtualRoot)

Virtual root path of the facet. Note that this is irrelevant for matrix facets.
You should not use this to identify a facet. Rely on the id.

getVirtualRoot

public java.lang.String getVirtualRoot()

Virtual root path of the facet. Note that this is irrelevant for matrix facets.
You should not use this to identify a facet. Rely on the id.

withVirtualRoot

public FacetDesc withVirtualRoot(java.lang.String virtualRoot)

setDataModelClass

public void setDataModelClass(java.lang.String dataModelClass)

If this facet is defined by a data model, the class in which it's valid.

getDataModelClass

public java.lang.String getDataModelClass()

If this facet is defined by a data model, the class in which it's valid.

withDataModelClass

public FacetDesc withDataModelClass(java.lang.String dataModelClass)

setDataModelProperty

public void setDataModelProperty(java.lang.String dataModelProperty)

If this facet is defined by a data model, the class property in which it's valid.

getDataModelProperty

public java.lang.String getDataModelProperty()

If this facet is defined by a data model, the class property in which it's valid.

withDataModelProperty

public FacetDesc withDataModelProperty(java.lang.String dataModelProperty)

setType

public void setType(java.lang.String type)

One of "category", "numerical" or "matrix"

getType

public java.lang.String getType()

One of "category", "numerical" or "matrix"

withType

public FacetDesc withType(java.lang.String type)

getAggregationFunction

public java.util.List<com.exalead.search.v30.AggregationFunction> getAggregationFunction()

withAggregationFunction

public FacetDesc withAggregationFunction(com.exalead.search.v30.AggregationFunction... __values)

withAggregationFunction

public FacetDesc withAggregationFunction(java.util.Collection<com.exalead.search.v30.AggregationFunction> __values)

setRefinable

public void setRefinable(boolean refinable)

Is the facet refinable?

isRefinable

public boolean isRefinable()

Is the facet refinable?

withRefinable

public FacetDesc withRefinable(boolean refinable)

withRefinable

public FacetDesc withRefinable(java.lang.Boolean refinable)

setTreeRepresentation

public void setTreeRepresentation(boolean treeRepresentation)

Has the facet a tree representation?

isTreeRepresentation

public boolean isTreeRepresentation()

Has the facet a tree representation?

withTreeRepresentation

public FacetDesc withTreeRepresentation(boolean treeRepresentation)

withTreeRepresentation

public FacetDesc withTreeRepresentation(java.lang.Boolean treeRepresentation)

setRefinementPolicy

public void setRefinementPolicy(java.lang.String refinementPolicy)

getRefinementPolicy

public java.lang.String getRefinementPolicy()

withRefinementPolicy

public FacetDesc withRefinementPolicy(java.lang.String refinementPolicy)

setDimensions

public void setDimensions(int dimensions)

Number of dimensions in this facet

getDimensions

public int getDimensions()

Number of dimensions in this facet

withDimensions

public FacetDesc withDimensions(int dimensions)

withDimensions

public FacetDesc withDimensions(java.lang.Integer dimensions)

setReferencesFacets

public void setReferencesFacets(java.lang.String referencesFacets)

List of facets that this facet references

getReferencesFacets

public java.lang.String getReferencesFacets()

List of facets that this facet references

withReferencesFacets

public FacetDesc withReferencesFacets(java.lang.String referencesFacets)

makeCopy

public FacetDesc makeCopy()

Creates and returns a deep copy of this FacetDesc.

readFrom

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

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

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this FacetDesc.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this FacetDesc.

Overrides:

toString in class java.lang.Object

check

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

Checks this FacetDesc.

Specified by:

check in interface com.exalead.util.Checkable

Throws:

com.exalead.util.TypedException