atg.search.routing.command.search
Class StatementCandidate

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

All Implemented Interfaces:

java.io.Serializable

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

A retrieved statement's text and other information

See Also:

Serialized Form

Field Summary

static java.lang.String

CLASS_VERSION Class version string

Constructor Summary

StatementCandidate()

Method Summary

boolean	equals(java.lang.Object pObject)
protected static StatementCandidate	fromXmlParser(atg.search.routing.utils.SearchMessageNode pXml)
protected void	getAttributeXML(java.lang.StringBuilder sb)
protected void	getBodyXML(java.lang.StringBuilder sb)
java.lang.String	getField() Returns the text field(s)
int	getIndex() Returns the index of statement in item
float	getRelevance() Returns the original raw relevance
java.lang.String	getRequestTag()
java.lang.String	getStatement() Returns the statement text
void	setField(java.lang.String pField) Sets the text field(s)
void	setIndex(int pIndex) Sets the index of statement in item
void	setRelevance(float pRelevance) Sets original raw relevance
void	setStatement(java.lang.String pStatement) Sets the statement text

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

StatementCandidate

public StatementCandidate()

Method Detail

equals

public boolean equals(java.lang.Object pObject)

Overrides:

equals in class java.lang.Object

getStatement

public java.lang.String getStatement()

Returns the statement text

Returns:

statement text

setStatement

public void setStatement(java.lang.String pStatement)

Sets the statement text

Parameters:

pStatement - the statement text

getIndex

public int getIndex()

Returns the index of statement in item

Returns:

Index of statement in item

setIndex

public void setIndex(int pIndex)

Sets the index of statement in item

Parameters:

pIndex - the index of statement in item

getField

public java.lang.String getField()

Returns the text field(s)

Returns:

text field(s)

setField

public void setField(java.lang.String pField)

Sets the text field(s)

Parameters:

pField - the text field(s)

getRelevance

public float getRelevance()

Returns the original raw relevance

Returns:

original raw relevance

setRelevance

public void setRelevance(float pRelevance)

Sets original raw relevance

Parameters:

pRelevance - original raw relevance

fromXmlParser

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