atg.search.routing.command.search
Class Movement

java.lang.Object
  extended by atg.search.routing.command.SearchXMLObject
      extended by atg.search.routing.command.search.Movement
All Implemented Interfaces:
java.io.Serializable

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

An application of a movement (positional) rule on a statement, with resulting value

See Also:
Serialized Form

Field Summary
static java.lang.String CLASS_VERSION
          Class version string
 
Constructor Summary
Movement()
           
 
Method Summary
 boolean equals(java.lang.Object pObject)
           
protected  void getAttributeXML(java.lang.StringBuilder sb)
           
protected  void getBodyXML(java.lang.StringBuilder sb)
           
 int getIndex()
          Returns the statement index within the document
 float getInit()
          Returns the original relevancy value
 java.lang.String getRequestTag()
          Gets the xml element tag used in the request
 java.lang.String getRule()
          Returns the name of the rule
 float getValue()
          Returns the resulting value
 void setIndex(int pIndex)
          Sets the statement index within the document
 void setInit(float pInit)
          Sets the original relevancy value
 void setRule(java.lang.String pRule)
          Sets the name of the rule
 void setValue(float pValue)
          Sets the 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, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION
Class version string

Constructor Detail

Movement

public Movement()
Method Detail

equals

public boolean equals(java.lang.Object pObject)
Overrides:
equals in class java.lang.Object

getValue

public float getValue()
Returns the resulting value

Returns:
resulting value

setValue

public void setValue(float pValue)
Sets the resulting value

Parameters:
pValue -

getRule

public java.lang.String getRule()
Returns the name of the rule

Returns:
name of rule

setRule

public void setRule(java.lang.String pRule)
Sets the name of the rule

Parameters:
pRule -

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 -

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