com.exalead.access.feedapi

Class MergedFacet

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

com.exalead.access.feedapi.MergedFacet

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<MergedCategory>, java.io.Serializable, java.lang.Cloneable, java.lang.Iterable<MergedCategory>

public class MergedFacet
extends AbstractCategory<MergedCategory>

See Also:

Serialized Form

Nested Class Summary

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

AbstractCategory.Field, AbstractCategory.FieldsHolder, 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 inherited from class com.exalead.access.feedapi.AbstractCategory

aggregations, count, DIMENSION_SWITCH, FIELDS, 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
MergedFacet(Facet facet)
MergedFacet(java.lang.String id, java.lang.String desc) Deprecated.
MergedFacet(java.lang.String id, java.lang.String path, java.lang.String desc)
MergedFacet(java.lang.String id, java.lang.String path, java.lang.String desc, java.lang.String data)

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)
java.lang.String	getName() Deprecated.
RefinementPolicy	getRefinementPolicy() Returns whether this facet is disjonctive or exclusive
FacetType	getType() Returns the type of the facet
boolean	isRefinable() Returns whether this category is refinable
static MergedFacet	mergeCategoryTree(java.lang.String root, ResultFeed... feeds) Merges Facets and Categories from several feeds into one category tree.
void	mergeComplete() Apply when done merging to free up some memory.
static MergedFacet	mergeNormalizedCategoryTree(java.lang.String root, ResultFeed... feeds) Deprecated.
void	mergeWith(Facet toProcess, java.lang.String feedId) Incorporate the Category tree of another facet into the one of self.
void	setRefinable(boolean refinable)
void	setRefinementPolicy(RefinementPolicy refinementPolicy)
void	setType(FacetType facetType)

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

addSourceFeed, clone, getAggregations, getCount, getFields, 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

collateTo, 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

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

MergedFacet

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

Deprecated.

MergedFacet

public MergedFacet(Facet facet)

MergedFacet

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

MergedFacet

public MergedFacet(java.lang.String id,
                   java.lang.String path,
                   java.lang.String desc,
                   java.lang.String data)

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

Returns:

setRefinable

public void setRefinable(boolean refinable)

getRefinementPolicy

public RefinementPolicy getRefinementPolicy()

Returns whether this facet is disjonctive or exclusive

Returns:

setRefinementPolicy

public void setRefinementPolicy(RefinementPolicy refinementPolicy)

getType

public FacetType getType()

Returns the type of the facet

Returns:

setType

public void setType(FacetType facetType)

mergeCategoryTree

public static MergedFacet mergeCategoryTree(java.lang.String root,
                                            ResultFeed... feeds)

Merges Facets and Categories from several feeds into one category tree. The merged categories will be stored in a MergedCategories container. If a facet named 'root' is not found in a specific feed, it is silently ignored.

Parameters:

root - name/path of facet to merge

feeds - with the facets

Returns:

Facet with composite tree or NULL if there was nothing to merge

mergeNormalizedCategoryTree

@Deprecated
public static MergedFacet mergeNormalizedCategoryTree(java.lang.String root,
                                                                  ResultFeed... feeds)

Deprecated.

Use mergeCategoryTree(root, feeds).

mergeComplete

public void mergeComplete()

Apply when done merging to free up some memory.

mergeWith

public void mergeWith(Facet toProcess,
                      java.lang.String feedId)

Incorporate the Category tree of another facet into the one of self.

Type Parameters:

Facet - toProcess the Facet to be assimilated

String - feedId the feed from which the toProcess facet is fetched.

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