Package com.apptus.esales.connector

Class Result.CategoryNode

java.lang.Object

com.apptus.esales.connector.Result.Category

com.apptus.esales.connector.Result.CategoryNode

All Implemented Interfaces:

Result, Iterable<Result.Attribute>

Enclosing interface:

Result

public static class Result.CategoryNode
extends Result.Category
implements Result

Represents a result having the category_tree format. A CategoryNode is part of a category tree and may, in addition to attributes, have a parent and/or subcategories. The tree can be traversed using for example getSubcategories(), or utility methods such as getSelectedSubcategory() and findDescendant(String).

Nested Class Summary

Nested classes/interfaces inherited from interface com.apptus.esales.connector.Result

Result.Ad, Result.Ads, Result.Attribute, Result.Category, Result.CategoryData, Result.CategoryList, Result.CategoryNode, Result.Completion, Result.Completions, Result.Correction, Result.Corrections, Result.Count, Result.Facet, Result.FacetList, Result.FacetRange, Result.Phrase, Result.Phrases, Result.Product, Result.Products, Result.ResultType, Result.Value, Result.Values, Result.Variant

Method Summary

Modifier and Type	Method	Description
Result.CategoryNode	findDescendant(String categoryKey)	Searches for the specified category key among this category and its descendants.
Result.CategoryNode	getParent()	Get the parent of this category.
Result.CategoryNode	getSelectedSubcategory()	Get the selected category among this category's subcategories.
List<Result.CategoryNode>	getSubcategories()	Get a list of this category's subcategories, if they were included in the result.
Result.ResultType	getType()	Get the result type of this result.
boolean	isSelected()	Check if this category is a selected category.
static Result.CategoryNode	mock(String key, String ticket, Result.CategoryNode parent, String parentKey, List<Result.Attribute> attributes, List<Result.Attribute> specialAttributes)	Creates a new leaf CategoryNode object for test purposes.
static Result.CategoryNode	mock(String key, String ticket, Result.CategoryNode parent, String parentKey, List<Result.Attribute> attributes, List<Result.Attribute> specialAttributes, List<Result.CategoryNode> subcategories)	Creates a new CategoryNode object with subcategories for test purposes.

Methods inherited from class com.apptus.esales.connector.Result.Category

equals, getAttribute, getDisplayName, getLocale, getParentKey, getProductCount, getTicket, getValue, getValue, hashCode, iterator, key, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface com.apptus.esales.connector.Result

toString

Method Detail

getType

public Result.ResultType getType()

Description copied from interface: Result

Get the result type of this result.

Specified by:

getType in interface Result

Returns:

the result type

mock

public static Result.CategoryNode mock(String key,
                                       String ticket,
                                       Result.CategoryNode parent,
                                       String parentKey,
                                       List<Result.Attribute> attributes,
                                       List<Result.Attribute> specialAttributes)

Creates a new leaf CategoryNode object for test purposes.

Parameters:

key - the category key

ticket - the category ticket

parent - the category parent object

parentKey - the parent category key

attributes - the custom category attributes

specialAttributes - special attributes not found under the attributes tag, e.g. display_name, product_count and selected.

Returns:

a category

mock

public static Result.CategoryNode mock(String key,
                                       String ticket,
                                       Result.CategoryNode parent,
                                       String parentKey,
                                       List<Result.Attribute> attributes,
                                       List<Result.Attribute> specialAttributes,
                                       List<Result.CategoryNode> subcategories)

Creates a new CategoryNode object with subcategories for test purposes. The subcategories will be connected to the resulting CategoryNode object.

Parameters:

key - the category key

ticket - the category ticket

parent - the category parent object

parentKey - the parent category key

attributes - the custom category attributes

specialAttributes - special attributes not found under the attributes tag, e.g. display_name, product_count and selected.

subcategories - the category sub categories

Returns:

a category

getSubcategories

public List<Result.CategoryNode> getSubcategories()

Get a list of this category's subcategories, if they were included in the result.

Returns:

the subcategories of this category

getSelectedSubcategory

public Result.CategoryNode getSelectedSubcategory()

Get the selected category among this category's subcategories.

Returns:

the selected subcategory, or null if no subcategory is selected

findDescendant

public Result.CategoryNode findDescendant(String categoryKey)

Searches for the specified category key among this category and its descendants.

Parameters:

categoryKey - the key of the category to search for

Returns:

the category with the specified key, or null if the category key was not found

getParent

public Result.CategoryNode getParent()

Get the parent of this category.

Returns:

the parent of this category

isSelected

public boolean isSelected()

Check if this category is a selected category.

Returns:

true if the category is selected (or if the category is an ancestor to a selected category)