RankProperty (ATG Java API)

java.lang.Object
- atg.search.routing.command.SearchXMLObject
- - atg.search.routing.command.search.RankProperty

All Implemented Interfaces:

java.io.Serializable
```
public class RankProperty
extends atg.search.routing.command.SearchXMLObject
implements java.io.Serializable
```
One ranking property score and associated details

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String CLASS_VERSION
Class version string

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

Constructor Summary

Constructors
Constructor and Description

RankProperty()

Constructors
Constructor and Description
`RankProperty()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object pObject)`
`protected static RankProperty`	`fromXmlParser(atg.search.routing.utils.SearchMessageNode pXml)`
`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.
`float`	`getMapping()` Returns the mapping value of the item's property value, ranges from 0 to max
`float`	`getMax()` Returns the maximum mapping value, acting as the denominator for the item's property's mapping value
`int`	`getMaxRank()` Returns the maximum mapping rank
`java.lang.String`	`getName()` Returns the name of property
`int`	`getRank()` Returns the mapping rank of the item's property value, ranges from 0 to maxrank
`java.lang.String`	`getRequestTag()` Gets the xml element tag used in the request
`float`	`getScore()` Returns the ranking property score
`java.lang.String`	`getSelected()` Returns the mapping element that was selected for the property value.
`PropType`	`getType()` Returns type of property
`java.lang.String`	`getValue()` Returns the item's value for this property, if more than one, the single value with the maximum mapping
`float`	`getWeight()` Returns weight of property
`int`	`hashCode()`
`boolean`	`isExists()` Returns whether the property exists or not for this item; true by default
`void`	`setExists(boolean pExists)` Sets whether the property exists or not for this item; true by default
`void`	`setMapping(float pMapping)` Setrs the mapping value of the item's property value, ranges from 0 to max
`void`	`setMax(float pMax)` Sets the maximum mapping value, acting as the denominator for the item's property's mapping value
`void`	`setMaxRank(int pMaxRank)` Sets the maximum mapping rank
`void`	`setName(java.lang.String pName)` Sets the name of property
`void`	`setRank(int pRank)` Sets the mapping rank of the item's property value, ranges from 0 to maxrank
`void`	`setScore(float pScore)` Sets the ranking property score
`void`	`setSelected(java.lang.String pSelected)` Sets the mapping element that was selected for the property value.
`void`	`setType(PropType pType)` Sets type of property
`void`	`setValue(java.lang.String pValue)` Sets the item's value for this property, if more than one, the single value with the maximum mapping
`void`	`setWeight(float pWeight)` Sets weight of property

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
  - RankProperty
```
public RankProperty()
```
- 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
  - getScore
```
public float getScore()
```
    Returns the ranking property score
    
    Returns:
    
    the ranking property score
  - setScore
```
public void setScore(float pScore)
```
    Sets the ranking property score
    
    Parameters:
    
    pScore - the ranking property score
  - getName
```
public java.lang.String getName()
```
    Returns the name of property
    
    Returns:
    
    name of property
  - setName
```
public void setName(java.lang.String pName)
```
    Sets the name of property
    
    Parameters:
    
    pName - the name of property
  - isExists
```
public boolean isExists()
```
    Returns whether the property exists or not for this item; true by default
    
    Returns:
    
    whether the property exists or not for this item; true by default
  - setExists
```
public void setExists(boolean pExists)
```
    Sets whether the property exists or not for this item; true by default
    
    Parameters:
    
    pExists - whether the property exists or not for this item; true by default
  - getType
```
public PropType getType()
```
    Returns type of property
    
    Returns:
    
    type of property
  - setType
```
public void setType(PropType pType)
```
    Sets type of property
    
    Parameters:
    
    pType - type of property
  - getWeight
```
public float getWeight()
```
    Returns weight of property
    
    Returns:
    
    weight of property
  - setWeight
```
public void setWeight(float pWeight)
```
    Sets weight of property
    
    Parameters:
    
    pWeight - weight of property
  - getValue
```
public java.lang.String getValue()
```
    Returns the item's value for this property, if more than one, the single value with the maximum mapping
    
    Returns:
    
    The item's value for this property, if more than one, the single value with the maximum mapping
  - setValue
```
public void setValue(java.lang.String pValue)
```
    Sets the item's value for this property, if more than one, the single value with the maximum mapping
    
    Parameters:
    
    pValue - the item's value for this property, if more than one, the single value with the maximum mapping
  - getMaxRank
```
public int getMaxRank()
```
    Returns the maximum mapping rank
    
    Returns:
    
    The maximum mapping rank
  - setMaxRank
```
public void setMaxRank(int pMaxRank)
```
    Sets the maximum mapping rank
    
    Parameters:
    
    pMaxRank - the maximum mapping rank
  - getRank
```
public int getRank()
```
    Returns the mapping rank of the item's property value, ranges from 0 to maxrank
    
    Returns:
    
    The mapping rank of the item's property value, ranges from 0 to maxrank
  - setRank
```
public void setRank(int pRank)
```
    Sets the mapping rank of the item's property value, ranges from 0 to maxrank
    
    Parameters:
    
    pRank - the mapping rank of the item's property value, ranges from 0 to maxrank
  - getSelected
```
public java.lang.String getSelected()
```
    Returns the mapping element that was selected for the property value. This is either the value itself, for enumerated values; the selected range; or "default" if the value wasn't mapped.
    
    Returns:
    
    The mapping element that was selected for the property value. This is either the value itself, for enumerated values; the selected range; or "default" if the value wasn't mapped.
  - setSelected
```
public void setSelected(java.lang.String pSelected)
```
    Sets the mapping element that was selected for the property value. This is either the value itself, for enumerated values; the selected range; or "default" if the value wasn't mapped.
    
    Parameters:
    
    pSelected - the mapping element that was selected for the property value. This is either the value itself, for enumerated values; the selected range; or "default" if the value wasn't mapped.
  - getMapping
```
public float getMapping()
```
    Returns the mapping value of the item's property value, ranges from 0 to max
    
    Returns:
    
    The mapping value of the item's property value, ranges from 0 to max
  - setMapping
```
public void setMapping(float pMapping)
```
    Setrs the mapping value of the item's property value, ranges from 0 to max
    
    Parameters:
    
    pMapping - the mapping value of the item's property value, ranges from 0 to max
  - getMax
```
public float getMax()
```
    Returns the maximum mapping value, acting as the denominator for the item's property's mapping value
    
    Returns:
    
    The maximum mapping value, acting as the denominator for the item's property's mapping value
  - setMax
```
public void setMax(float pMax)
```
    Sets the maximum mapping value, acting as the denominator for the item's property's mapping value
    
    Parameters:
    
    pMax - the maximum mapping value, acting as the denominator for the item's property's mapping value
  - fromXmlParser
```
protected static RankProperty 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
  - 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

Class RankProperty

Field Summary

Constructor Summary

Method Summary

Methods inherited from class atg.search.routing.command.SearchXMLObject

Methods inherited from class java.lang.Object

Field Detail

CLASS_VERSION

Constructor Detail

RankProperty

Method Detail

equals

hashCode

getScore

setScore

getName

setName

isExists

setExists

getType

setType

getWeight

setWeight

getValue

setValue

getMaxRank

setMaxRank

getRank

setRank

getSelected

setSelected

getMapping

setMapping

getMax

setMax

fromXmlParser

getRequestTag

getAttributeXML

getBodyXML