atg.search.routing.command.search
Class Suggestion

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

All Implemented Interfaces:

java.io.Serializable

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

a spelling suggestion and its frequency in the index.

See Also:

Serialized Form

Field Summary

static java.lang.String

CLASS_VERSION Class version string

Constructor Summary

Suggestion()

Method Summary

boolean	equals(java.lang.Object pObject)
protected void	getAttributeXML(java.lang.StringBuilder sb)
protected void	getBodyXML(java.lang.StringBuilder sb)
int	getFreq() Returns frequency of the word in the index
java.lang.String	getRequestTag()
java.lang.String	getValue() Returns the suggestion value
void	setFreq(int pFreq) Sets the frequency of the word in the index
void	setValue(java.lang.String pValue) Sets the suggestion value

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, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Class version string

Constructor Detail

Suggestion

public Suggestion()

Method Detail

equals

public boolean equals(java.lang.Object pObject)

Overrides:

equals in class java.lang.Object

getValue

public java.lang.String getValue()

Returns the suggestion value

Returns:

the suggestion value

setValue

public void setValue(java.lang.String pValue)

Sets the suggestion value

Parameters:

pValue - the suggestion value

getFreq

public int getFreq()

Returns frequency of the word in the index

Returns:

frequency of the word in the index

setFreq

public void setFreq(int pFreq)

Sets the frequency of the word in the index

Parameters:

pFreq - frequency of the word in the index

getRequestTag

public java.lang.String getRequestTag()

Specified by:

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

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