atg.search.routing.command.search
Class RankConfigCalculation

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

All Implemented Interfaces:

java.io.Serializable

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

Ranking (search) config calculation details.

See Also:

Serialized Form

Field Summary

static java.lang.String

CLASS_VERSION Class version string

Constructor Summary

RankConfigCalculation()

Method Summary

boolean	equals(java.lang.Object pObject)
protected static RankConfigCalculation	fromXmlParser(atg.search.routing.utils.SearchMessageNode pRoot)
protected void	getAttributeXML(java.lang.StringBuilder sb) Override to provide attributes.
protected void	getBodyXML(java.lang.StringBuilder sb) Override to provide the body of the xml.
java.util.List<Bottom>	getBottoms() Returns the List of move to the bottom rules
float	getDenom() Returns the total weight of all properties
java.lang.String	getName() Returns the name of configuration used
java.util.List<RankProperty>	getProperties() Returns the List of ranking property scores and associated details
java.lang.String	getRequestTag() Gets the xml element tag used in the request
float	getResult() Returns the final ranking relevancy, total divided by denom
java.util.List<Top>	getTops() Returns the List of move to the top rules
float	getTotal() Returns the total ranking score of all properties
void	setBottoms(java.util.List<Bottom> pBottoms) Sets the List of move to the bottom rules
void	setDenom(float pDenom) Sets the total weight of all properties
void	setName(java.lang.String pName) Sets the name of configuration used
void	setProperties(java.util.List<RankProperty> pProperties) Sets the List of ranking property scores and associated details
void	setResult(float pResult) Sets the final ranking relevancy, total divided by denom
void	setTops(java.util.List<Top> pTops) Sets the List of move to the top rules
void	setTotal(float pTotal) Sets the total ranking score of all properties

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

RankConfigCalculation

public RankConfigCalculation()

Method Detail

equals

public boolean equals(java.lang.Object pObject)

Overrides:

equals in class java.lang.Object

getName

public java.lang.String getName()

Returns the name of configuration used

Returns:

Name of configuration used

setName

public void setName(java.lang.String pName)

Sets the name of configuration used

Parameters:

pName - Name of configuration used

getDenom

public float getDenom()

Returns the total weight of all properties

Returns:

Total weight of all properties

setDenom

public void setDenom(float pDenom)

Sets the total weight of all properties

Parameters:

pDenom - total weight of all properties

getTotal

public float getTotal()

Returns the total ranking score of all properties

Returns:

Total ranking score of all properties

setTotal

public void setTotal(float pTotal)

Sets the total ranking score of all properties

Parameters:

pTotal - total ranking score of all properties

getResult

public float getResult()

Returns the final ranking relevancy, total divided by denom

Returns:

Final ranking relevancy, total divided by denom

setResult

public void setResult(float pResult)

Sets the final ranking relevancy, total divided by denom

Parameters:

pResult - final ranking relevancy, total divided by denom

getProperties

public java.util.List<RankProperty> getProperties()

Returns the List of ranking property scores and associated details

Returns:

List of ranking property scores and associated details

setProperties

public void setProperties(java.util.List<RankProperty> pProperties)

Sets the List of ranking property scores and associated details

Parameters:

pProperties -

getTops

public java.util.List<Top> getTops()

Returns the List of move to the top rules

Returns:

List of move to the top rules

setTops

public void setTops(java.util.List<Top> pTops)

Sets the List of move to the top rules

Parameters:

pTops - List of move to the top rules

getBottoms

public java.util.List<Bottom> getBottoms()

Returns the List of move to the bottom rules

Returns:

List of move to the bottom rules

setBottoms

public void setBottoms(java.util.List<Bottom> pBottoms)

Sets the List of move to the bottom rules

Parameters:

pBottoms - List of move to the bottom rules

fromXmlParser

protected static RankConfigCalculation fromXmlParser(atg.search.routing.utils.SearchMessageNode pRoot)

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

getAttributeXML

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

Override to provide attributes.

Overrides:

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

Parameters:

sb - shared buffer

Throws:

atg.search.routing.command.IncompleteCommandException - if required values are missing

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