atg.search.routing.command.search
Class Calculation

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

All Implemented Interfaces:

java.io.Serializable

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

Raw relevancy calculation details

See Also:

Serialized Form

Field Summary

static java.lang.String

CLASS_VERSION Class version string

Constructor Summary

Calculation()

Method Summary

void	addLine(java.lang.String pLine)
boolean	equals(java.lang.Object pObject)
protected static Calculation	fromXmlParser(atg.search.routing.utils.SearchMessageNode pXml)
protected void	getBodyXML(java.lang.StringBuilder sb) Override to provide the body of the xml.
java.util.List<java.lang.String>	getLines() Returns List of raw relevancy calculation details
java.lang.String	getRequestTag() Gets the xml element tag used in the request
void	setLines(java.util.List<java.lang.String> pLines) Sets List of raw relevancy calculation details

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

Calculation

public Calculation()

Method Detail

equals

public boolean equals(java.lang.Object pObject)

Overrides:

equals in class java.lang.Object

getLines

public java.util.List<java.lang.String> getLines()

Returns List of raw relevancy calculation details

Returns:

List of raw relevancy calculation details

setLines

public void setLines(java.util.List<java.lang.String> pLines)

Sets List of raw relevancy calculation details

Parameters:

pLines - List of raw relevancy calculation details

addLine

public void addLine(java.lang.String pLine)

fromXmlParser

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

getRequestTag

public java.lang.String getRequestTag()

Gets the xml element tag used in the request

Specified by:

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

Returns:

xml element tag

getBodyXML

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

Override to provide the body of the xml. Do not include the main element tag.

Overrides:

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

Parameters:

sb - shared buffer

Throws:

atg.search.routing.command.IncompleteCommandException