com.exalead.access.feedapi

Class CategoryTreeContainer<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>

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

Direct Known Subclasses:

AbstractCategory

public abstract class CategoryTreeContainer<T extends AbstractCategory<T>>
extends com.exalead.access.feedapi.eval.mel.extension.AbstractMELType
implements java.lang.Iterable<T>, java.io.Serializable, com.exalead.access.feedapi.eval.mel.extension.types.MELStore<T>

Represents a node in the category tree.

Author:

blindfor

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CategoryTreeContainer.AggregationSortModeASC
static class	CategoryTreeContainer.AggregationSortModeDESC
static class	CategoryTreeContainer.Field
static class	CategoryTreeContainer.FieldsHolder
static class	CategoryTreeContainer.IterationMode Controls what kind of iterator is returned by getCategoryIterator() TODO(blindfor): Move logic from iterator(x,y) into here to make more extensible
static class	CategoryTreeContainer.SortMode Defines in which order getCategories(SortMode) returns its results

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.List<T>	categories
protected java.lang.String	data
protected java.lang.String	description
protected static CategoryTreeContainer.FieldsHolder	FIELDS
protected java.lang.String	id
protected java.lang.String	path

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

flags

Constructor Summary

Constructors

Constructor and Description
CategoryTreeContainer(java.lang.String id, java.lang.String path, java.lang.String desc, java.lang.String data)

Method Summary

Modifier and Type	Method and Description
void	addAllCategories(java.util.Collection<T> cats) Add all sibling categories to this node
void	addCategory(T category) Add a new sibling category to this node
void	clearCategories() Clear all sub categories
java.lang.Object	clone()
T	getAssociatedValue(com.exalead.access.feedapi.eval.mel.extension.MELType key)
java.util.List<T>	getCategories() Returns a list of sub categories
java.util.List<T>	getCategories(CategoryTreeContainer.SortMode sortMode) Returns a list of sub categories with sorting SortMode applied.
java.lang.String	getData()
CategoryTreeContainer<T>	getDeepestRefinedTreeContainer(CategoryTreeContainer.IterationMode iterationMode) Find the deepest refined category tree container
java.lang.String	getDescription()
com.exalead.access.feedapi.eval.mel.extension.AbstractMELType.FieldsHolder	getFields()
java.lang.String	getId()
java.lang.String	getPath()
java.util.List<T>	getRefinedCategories() Return a list of all refined categories.
java.util.List<T>	getRefinedCategories(CategoryTreeContainer.IterationMode iterationMode) Return a list of all refined categories.
java.util.List<T>	getRefinedCategories(CategoryTreeContainer.IterationMode iterationMode, CategoryTreeContainer.SortMode sortMode) Return a list of all refined categories
java.util.Iterator<T>	iterator()
java.util.Iterator<T>	iterator(CategoryTreeContainer.IterationMode iterMode)
java.util.Iterator<T>	iterator(CategoryTreeContainer.IterationMode iterMode, CategoryTreeContainer.SortMode sortMode) Iterate over the categories, starting with this node.
java.lang.String	rawStringValue()
void	setData(java.lang.String data)
void	setDescription(java.lang.String theDesc)
void	setId(java.lang.String id)
void	setPath(java.lang.String path)

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

FIELDS

protected static final CategoryTreeContainer.FieldsHolder FIELDS

categories

protected java.util.List<T extends AbstractCategory<T>> categories

id

protected java.lang.String id

path

protected java.lang.String path

data

protected java.lang.String data

description

protected java.lang.String description

Constructor Detail

CategoryTreeContainer

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

Method Detail

getId

public java.lang.String getId()

setId

public void setId(java.lang.String id)

getPath

public final java.lang.String getPath()

setPath

public void setPath(java.lang.String path)

getData

public final java.lang.String getData()

setData

public void setData(java.lang.String data)

getDescription

public final java.lang.String getDescription()

setDescription

public final void setDescription(java.lang.String theDesc)

getCategories

public final java.util.List<T> getCategories()

Returns a list of sub categories

Returns:

a list of sub categories

clearCategories

public final void clearCategories()

Clear all sub categories

addAllCategories

public final void addAllCategories(java.util.Collection<T> cats)

Add all sibling categories to this node

getCategories

public final java.util.List<T> getCategories(CategoryTreeContainer.SortMode sortMode)

Returns a list of sub categories with sorting SortMode applied. SortMode.DEFAULT preserves the element's natural ordering.

Returns:

a list of sorted sub categories

getRefinedCategories

public final java.util.List<T> getRefinedCategories()

Return a list of all refined categories. By default, iteration mode is FLAT and sortMode is DEFAULT

Parameters:

iterationMode -

sortMode -

Returns:

getRefinedCategories

public final java.util.List<T> getRefinedCategories(CategoryTreeContainer.IterationMode iterationMode)

Return a list of all refined categories. By default sortMode is DEFAULT

Parameters:

iterationMode -

sortMode -

Returns:

getRefinedCategories

public final java.util.List<T> getRefinedCategories(CategoryTreeContainer.IterationMode iterationMode,
                                                    CategoryTreeContainer.SortMode sortMode)

Return a list of all refined categories

Parameters:

iterationMode -

sortMode -

Returns:

getDeepestRefinedTreeContainer

public CategoryTreeContainer<T> getDeepestRefinedTreeContainer(CategoryTreeContainer.IterationMode iterationMode)

Find the deepest refined category tree container

Parameters:

categoryTreeContainer -

Returns:

addCategory

public final void addCategory(T category)

Add a new sibling category to this node

Parameters:

category -

iterator

public final java.util.Iterator<T> iterator(CategoryTreeContainer.IterationMode iterMode,
                                            CategoryTreeContainer.SortMode sortMode)

Iterate over the categories, starting with this node.

Parameters:

iterMode - the iteration mode

sortMode - should the results be sorted or not?

Returns:

Iterator the iterator

iterator

public final java.util.Iterator<T> iterator(CategoryTreeContainer.IterationMode iterMode)

iterator

public final java.util.Iterator<T> iterator()

Specified by:

iterator in interface java.lang.Iterable<T extends AbstractCategory<T>>

clone

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

Overrides:

clone in class java.lang.Object

Throws:

java.lang.CloneNotSupportedException

rawStringValue

public java.lang.String rawStringValue()

Specified by:

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

Overrides:

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

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 T getAssociatedValue(com.exalead.access.feedapi.eval.mel.extension.MELType key)

Specified by:

getAssociatedValue in interface com.exalead.access.feedapi.eval.mel.extension.types.MELStore<T extends AbstractCategory<T>>