com.exalead.access.feedapi

Class Category

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.Category

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<Category>, java.lang.Iterable<Category>

Direct Known Subclasses:

Category2D

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

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

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 static Category.FieldsHolder	FIELDS

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
Category(Facet facet, java.lang.String id, java.lang.String path, java.lang.String description, int count, long score, AbstractCategory.State state)
Category(Facet facet, java.lang.String id, java.lang.String path, java.lang.String description, int count, long score, AbstractCategory.State state, java.lang.String data)
Category(Facet facet, java.lang.String id, java.lang.String path, java.lang.String description, int count, long score, AbstractCategory.State state, java.lang.String data, long nbClippedChildren)
Category(Facet facet, java.lang.String id, java.lang.String path, java.lang.String description, long count, long score, AbstractCategory.State state)
Category(Facet facet, java.lang.String id, java.lang.String path, java.lang.String description, long count, long score, AbstractCategory.State state, java.lang.String data)
Category(Facet facet, java.lang.String id, java.lang.String path, java.lang.String description, long count, long score, AbstractCategory.State state, java.lang.String data, long nbClippedChildren)
Category(java.lang.String id, java.lang.String path, java.lang.String description, int count, long score, AbstractCategory.State state) Deprecated. facet is now mandatory
Category(java.lang.String id, java.lang.String path, java.lang.String description, int count, long score, java.lang.String state) Deprecated. facet is now mandatory

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(Category rgt) Comparison based on id
boolean	equals(java.lang.Object anObject)
Facet	getFacet() Returns the parent facet
com.exalead.access.feedapi.eval.mel.extension.AbstractMELType.FieldsHolder	getFields()
long	getNbClippedChildren() Returns the number of clipped children categories in this category
int	hashCode()
boolean	isRefinable()
void	setNbClippedChildren(long nbClippedChildren)

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

FIELDS

protected static final Category.FieldsHolder FIELDS

Constructor Detail

Category

@Deprecated
public Category(java.lang.String id,
                            java.lang.String path,
                            java.lang.String description,
                            int count,
                            long score,
                            java.lang.String state)

Deprecated. facet is now mandatory

Parameters:

id -

path -

description -

count -

score -

state -

Category

@Deprecated
public Category(java.lang.String id,
                            java.lang.String path,
                            java.lang.String description,
                            int count,
                            long score,
                            AbstractCategory.State state)

Deprecated. facet is now mandatory

Parameters:

id -

path -

description -

count -

score -

state -

data -

Category

public Category(Facet facet,
                java.lang.String id,
                java.lang.String path,
                java.lang.String description,
                int count,
                long score,
                AbstractCategory.State state,
                java.lang.String data,
                long nbClippedChildren)

Category

public Category(Facet facet,
                java.lang.String id,
                java.lang.String path,
                java.lang.String description,
                int count,
                long score,
                AbstractCategory.State state)

Category

public Category(Facet facet,
                java.lang.String id,
                java.lang.String path,
                java.lang.String description,
                int count,
                long score,
                AbstractCategory.State state,
                java.lang.String data)

Category

public Category(Facet facet,
                java.lang.String id,
                java.lang.String path,
                java.lang.String description,
                long count,
                long score,
                AbstractCategory.State state,
                java.lang.String data,
                long nbClippedChildren)

Category

public Category(Facet facet,
                java.lang.String id,
                java.lang.String path,
                java.lang.String description,
                long count,
                long score,
                AbstractCategory.State state)

Category

public Category(Facet facet,
                java.lang.String id,
                java.lang.String path,
                java.lang.String description,
                long count,
                long score,
                AbstractCategory.State state,
                java.lang.String data)

Method Detail

getNbClippedChildren

public final long getNbClippedChildren()

Returns the number of clipped children categories in this category

Returns:

the number of clipped children category

setNbClippedChildren

public void setNbClippedChildren(long nbClippedChildren)

getFacet

public Facet getFacet()

Returns the parent facet

Returns:

isRefinable

public final boolean isRefinable()

Specified by:

isRefinable in class AbstractCategory<Category>

compareTo

public int compareTo(Category rgt)

Comparison based on id

Specified by:

compareTo in interface java.lang.Comparable<Category>

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

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

getFields

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

Description copied from class: AbstractCategory

Overrides:

getFields in class AbstractCategory<Category>