atg.search.routing.command.search
Class Refinement

java.lang.Object
  atg.search.routing.command.SearchXMLObject
      atg.search.routing.command.search.Refinement

All Implemented Interfaces:

java.io.Serializable

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

Refinement result value object.

See Also:

Serialized Form

Field Summary

static java.lang.String

CLASS_VERSION Class version string

Constructor Summary

Refinement()

Method Summary

boolean	equals(java.lang.Object pObject)
protected void	getAttributeXML(java.lang.StringBuilder sb)
protected void	getBodyXML(java.lang.StringBuilder sb)
java.lang.String	getDebug() If this element was excluded from the final results, returns the reason why
java.lang.String	getId() Returns the id of refinement element
java.lang.String	getLabel() Returns the label of facet
int	getLevel() Returns the level of refinement element, with 0 indicating a top-level element
java.lang.String	getName() Returns the name of facet property
java.util.List<RefinementValue>	getRefinementValues() Returns the List of RefinementValues
java.lang.String	getRequestTag()
RefinementSortOrder	getSort() Returns the sort mode for values
int	getTop() Returns the maximum number of values
int	getTotal() Returns the total number of results that have this property
atg.search.routing.command.search.RefinementType	getType() The type of this refinement (for example, enum, string, integer, etc.).
boolean	isRange() Indicates whether this facet has range values
protected void	mergeRefinementValues(java.util.List<RefinementValue> pValues, int pRefineMin, int pRefineTop)
void	setDebug(java.lang.String pDebug) Sets the reason why this element was excluded from the final results, if it was excluded.
void	setId(java.lang.String id) Sets the id of refinement element
void	setLabel(java.lang.String label) Sets the label of facet
void	setLevel(int pLevel) Sets the level of refinement element, with 0 indicating a top-level element
void	setName(java.lang.String name) Sets the name of the facet property
void	setRange(boolean range) Sets whether this facet has range values
void	setSort(RefinementSortOrder pSort) Sets the sort mode for values
void	setTop(int top) Sets the maximum number of values
void	setTotal(int total) Sets the total number of results that have this property
void	setType(atg.search.routing.command.search.RefinementType type) Sets the type of this refinement (for example, enum, string, integer, etc.).
void	setValues(java.util.ArrayList<RefinementValue> values) Sets the list of RefinementValues

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

appendComplexXml, appendOptionalAttr, appendOptionalElem, appendOptionalElem, appendOptionalElem, appendRequiredAttr, appendRequiredElem, appendRequiredElem, appendRequiredValue, getAllAttributeXML, getAllBodyXML, getDefaultXmlBytes, getParentXMLObject, getXmlPath, setParentXMLObject, 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

Refinement

public Refinement()

Method Detail

equals

public boolean equals(java.lang.Object pObject)

Overrides:

equals in class java.lang.Object

setName

public void setName(java.lang.String name)

Sets the name of the facet property

Parameters:

name - the name of the facet property

getDebug

public java.lang.String getDebug()

If this element was excluded from the final results, returns the reason why

Returns:

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

setDebug

public void setDebug(java.lang.String pDebug)

Sets the reason why this element was excluded from the final results, if it was excluded.

Parameters:

pDebug - If this element was excluded from the final results, this attribute contains the reason why.

setType

public void setType(atg.search.routing.command.search.RefinementType type)

Sets the type of this refinement (for example, enum, string, integer, etc.).

Parameters:

type - the type of this refinement (for example, enum, string, integer, etc.).

setValues

public void setValues(java.util.ArrayList<RefinementValue> values)

Sets the list of RefinementValues

Parameters:

values - list of refinement values

getSort

public RefinementSortOrder getSort()

Returns the sort mode for values

Returns:

Sort mode for values

setSort

public void setSort(RefinementSortOrder pSort)

Sets the sort mode for values

Parameters:

pSort -

getRefinementValues

public java.util.List<RefinementValue> getRefinementValues()

Returns the List of RefinementValues

Returns:

List of RefinementValues

getType

public atg.search.routing.command.search.RefinementType getType()

The type of this refinement (for example, enum, string, integer, etc.).

Returns:

the type of refinement

getName

public java.lang.String getName()

Returns the name of facet property

Returns:

Name of facet property

isRange

public boolean isRange()

Indicates whether this facet has range values

Returns:

Whether this facet has range values

setRange

public void setRange(boolean range)

Sets whether this facet has range values

Parameters:

range - whether this facet has range values

getTotal

public int getTotal()

Returns the total number of results that have this property

Returns:

Total number of results that have this property

setTotal

public void setTotal(int total)

Sets the total number of results that have this property

Parameters:

total - the total number of results that have this property

getLabel

public java.lang.String getLabel()

Returns the label of facet

Returns:

Label of facet

setLabel

public void setLabel(java.lang.String label)

Sets the label of facet

Parameters:

label - label of facet

getId

public java.lang.String getId()

Returns the id of refinement element

Returns:

Id of refinement element

setId

public void setId(java.lang.String id)

Sets the id of refinement element

Parameters:

id - the id of refinement element

getTop

public int getTop()

Returns the maximum number of values

Returns:

Maximum number of values

setTop

public void setTop(int top)

Sets the maximum number of values

Parameters:

top - the maximum number of values

setLevel

public void setLevel(int pLevel)

Sets the level of refinement element, with 0 indicating a top-level element

Parameters:

pLevel - the level of refinement element, with 0 indicating a top-level element

getLevel

public int getLevel()

Returns the level of refinement element, with 0 indicating a top-level element

Returns:

Level of refinement element, with 0 indicating a top-level element

mergeRefinementValues

protected void mergeRefinementValues(java.util.List<RefinementValue> pValues,
                                     int pRefineMin,
                                     int pRefineTop)

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