atg.search.routing.command.search

Class Categorization

java.lang.Object

atg.search.routing.command.SearchXMLObject

atg.search.routing.command.search.Categorization

All Implemented Interfaces:

java.io.Serializable

public class Categorization
extends atg.search.routing.command.SearchXMLObject

Categorization result for a CategorizeRequest.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION Class version string

Constructor Summary

Constructors

Constructor and Description
Categorization()

Method Summary

Modifier and Type	Method and Description
void	addMatch(CategoryRuleMatch match) Adds a match
boolean	equals(java.lang.Object pObj)
protected void	getAttributeXML(java.lang.StringBuilder sb)
protected void	getBodyXML(java.lang.StringBuilder sb)
int	getId() Returns the topic identifier
java.lang.String	getLabel() Returns the optional display name of category
java.util.List<CategoryRuleMatch>	getMatchList() Returns matching text for a rule of this category.
java.lang.String	getPath() Returns the document set path of category
int	getRelevance() Returns the relevance score of category
java.lang.String	getRequestTag() Gets the xml element tag used in the request
int	getScore() Confidence score of category
int	getSize() Returns the total number of assigned index items under category and all of its descendents
int	getTotalChildren() Total number of children under category
int	getWeight() Returns the total weight of matching rules of category
int	hashCode()
void	setId(int id) Sets the topic identifier
void	setLabel(java.lang.String label) Returns the optional display name of category
void	setMatchList(java.util.List<CategoryRuleMatch> matchList) Sets List of CategoryRuleMatch
void	setPath(java.lang.String path) Sets document set path of category
void	setRelevance(int relevance) Sets the relevance score of category
void	setScore(int score) Sets the confidence score of category
void	setSize(int size) Sets the total number of assigned index items under category and all of its descendents
void	setTotalChildren(int totalChildren) Sets the total number of children under category
void	setWeight(int weight) Sets the total weight of matching rules of category

Methods inherited from class atg.search.routing.command.SearchXMLObject

appendComplexXml, appendOptionalAttr, appendOptionalElem, appendOptionalElem, appendOptionalElem, appendOptionalValue, appendRequiredAttr, appendRequiredElem, appendRequiredElem, appendRequiredValue, getAllAttributeXML, getAllBodyXML, getDefaultXmlBytes, getParentXMLObject, getXmlPath, isPrintedFirstChild, setParentXMLObject, setPrintedFirstChild, toString, toXML, toXML

Methods inherited from class java.lang.Object

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

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Class version string

Constructor Detail

Categorization

public Categorization()

Method Detail

equals

public boolean equals(java.lang.Object pObj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

getAttributeXML

protected void getAttributeXML(java.lang.StringBuilder sb)
                        throws atg.search.routing.command.IncompleteCommandException

Overrides:

getAttributeXML in class atg.search.routing.command.SearchXMLObject

Throws:

atg.search.routing.command.IncompleteCommandException

getBodyXML

protected void getBodyXML(java.lang.StringBuilder sb)
                   throws atg.search.routing.command.IncompleteCommandException

Overrides:

getBodyXML in class atg.search.routing.command.SearchXMLObject

Throws:

atg.search.routing.command.IncompleteCommandException

getMatchList

public java.util.List<CategoryRuleMatch> getMatchList()

Returns matching text for a rule of this category. List of CategoryRuleMatch

Returns:

List of CategoryRuleMatch

setMatchList

public void setMatchList(java.util.List<CategoryRuleMatch> matchList)

Sets List of CategoryRuleMatch

Parameters:

matchList - List of CategoryRuleMatch

addMatch

public void addMatch(CategoryRuleMatch match)

Adds a match

Parameters:

match - Matching text for a rule of this category.

getPath

public java.lang.String getPath()

Returns the document set path of category

Returns:

Document set path of category

setPath

public void setPath(java.lang.String path)

Sets document set path of category

Parameters:

path - Document set path of category

getLabel

public java.lang.String getLabel()

Returns the optional display name of category

Returns:

Optional display name of category

setLabel

public void setLabel(java.lang.String label)

Returns the optional display name of category

Parameters:

label - Optional display name of category

getId

public int getId()

Returns the topic identifier

Returns:

Topic identifier

setId

public void setId(int id)

Sets the topic identifier

Parameters:

id - Topic identifier

getSize

public int getSize()

Returns the total number of assigned index items under category and all of its descendents

Returns:

Total number of assigned index items under category and all of its descendents

setSize

public void setSize(int size)

Sets the total number of assigned index items under category and all of its descendents

Parameters:

size - Total number of assigned index items under category and all of its descendents

getTotalChildren

public int getTotalChildren()

Total number of children under category

Returns:

Total number of children under category

setTotalChildren

public void setTotalChildren(int totalChildren)

Sets the total number of children under category

Parameters:

totalChildren - Total number of children under category

getScore

public int getScore()

Confidence score of category

Returns:

Confidence score of category

setScore

public void setScore(int score)

Sets the confidence score of category

Parameters:

score - Confidence score of category

getRelevance

public int getRelevance()

Returns the relevance score of category

Returns:

Relevance score of category

setRelevance

public void setRelevance(int relevance)

Sets the relevance score of category

Parameters:

relevance - Relevance score of category

getWeight

public int getWeight()

Returns the total weight of matching rules of category

Returns:

Total weight of matching rules of category

setWeight

public void setWeight(int weight)

Sets the total weight of matching rules of category

Parameters:

weight - Total weight of matching rules of category

getRequestTag

public java.lang.String getRequestTag()

Gets the xml element tag used in the request

Specified by:

getRequestTag in class atg.search.routing.command.SearchXMLObject

Returns:

xml element tag