atg.search.routing.command.search
Class StemLookup

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

All Implemented Interfaces:

java.io.Serializable

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

A stem or synonym of a term for diagnostics

See Also:

Serialized Form

Field Summary

static java.lang.String

CLASS_VERSION Class version string

Constructor Summary

StemLookup()

Method Summary

boolean	equals(java.lang.Object pObject)
protected static StemLookup	fromXmlParser(atg.search.routing.utils.SearchMessageNode pXml)
protected void	getAttributeXML(java.lang.StringBuilder sb)
protected void	getBodyXML(java.lang.StringBuilder sb)
java.lang.String	getFields() Returns the fields of the item that contain this stem (always null for item retrieval step)
int	getFreq() Returns the number of documents this stem appears in
java.lang.String	getRequestTag()
DiagnosticStatus	getStatus() Returns the diagnostic status
java.lang.String	getString() Returns the normalized string of the stem
int	hashCode()
boolean	isSynonym() Indicates whether this stem a synonym of the original query input term
void	setFields(java.lang.String pFields) Sets the fields of the item that contain this stem (always null for item retrieval step).
void	setFreq(int pFreq) Sets the number of documents this stem appears in
void	setStatus(DiagnosticStatus pStatus) Sets the diagnostic status
void	setString(java.lang.String pString) Sets the normalized string of the stem
void	setSynonym(boolean pSynonym) Sets whether this stem a synonym of the original query input term

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

StemLookup

public StemLookup()

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

isSynonym

public boolean isSynonym()

Indicates whether this stem a synonym of the original query input term

Returns:

Is this stem a synonym of the original query input term

setSynonym

public void setSynonym(boolean pSynonym)

Sets whether this stem a synonym of the original query input term

Parameters:

pSynonym - whether this stem a synonym of the original query input term

getStatus

public DiagnosticStatus getStatus()

Returns the diagnostic status

Returns:

status

setStatus

public void setStatus(DiagnosticStatus pStatus)

Sets the diagnostic status

Parameters:

pStatus - the diagnostic status

getString

public java.lang.String getString()

Returns the normalized string of the stem

Returns:

Normalized string of the stem

setString

public void setString(java.lang.String pString)

Sets the normalized string of the stem

Parameters:

pString - the normalized string of the stem

getFreq

public int getFreq()

Returns the number of documents this stem appears in

Returns:

Number of documents this stem appears in

setFreq

public void setFreq(int pFreq)

Sets the number of documents this stem appears in

Parameters:

pFreq -

getFields

public java.lang.String getFields()

Returns the fields of the item that contain this stem (always null for item retrieval step)

Returns:

Fields of the item that contain this stem (always null for item retrieval step)

setFields

public void setFields(java.lang.String pFields)

Sets the fields of the item that contain this stem (always null for item retrieval step). Only set for statementRetrieval termLookup stems. Null for itemRetrieval.

Parameters:

pFields -

fromXmlParser

protected static StemLookup fromXmlParser(atg.search.routing.utils.SearchMessageNode pXml)

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