atg.search.routing.command.search
Class CategoryRuleMatch

java.lang.Object
  atg.search.routing.command.SearchXMLObject
      atg.search.routing.command.search.CategoryRuleMatch

All Implemented Interfaces:

java.io.Serializable

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

A category rule match result

See Also:

Serialized Form

Field Summary

static java.lang.String

CLASS_VERSION Class version string

Constructor Summary

CategoryRuleMatch()

Method Summary

boolean	equals(java.lang.Object pObj)
protected void	getAttributeXML(java.lang.StringBuilder sb)
protected void	getBodyXML(java.lang.StringBuilder sb)
int	getEnd() Returns the text offset of end of pattern match
java.lang.String	getId() Returns the name or id of rule
java.lang.String	getPattern() Returns the pattern string
java.lang.String	getRequestTag() Gets the xml element tag used in the request
int	getStart() Returns the text offset of beginning of pattern match
java.lang.String	getValue() Returns the value of the match
int	getWeight() Returns the weight of rule
int	hashCode()
void	setEnd(int end)
void	setId(java.lang.String id)
void	setPattern(java.lang.String pattern)
void	setStart(int start)
void	setValue(java.lang.String pValue)
void	setWeight(int weight)

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

CategoryRuleMatch

public CategoryRuleMatch()

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

getValue

public java.lang.String getValue()

Returns the value of the match

Returns:

The value of the match

setValue

public void setValue(java.lang.String pValue)

getId

public java.lang.String getId()

Returns the name or id of rule

Returns:

Name or id of rule

setId

public void setId(java.lang.String id)

Parameters:

id - Name or id of rule

getStart

public int getStart()

Returns the text offset of beginning of pattern match

Returns:

Text offset of beginning of pattern match

setStart

public void setStart(int start)

Parameters:

start - Text offset of beginning of pattern match

getEnd

public int getEnd()

Returns the text offset of end of pattern match

Returns:

Text offset of end of pattern match

setEnd

public void setEnd(int end)

Parameters:

end - Text offset of end of pattern match

getWeight

public int getWeight()

Returns the weight of rule

Returns:

Weight of rule

setWeight

public void setWeight(int weight)

Parameters:

weight - Weight of rule

getPattern

public java.lang.String getPattern()

Returns the pattern string

Returns:

Pattern string

setPattern

public void setPattern(java.lang.String pattern)

Parameters:

pattern - Pattern string

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

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