atg.search.routing.command.search
Class Relevancy

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

All Implemented Interfaces:

java.io.Serializable

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

Relevancy portion of an ItemTrace. Step 3: Calculation of relevancy and application of the threshold

See Also:

Serialized Form

Field Summary

static java.lang.String

CLASS_VERSION Class version string

Constructor Summary

Relevancy()

Method Summary

boolean	equals(java.lang.Object pObject)
protected static Relevancy	fromXmlParser(atg.search.routing.utils.SearchMessageNode pXml)
protected void	getBodyXML(java.lang.StringBuilder sb)
Calculation	getCalculation() Returns the raw relevancy calculation details
Movements	getMovements() Returns result movements, or positional rules, applied to statements, if any
Multipliers	getMultipliers() Returns result multipliers, applied to statements, if any
RankConfigCalculation	getRankConfig() Returns ranking (search) config calculation details
java.lang.String	getRequestTag()
Threshold	getThreshold() Returns the appplication of the minimum relevancy threshold
void	setCalculation(Calculation pCalculation) Sets raw relevancy calculation details
void	setMovements(Movements pMovements) Sets result movements, or positional rules, applied to statements, if any
void	setMultipliers(Multipliers pMultipliers) Sets result multipliers, applied to statements, if any
void	setRankConfig(RankConfigCalculation pRankConfig) Sets ranking (search) config calculation details
void	setThreshold(Threshold pThreshold) Sets the appplication of the minimum relevancy threshold

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

Relevancy

public Relevancy()

Method Detail

equals

public boolean equals(java.lang.Object pObject)

Overrides:

equals in class java.lang.Object

getCalculation

public Calculation getCalculation()

Returns the raw relevancy calculation details

Returns:

Raw relevancy calculation details

setCalculation

public void setCalculation(Calculation pCalculation)

Sets raw relevancy calculation details

Parameters:

pCalculation - raw relevancy calculation details

getRankConfig

public RankConfigCalculation getRankConfig()

Returns ranking (search) config calculation details

Returns:

Ranking (search) config calculation details

setRankConfig

public void setRankConfig(RankConfigCalculation pRankConfig)

Sets ranking (search) config calculation details

Parameters:

pRankConfig - ranking (search) config calculation details

getMultipliers

public Multipliers getMultipliers()

Returns result multipliers, applied to statements, if any

Returns:

result multipliers, applied to statements, if any

setMultipliers

public void setMultipliers(Multipliers pMultipliers)

Sets result multipliers, applied to statements, if any

Parameters:

pMultipliers - result multipliers, applied to statements, if any

getThreshold

public Threshold getThreshold()

Returns the appplication of the minimum relevancy threshold

Returns:

The appplication of the minimum relevancy threshold

setThreshold

public void setThreshold(Threshold pThreshold)

Sets the appplication of the minimum relevancy threshold

Parameters:

pThreshold - the appplication of the minimum relevancy threshold

getMovements

public Movements getMovements()

Returns result movements, or positional rules, applied to statements, if any

Returns:

result movements, or positional rules, applied to statements, if any

setMovements

public void setMovements(Movements pMovements)

Sets result movements, or positional rules, applied to statements, if any

Parameters:

pMovements - result movements, or positional rules, applied to statements, if any

fromXmlParser

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

getRequestTag

public java.lang.String getRequestTag()

Specified by:

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

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