|
|||||||||
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.Refinement
public class Refinement
Refinement result value object.
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 RefinementValue s |
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 RefinementValue s |
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
Constructor Detail |
---|
public Refinement()
Method Detail |
---|
public boolean equals(java.lang.Object pObject)
equals
in class java.lang.Object
public void setName(java.lang.String name)
name
- the name of the facet propertypublic java.lang.String getDebug()
public void setDebug(java.lang.String pDebug)
pDebug
- If this element was excluded from the final results, this attribute contains the reason why.public void setType(atg.search.routing.command.search.RefinementType type)
type
- the type of this refinement (for example, enum, string, integer, etc.).public void setValues(java.util.ArrayList<RefinementValue> values)
RefinementValue
s
values
- list of refinement valuespublic RefinementSortOrder getSort()
public void setSort(RefinementSortOrder pSort)
pSort
- public java.util.List<RefinementValue> getRefinementValues()
RefinementValue
s
RefinementValue
spublic atg.search.routing.command.search.RefinementType getType()
public java.lang.String getName()
public boolean isRange()
public void setRange(boolean range)
range
- whether this facet has range valuespublic int getTotal()
public void setTotal(int total)
total
- the total number of results that have this propertypublic java.lang.String getLabel()
public void setLabel(java.lang.String label)
label
- label of facetpublic java.lang.String getId()
public void setId(java.lang.String id)
id
- the id of refinement elementpublic int getTop()
public void setTop(int top)
top
- the maximum number of valuespublic void setLevel(int pLevel)
pLevel
- the level of refinement element, with 0 indicating a top-level elementpublic int getLevel()
protected void mergeRefinementValues(java.util.List<RefinementValue> pValues, int pRefineMin, int pRefineTop)
public 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 |