com.exalead.access.feedapi

Class Facet

java.lang.Object

com.exalead.access.feedapi.utils.AccessLogLevelConfiguration

com.exalead.access.feedapi.eval.mel.extension.AbstractMELType

com.exalead.access.feedapi.CategoryTreeContainer<T>

com.exalead.access.feedapi.AbstractCategory<Category>

com.exalead.access.feedapi.Facet

All Implemented Interfaces:

com.exalead.access.feedapi.eval.mel.extension.HasMELFlags, com.exalead.access.feedapi.eval.mel.extension.MELType, com.exalead.access.feedapi.eval.mel.extension.MELTypeVisitor<com.exalead.access.feedapi.eval.mel.extension.MELType,com.exalead.access.feedapi.eval.mel.extension.MELType.ArithmeticOperation>, com.exalead.access.feedapi.eval.mel.extension.types.MELCollatable<com.exalead.access.feedapi.eval.mel.extension.MELType>, com.exalead.access.feedapi.eval.mel.extension.types.MELStore<Category>, java.io.Serializable, java.lang.Cloneable, java.lang.Comparable<Facet>, java.lang.Iterable<Category>

public class Facet
extends AbstractCategory<Category>
implements java.lang.Comparable<Facet>, java.io.Serializable

A facet (also called refine) has a name, a path, a description and contains all sub-categories

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Facet.Field
static class	Facet.FieldsHolder Extends the parent FieldsHoder static class to add the specific attributes only for Facet

Nested classes/interfaces inherited from class com.exalead.access.feedapi.AbstractCategory

AbstractCategory.State

Nested classes/interfaces inherited from class com.exalead.access.feedapi.CategoryTreeContainer

CategoryTreeContainer.AggregationSortModeASC, CategoryTreeContainer.AggregationSortModeDESC, CategoryTreeContainer.IterationMode, CategoryTreeContainer.SortMode

Nested classes/interfaces inherited from interface com.exalead.access.feedapi.eval.mel.extension.MELType

com.exalead.access.feedapi.eval.mel.extension.MELType.ArithmeticOperation, com.exalead.access.feedapi.eval.mel.extension.MELType.AttributePointer<P>

Field Summary

Fields

Modifier and Type	Field and Description
protected long	nbClippedCategories
protected java.util.List<java.lang.String>	subFacets
protected long	totalClippedCategories

Fields inherited from class com.exalead.access.feedapi.AbstractCategory

aggregations, count, DIMENSION_SWITCH, score, state

Fields inherited from class com.exalead.access.feedapi.CategoryTreeContainer

categories, data, description, id, path

Fields inherited from class com.exalead.access.feedapi.eval.mel.extension.AbstractMELType

flags

Constructor Summary

Constructors

Constructor and Description
Facet(java.lang.String id, java.lang.String desc) Deprecated.
Facet(java.lang.String id, java.lang.String path, java.lang.String desc)
Facet(java.lang.String id, java.lang.String path, java.lang.String desc, long nbClippedCategories, long totalClippedCategories)
Facet(java.lang.String id, java.lang.String path, java.lang.String desc, java.lang.String data, long nbClippedCategories, long totalClippedCategories)
Facet(java.lang.String id, java.lang.String path, java.lang.String desc, java.lang.String data, long nbClippedCategories, long totalClippedCategories, java.util.List<java.lang.String> subFacets)

Method Summary

Modifier and Type	Method and Description
<R,P> R	accept(com.exalead.access.feedapi.eval.mel.extension.MELTypeVisitor<R,P> visitor, P p)
int	collateTo(com.exalead.access.feedapi.eval.mel.extension.MELType t) MEL comparison based on id.
int	compareTo(Facet rgt) Comparison based on facet id
boolean	equals(java.lang.Object anObject)
com.exalead.access.feedapi.eval.mel.extension.AbstractMELType.FieldsHolder	getFields()
java.util.Map<java.lang.String,java.lang.String>	getInfos()
java.lang.String	getName() Deprecated.
long	getNbClippedCategories() Returns the number of clipped children categories in this facet
RefinementPolicy	getRefinementPolicy() Returns whether this facet is disjunctive or exclusive
java.lang.String	getRefinementPolicyAsString()
java.util.List<java.lang.String>	getSubFacets() Returns the list of sub facets that have built this facet Related to multi dimensions facets
java.lang.String	getSubFacetsAsString()
long	getTotalClippedCategories() Returns the number of total clipped categories in this facet
FacetType	getType() Returns the type of the facet
java.lang.String	getTypeAsString()
int	hashCode()
boolean	isRefinable() Returns whether this category is refinable
void	setNbClippedCategories(long nbClippedCategories)
void	setRefinable(boolean refinable)
void	setRefinementPolicy(RefinementPolicy refinementPolicy)
void	setRefinementPolicyAsString(java.lang.String refinementPolicyAsString)
void	setSubFacets(java.util.List<java.lang.String> subFacets)
void	setTotalClippedCategories(long totalClippedCategories)
void	setType(FacetType facetType)
void	setTypeAsString(java.lang.String typeAsString)

Methods inherited from class com.exalead.access.feedapi.AbstractCategory

addSourceFeed, clone, getAggregations, getCount, getScore, getSourceFeeds, getState, setAggregations, setCount, setScore, setState

Methods inherited from class com.exalead.access.feedapi.CategoryTreeContainer

addAllCategories, addCategory, clearCategories, getAssociatedValue, getCategories, getCategories, getData, getDeepestRefinedTreeContainer, getDescription, getId, getPath, getRefinedCategories, getRefinedCategories, getRefinedCategories, iterator, iterator, iterator, rawStringValue, setData, setDescription, setId, setPath

Methods inherited from class com.exalead.access.feedapi.eval.mel.extension.AbstractMELType

getFlags, resolveField, resolveOperation, setFlags, stringValue, stringValue, visit, visitBoolean, visitCategory, visitCategory, visitFacet, visitFacet, visitFeed, visitList, visitMeta, visitNumber, visitString, visitUnknown

Methods inherited from class com.exalead.access.feedapi.utils.AccessLogLevelConfiguration

toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

nbClippedCategories

protected long nbClippedCategories

totalClippedCategories

protected long totalClippedCategories

subFacets

protected java.util.List<java.lang.String> subFacets

Constructor Detail

Facet

@Deprecated
public Facet(java.lang.String id,
                         java.lang.String desc)

Deprecated.

Facet

public Facet(java.lang.String id,
             java.lang.String path,
             java.lang.String desc)

Facet

public Facet(java.lang.String id,
             java.lang.String path,
             java.lang.String desc,
             long nbClippedCategories,
             long totalClippedCategories)

Facet

public Facet(java.lang.String id,
             java.lang.String path,
             java.lang.String desc,
             java.lang.String data,
             long nbClippedCategories,
             long totalClippedCategories)

Facet

public Facet(java.lang.String id,
             java.lang.String path,
             java.lang.String desc,
             java.lang.String data,
             long nbClippedCategories,
             long totalClippedCategories,
             java.util.List<java.lang.String> subFacets)

Method Detail

getName

@Deprecated
public java.lang.String getName()

Deprecated.

Kept to not break the world. Alias of getId

Returns:

isRefinable

public final boolean isRefinable()

Returns whether this category is refinable

Specified by:

isRefinable in class AbstractCategory<Category>

Returns:

setRefinable

public void setRefinable(boolean refinable)

getRefinementPolicy

public RefinementPolicy getRefinementPolicy()

Returns whether this facet is disjunctive or exclusive

Returns:

setRefinementPolicy

public void setRefinementPolicy(RefinementPolicy refinementPolicy)

getRefinementPolicyAsString

public java.lang.String getRefinementPolicyAsString()

setRefinementPolicyAsString

public void setRefinementPolicyAsString(java.lang.String refinementPolicyAsString)

getType

public FacetType getType()

Returns the type of the facet

Returns:

setType

public void setType(FacetType facetType)

getTypeAsString

public java.lang.String getTypeAsString()

setTypeAsString

public void setTypeAsString(java.lang.String typeAsString)

getTotalClippedCategories

public final long getTotalClippedCategories()

Returns the number of total clipped categories in this facet

Returns:

the number of total clipped categories

setTotalClippedCategories

public void setTotalClippedCategories(long totalClippedCategories)

getNbClippedCategories

public final long getNbClippedCategories()

Returns the number of clipped children categories in this facet

Returns:

the number of clipped categories

setNbClippedCategories

public void setNbClippedCategories(long nbClippedCategories)

getSubFacets

public final java.util.List<java.lang.String> getSubFacets()

Returns the list of sub facets that have built this facet Related to multi dimensions facets

Returns:

the list of sub facets ids

getSubFacetsAsString

public final java.lang.String getSubFacetsAsString()

setSubFacets

public void setSubFacets(java.util.List<java.lang.String> subFacets)

getInfos

public java.util.Map<java.lang.String,java.lang.String> getInfos()

compareTo

public int compareTo(Facet rgt)

Comparison based on facet id

Specified by:

compareTo in interface java.lang.Comparable<Facet>

collateTo

public int collateTo(com.exalead.access.feedapi.eval.mel.extension.MELType t)

MEL comparison based on id.

Specified by:

collateTo in interface com.exalead.access.feedapi.eval.mel.extension.types.MELCollatable<com.exalead.access.feedapi.eval.mel.extension.MELType>

Overrides:

collateTo in class com.exalead.access.feedapi.eval.mel.extension.AbstractMELType

equals

public boolean equals(java.lang.Object anObject)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

getFields

public com.exalead.access.feedapi.eval.mel.extension.AbstractMELType.FieldsHolder getFields()

Overrides:

getFields in class AbstractCategory<Category>

accept

public <R,P> R accept(com.exalead.access.feedapi.eval.mel.extension.MELTypeVisitor<R,P> visitor,
                      P p)

Specified by:

accept in interface com.exalead.access.feedapi.eval.mel.extension.MELType

Overrides:

accept in class com.exalead.access.feedapi.eval.mel.extension.AbstractMELType