atg.search.routing.command.search

Class TextMatch

java.lang.Object

atg.search.routing.command.SearchXMLObject

atg.search.routing.command.search.TextMatch

All Implemented Interfaces:

java.io.Serializable

public class TextMatch
extends atg.search.routing.command.SearchXMLObject
implements java.io.Serializable

A text match result.

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
TextMatch()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object pObject)
protected void	getAttributeXML(java.lang.StringBuilder sb)
protected void	getBodyXML(java.lang.StringBuilder sb)
int	getGoTo() Returns the goto for the text
java.lang.String	getName() Returns the name of the text match
java.lang.String	getRequestTag() Gets the xml element tag used in the request
float	getScore() Returns the score of the match
java.lang.String	getText() Returns the text of the match
int	hashCode()
void	setGoTo(int pGoTo) Sets the goto for the text
void	setName(java.lang.String pName) Sets the name of the text match
void	setScore(float pScore) Sets the score of the match
void	setText(java.lang.String pText) Sets the text of the match

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

TextMatch

public TextMatch()

Method Detail

equals

public boolean equals(java.lang.Object pObject)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

setScore

public void setScore(float pScore)

Sets the score of the match

Parameters:

pScore - the score of the match

getText

public java.lang.String getText()

Returns the text of the match

Returns:

the text of the match

setText

public void setText(java.lang.String pText)

Sets the text of the match

Parameters:

pText - the text of the match

getName

public java.lang.String getName()

Returns the name of the text match

Returns:

the name of the text match

setName

public void setName(java.lang.String pName)

Sets the name of the text match

Parameters:

pName - the name of the text match

getScore

public float getScore()

Returns the score of the match

Returns:

the score of the match

getGoTo

public int getGoTo()

Returns the goto for the text

Returns:

the goto for the text

setGoTo

public void setGoTo(int pGoTo)

Sets the goto for the text

Parameters:

pGoTo - the goto for the text

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

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