atg.search.routing.command.search

Class Term

java.lang.Object

atg.search.routing.command.SearchXMLObject

atg.search.routing.command.search.Term

All Implemented Interfaces:

java.io.Serializable

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

A term.

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

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object pObject)
protected static Term	fromXmlParser(atg.search.routing.utils.SearchMessageNode pXml)
protected void	getAttributeXML(java.lang.StringBuilder sb)
protected void	getBodyXML(java.lang.StringBuilder sb)
int	getId() Returns the index of the term, starting at 1
java.lang.String	getLabel() Returns the original string of the term
TermLookupOp	getOp() Not all values are possible for StatementRetrieval: only Required, Negative, and None.
java.lang.String	getRequestTag()
DiagnosticStatus	getStatus() Returns the aggregate status of all the stems
java.util.List<StemLookup>	getStems() Returns stems or synonyms of the term
int	hashCode()
boolean	isExact() Indicates whether this term must match exactly
void	setExact(boolean pExact) Sets whether this term must match exactly
void	setId(int pId) Sets the index of the term, starting at 1
void	setLabel(java.lang.String pLabel) Sets the original string of the term
void	setOp(TermLookupOp pOp) Sets the operation
void	setStatus(DiagnosticStatus pStatus) Sets the aggregate status of all the stems
void	setStems(java.util.List<StemLookup> pStems) Sets stems or synonyms of the 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

Term

public Term()

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

getId

public int getId()

Returns the index of the term, starting at 1

Returns:

Index of the term, starting at 1

setId

public void setId(int pId)

Sets the index of the term, starting at 1

Parameters:

pId - the index of the term, starting at 1

getLabel

public java.lang.String getLabel()

Returns the original string of the term

Returns:

Original string of the term

setLabel

public void setLabel(java.lang.String pLabel)

Sets the original string of the term

Parameters:

pLabel - the original string of the term

getStatus

public DiagnosticStatus getStatus()

Returns the aggregate status of all the stems

Returns:

Aggregate status of all the stems

setStatus

public void setStatus(DiagnosticStatus pStatus)

Sets the aggregate status of all the stems

Parameters:

pStatus - the aggregate status of all the stems

isExact

public boolean isExact()

Indicates whether this term must match exactly

Returns:

whether this term must match exactly

setExact

public void setExact(boolean pExact)

Sets whether this term must match exactly

Parameters:

pExact - whether this term must match exactly

getOp

public TermLookupOp getOp()

Not all values are possible for StatementRetrieval: only Required, Negative, and None. All values are possible for ItemRetrieval.

Returns:

Boolean operator on the term. Not all values are possible for StatementRetrieval: only Required, Negative, and None. All values are possible for ItemRetrieval.

setOp

public void setOp(TermLookupOp pOp)

Sets the operation

Parameters:

pOp - the operation

getStems

public java.util.List<StemLookup> getStems()

Returns stems or synonyms of the term

Returns:

stems or synonyms of the term

setStems

public void setStems(java.util.List<StemLookup> pStems)

Sets stems or synonyms of the term

Parameters:

pStems - stems or synonyms of the term

fromXmlParser

protected static Term 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