com.exalead.access.feedapi

Class FacetsContainer

java.lang.Object

com.exalead.access.feedapi.utils.AccessLogLevelConfiguration

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

com.exalead.access.feedapi.FacetsContainer

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<Facet>, HasFacets, java.io.Serializable, java.lang.Cloneable

Direct Known Subclasses:

Entry, ResultFeed

public abstract class FacetsContainer
extends com.exalead.access.feedapi.eval.mel.extension.AbstractMELType
implements HasFacets, java.lang.Cloneable, com.exalead.access.feedapi.eval.mel.extension.types.MELStore<Facet>, java.io.Serializable

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FacetsContainer.Field
static class	FacetsContainer.FieldsHolder

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 inherited from class com.exalead.access.feedapi.eval.mel.extension.AbstractMELType

flags

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	FacetsContainer()

Method Summary

Modifier and Type	Method and Description
void	addFacet(Facet facet) Helper which add a Facet to the ResultFeed.
java.util.Iterator<Category>	categoryIterator(java.lang.String root, CategoryTreeContainer.IterationMode mode) Get a Category Iterator for the provided Category Root, using the provided IterationMode.
java.util.Iterator<Category>	categoryIterator(java.lang.String root, CategoryTreeContainer.IterationMode iterMode, CategoryTreeContainer.SortMode sortMode) Get a Category Iterator for the provided Category Root, using the provided IterationMode and sorted by the specified sortMode.
java.lang.Object	clone()
Facet	getAssociatedValue(com.exalead.access.feedapi.eval.mel.extension.MELType key)
Facet	getFacet(java.lang.String facetId) Get facet with name 'facetId'.
java.util.List<Facet>	getFacets() Returns a list of Facets.
java.util.Map<java.lang.String,Facet>	getFacetsMap() Get this container's facets in a Map of ID => Facet.
com.exalead.access.feedapi.eval.mel.extension.AbstractMELType.FieldsHolder	getFields()
Facet	getNormalizedFacet(java.lang.String facetId) Deprecated.
boolean	hasFacet(java.lang.String facetId) Returns true if facet 'facetId' exists in feed.
boolean	hasNormalizedFacet(java.lang.String facetId) Deprecated.

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

accept, collateTo, getFlags, rawStringValue, 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

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

Constructor Detail

FacetsContainer

protected FacetsContainer()

Method Detail

getFacets

public java.util.List<Facet> getFacets()

Returns a list of Facets.

Specified by:

getFacets in interface HasFacets

Returns:

a List of Facets

hasFacet

public boolean hasFacet(java.lang.String facetId)

Returns true if facet 'facetId' exists in feed.

Specified by:

hasFacet in interface HasFacets

Parameters:

facetId - ID of the facet

Returns:

true/false

getFacet

public Facet getFacet(java.lang.String facetId)

Get facet with name 'facetId'.

Specified by:

getFacet in interface HasFacets

Parameters:

facetId -

Returns:

a Facet

getFacetsMap

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

Get this container's facets in a Map of ID => Facet.

Returns:

a Map of ID => Facet

hasNormalizedFacet

@Deprecated
public boolean hasNormalizedFacet(java.lang.String facetId)

Deprecated.

Use hasFacet(facetId).

getNormalizedFacet

@Deprecated
public Facet getNormalizedFacet(java.lang.String facetId)

Deprecated.

Use getFacet(facetId).

addFacet

public void addFacet(Facet facet)

Helper which add a Facet to the ResultFeed.

Specified by:

addFacet in interface HasFacets

Parameters:

facet -

categoryIterator

public java.util.Iterator<Category> categoryIterator(java.lang.String root,
                                                     CategoryTreeContainer.IterationMode mode)

Get a Category Iterator for the provided Category Root, using the provided IterationMode.

Parameters:

root -

mode -

Returns:

categoryIterator

public java.util.Iterator<Category> categoryIterator(java.lang.String root,
                                                     CategoryTreeContainer.IterationMode iterMode,
                                                     CategoryTreeContainer.SortMode sortMode)

Get a Category Iterator for the provided Category Root, using the provided IterationMode and sorted by the specified sortMode.

Parameters:

root -

iterMode -

sortMode -

Returns:

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Overrides:

clone in class java.lang.Object

Throws:

java.lang.CloneNotSupportedException

getFields

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

Specified by:

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

getAssociatedValue

public Facet getAssociatedValue(com.exalead.access.feedapi.eval.mel.extension.MELType key)

Specified by:

getAssociatedValue in interface com.exalead.access.feedapi.eval.mel.extension.types.MELStore<Facet>