atg.search.routing.command.search

Class RefinementValue

java.lang.Object

atg.search.routing.command.SearchXMLObject

atg.search.routing.command.search.RefinementValue

All Implemented Interfaces:

java.io.Serializable

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

An individual refinement value

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
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

Constructors

Constructor and Description
RefinementValue()

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)
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
int	hashCode()
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, notify, notifyAll, wait, wait, wait

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Class version string

mCount

public int mCount

mValue

public java.lang.String mValue

mExtraData

public java.lang.String mExtraData

mRefinements

public Refinements mRefinements

mRangeStart

public java.lang.String mRangeStart

mRangeEnd

public java.lang.String mRangeEnd

RANGE_DIVIDER

public static final java.lang.String RANGE_DIVIDER

avoids ambiguity with - in ranges.

See Also:

Constant Field Values

Constructor Detail

RefinementValue

public RefinementValue()

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

getDebug

public java.lang.String getDebug()

If this value was excluded from the final results, this attribute contains the reason why.

Returns:

explanation for exclusion

setDebug

public void setDebug(java.lang.String pDebug)

Sets the explanation for why it was excluded, if it was excluded

Parameters:

pDebug - explanation for why it was excluded, if it was excluded

getRefinements

public Refinements getRefinements()

Returns child refinements

Returns:

child refinements

setRefinements

public void setRefinements(Refinements refinements)

Sets child refinements

Parameters:

refinements - children

getCount

public int getCount()

Returns the number of times the value occurred in the results

Returns:

number of times the value occurred in the results

getValue

public java.lang.String getValue()

Returns the value text of the property

Returns:

value text of the property

getRangeStart

public java.lang.String getRangeStart()

Returns the start of the range if this is a range value or empty string otherwise

Returns:

start of the range if this is a range value or empty string otherwise

getRangeEnd

public java.lang.String getRangeEnd()

Returns the end of the range if this is a range value or empty string otherwise

Returns:

end of the range if this is a range value or empty string otherwise

setRangeEnd

public void setRangeEnd(java.lang.String pRangeEnd)

Sets end of the range if this is a range value or empty string otherwise

Parameters:

pRangeEnd - end of the range if this is a range value or empty string otherwise

setRangeStart

public void setRangeStart(java.lang.String pRangeStart)

Sets start of the range if this is a range value or empty string otherwise

Parameters:

pRangeStart - start of the range if this is a range value or empty string otherwise

setCount

public void setCount(int pCount)

Sets number of times this occurred

Parameters:

pCount - number of times this occurred

setValue

public void setValue(java.lang.String pValue)

saves the whole value string

Parameters:

pValue - property value text

getExtraData

public java.lang.String getExtraData()

Returns optional extra data associated with thie value

Returns:

optional extra data associated with thie value

setExtraData

public void setExtraData(java.lang.String extraData)

Sets optional extra data associated with thie value

Parameters:

extraData - optional extra data associated with thie value

getRequestTag

public java.lang.String getRequestTag()

Specified by:

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

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