|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object atg.search.routing.command.SearchXMLObject atg.search.routing.command.search.RefinementValue
public class RefinementValue
An individual refinement value
Field Summary | |
---|---|
static java.lang.String |
CLASS_VERSION
Class version string |
int |
mCount
|
java.lang.String |
mExtraData
|
java.lang.String |
mRangeEnd
|
java.lang.String |
mRangeStart
|
Refinements |
mRefinements
|
java.lang.String |
mValue
|
static java.lang.String |
RANGE_DIVIDER
avoids ambiguity with - in ranges. |
Constructor Summary | |
---|---|
RefinementValue()
|
Method Summary | |
---|---|
boolean |
equals(java.lang.Object pObject)
|
protected void |
getAttributeXML(java.lang.StringBuilder sb)
|
protected void |
getBodyXML(java.lang.StringBuilder sb)
|
int |
getCount()
Returns the number of times the value occurred in the results |
java.lang.String |
getDebug()
If this value was excluded from the final results, this attribute contains the reason why. |
java.lang.String |
getExtraData()
Returns optional extra data associated with thie value |
java.lang.String |
getRangeEnd()
Returns the end of the range if this is a range value or empty string otherwise |
java.lang.String |
getRangeStart()
Returns the start of the range if this is a range value or empty string otherwise |
Refinements |
getRefinements()
Returns child refinements |
java.lang.String |
getRequestTag()
|
java.lang.String |
getValue()
Returns the value text of the property |
void |
setCount(int pCount)
Sets number of times this occurred |
void |
setDebug(java.lang.String pDebug)
Sets the explanation for why it was excluded, if it was excluded |
void |
setExtraData(java.lang.String extraData)
Sets optional extra data associated with thie value |
void |
setRangeEnd(java.lang.String pRangeEnd)
Sets end of the range if this is a range value or empty string otherwise |
void |
setRangeStart(java.lang.String pRangeStart)
Sets start of the range if this is a range value or empty string otherwise |
void |
setRefinements(Refinements refinements)
Sets child refinements |
void |
setValue(java.lang.String pValue)
saves the whole value string |
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 |
---|
public static java.lang.String CLASS_VERSION
public int mCount
public java.lang.String mValue
public java.lang.String mExtraData
public Refinements mRefinements
public java.lang.String mRangeStart
public java.lang.String mRangeEnd
public static final java.lang.String RANGE_DIVIDER
Constructor Detail |
---|
public RefinementValue()
Method Detail |
---|
public boolean equals(java.lang.Object pObject)
equals
in class java.lang.Object
public java.lang.String getDebug()
public void setDebug(java.lang.String pDebug)
pDebug
- explanation for why it was excluded, if it was excludedpublic Refinements getRefinements()
public void setRefinements(Refinements refinements)
refinements
- childrenpublic int getCount()
public java.lang.String getValue()
public java.lang.String getRangeStart()
public java.lang.String getRangeEnd()
public void setRangeEnd(java.lang.String pRangeEnd)
pRangeEnd
- end of the range if this is a range value or empty string otherwisepublic void setRangeStart(java.lang.String pRangeStart)
pRangeStart
- start of the range if this is a range value or empty string otherwisepublic void setCount(int pCount)
pCount
- number of times this occurredpublic void setValue(java.lang.String pValue)
pValue
- property value textpublic java.lang.String getExtraData()
public void setExtraData(java.lang.String extraData)
extraData
- optional extra data associated with thie valuepublic java.lang.String getRequestTag()
getRequestTag
in class atg.search.routing.command.SearchXMLObject
protected void getAttributeXML(java.lang.StringBuilder sb) throws atg.search.routing.command.IncompleteCommandException
getAttributeXML
in class atg.search.routing.command.SearchXMLObject
atg.search.routing.command.IncompleteCommandException
protected void getBodyXML(java.lang.StringBuilder sb) throws atg.search.routing.command.IncompleteCommandException
getBodyXML
in class atg.search.routing.command.SearchXMLObject
atg.search.routing.command.IncompleteCommandException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |