com.exalead.access.feedapi

Class AbstractCategory<T extends AbstractCategory<T>>

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

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

Direct Known Subclasses:

Category, Facet, MergedCategory, MergedFacet

public abstract class AbstractCategory<T extends AbstractCategory<T>>
extends CategoryTreeContainer<T>
implements java.lang.Cloneable

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractCategory.Field
static class	AbstractCategory.FieldsHolder Store common attributes available for Category and Facet api objects
static class	AbstractCategory.State A category is always in one of the following three states

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 java.util.Map<java.lang.String,AggregationValue>	aggregations
protected long	count
static java.lang.String	DIMENSION_SWITCH
protected static AbstractCategory.FieldsHolder	FIELDS
protected long	score
protected AbstractCategory.State	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
AbstractCategory(java.lang.String id, java.lang.String path, java.lang.String description, long count, long score, AbstractCategory.State state, java.lang.String data) public AbstractCategory(String id, String path, String description, long count, long score, State state, String data) { this(id, path, description, count, score, state, data); }

Method Summary

Modifier and Type	Method and Description
void	addSourceFeed(java.lang.String feedKey) Add link to another source feed.
T	clone()
java.util.Map<java.lang.String,AggregationValue>	getAggregations() Returns a map of aggregated values for this Category
long	getCount() Returns the number of Entry in this category
com.exalead.access.feedapi.eval.mel.extension.AbstractMELType.FieldsHolder	getFields()
long	getScore() Returns the score of this category
java.util.HashSet<java.lang.String>	getSourceFeeds() Get the list of feeds to which this category belongs (the feeds from which all of the information in this category was merged)
AbstractCategory.State	getState() Returns the state of the Category (eg: displayed, refined, excluded)
abstract boolean	isRefinable()
void	setAggregations(java.util.Map<java.lang.String,AggregationValue> aggregations)
void	setCount(long count)
void	setScore(long score)
void	setState(AbstractCategory.State state)

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

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

Field Detail

DIMENSION_SWITCH

public static final java.lang.String DIMENSION_SWITCH

See Also:

Constant Field Values

FIELDS

protected static final AbstractCategory.FieldsHolder FIELDS

count

protected long count

score

protected long score

state

protected AbstractCategory.State state

aggregations

protected java.util.Map<java.lang.String,AggregationValue> aggregations

Constructor Detail

AbstractCategory

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

public AbstractCategory(String id, String path, String description, long count, long score, State state, String data) { this(id, path, description, count, score, state, data); }

Method Detail

isRefinable

public abstract boolean isRefinable()

getCount

public final long getCount()

Returns the number of Entry in this category

Returns:

the number of Entry in this category

setCount

public void setCount(long count)

getScore

public final long getScore()

Returns the score of this category

Returns:

the score of this category

setScore

public void setScore(long score)

getState

public final AbstractCategory.State getState()

Returns the state of the Category (eg: displayed, refined, excluded)

Returns:

the state of the Category

setState

public void setState(AbstractCategory.State state)

getAggregations

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

Returns a map of aggregated values for this Category

Returns:

setAggregations

public void setAggregations(java.util.Map<java.lang.String,AggregationValue> aggregations)

addSourceFeed

public void addSourceFeed(java.lang.String feedKey)

Add link to another source feed.

Parameters:

feedKey -

getSourceFeeds

public java.util.HashSet<java.lang.String> getSourceFeeds()

Get the list of feeds to which this category belongs (the feeds from which all of the information in this category was merged)

Returns:

HashSet list of feed id's

clone

public T clone()

Overrides:

clone in class CategoryTreeContainer<T extends AbstractCategory<T>>

getFields

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

Overrides:

getFields in class CategoryTreeContainer<T extends AbstractCategory<T>>