atg.search.routing.command.search
Class StatementRetrieval

java.lang.Object
  atg.search.routing.command.SearchXMLObject
      atg.search.routing.command.search.ItemRetrieval
          atg.search.routing.command.search.StatementRetrieval

All Implemented Interfaces:

java.io.Serializable

public class StatementRetrieval
extends ItemRetrieval

Second step of ItemTrace. Step 2: Term look up of statements, plus application of boolean logic and other limits

See Also:

Serialized Form

Field Summary

static java.lang.String

CLASS_VERSION Class version string

Constructor Summary

StatementRetrieval()

Method Summary

boolean	equals(java.lang.Object pObject)
protected static StatementRetrieval	fromXmlParser(atg.search.routing.utils.SearchMessageNode pXml)
protected void	getBodyXML(java.lang.StringBuilder sb)
Candidates	getCandidates() Returns the retrieved statements from this item
java.lang.String	getRequestTag() Gets the xml element tag used in the request
void	setCandidates(Candidates pCandidates) Sets retrieved statements from this item

Methods inherited from class atg.search.routing.command.search.ItemRetrieval

getBooleanLogic, getLimits, getTermLookup, setBooleanLogic, setLimits, setTermLookup

Methods inherited from class atg.search.routing.command.SearchXMLObject

appendComplexXml, appendOptionalAttr, appendOptionalElem, appendOptionalElem, appendOptionalElem, appendOptionalValue, appendRequiredAttr, appendRequiredElem, appendRequiredElem, appendRequiredValue, getAllAttributeXML, getAllBodyXML, getAttributeXML, 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

StatementRetrieval

public StatementRetrieval()

Method Detail

equals

public boolean equals(java.lang.Object pObject)

Overrides:

equals in class ItemRetrieval

getCandidates

public Candidates getCandidates()

Returns the retrieved statements from this item

Returns:

retrieved statements from this item

setCandidates

public void setCandidates(Candidates pCandidates)

Sets retrieved statements from this item

Parameters:

pCandidates - retrieved statements from this item

fromXmlParser

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

getRequestTag

public java.lang.String getRequestTag()

Description copied from class: ItemRetrieval

Gets the xml element tag used in the request

Overrides:

getRequestTag in class ItemRetrieval

Returns:

xml element tag

getBodyXML

protected void getBodyXML(java.lang.StringBuilder sb)
                   throws atg.search.routing.command.IncompleteCommandException

Overrides:

getBodyXML in class ItemRetrieval

Throws:

atg.search.routing.command.IncompleteCommandException