atg.search.routing.command.search

Class Multiplier

java.lang.Object

atg.search.routing.command.SearchXMLObject

atg.search.routing.command.search.Multiplier

All Implemented Interfaces:

java.io.Serializable

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

An application of a result multipler on a statement, with resulting value

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION Class version string

Constructor Summary

Constructors

Constructor and Description
Multiplier()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object pObject)
protected void	getAttributeXML(java.lang.StringBuilder sb)
protected void	getBodyXML(java.lang.StringBuilder sb)
float	getFactor() Returns the multiplier factor
int	getIndex() Returns the statement index within the document
float	getInit() Returns the original relevancy value
java.lang.String	getName() Returns the field name
java.lang.String	getRequestTag() Gets the xml element tag used in the request
float	getValue() Returns the resulting value
int	hashCode()
void	setFactor(float pFactor) Sets the multiplier factor
void	setIndex(int pIndex) Sets the statement index within the document
void	setInit(float pInit) Sets the original relevancy value
void	setName(java.lang.String pName) Sets the field name
void	setValue(float pValue) Sets resulting value

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, notify, notifyAll, wait, wait, wait

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Class version string

Constructor Detail

Multiplier

public Multiplier()

Method Detail

equals

public boolean equals(java.lang.Object pObject)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

getValue

public float getValue()

Returns the resulting value

Returns:

resulting value

setValue

public void setValue(float pValue)

Sets resulting value

Parameters:

pValue -

getName

public java.lang.String getName()

Returns the field name

Returns:

field name

setName

public void setName(java.lang.String pName)

Sets the field name

Parameters:

pName -

getIndex

public int getIndex()

Returns the statement index within the document

Returns:

statement index within the document

setIndex

public void setIndex(int pIndex)

Sets the statement index within the document

Parameters:

pIndex -

getFactor

public float getFactor()

Returns the multiplier factor

Returns:

multiplier factor

setFactor

public void setFactor(float pFactor)

Sets the multiplier factor

Parameters:

pFactor -

getInit

public float getInit()

Returns the original relevancy value

Returns:

original relevancy value

setInit

public void setInit(float pInit)

Sets the original relevancy value

Parameters:

pInit -

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

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