public class Refinements
extends atg.search.routing.command.SearchXMLObject
implements java.io.Serializable
Refinement
s and some
other info.Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CLASS_VERSION
Class version string
|
Constructor and Description |
---|
Refinements() |
Modifier and Type | Method and Description |
---|---|
protected static int |
compareValueTo(int pType,
RefinementValue pLeft,
RefinementValue pRight) |
boolean |
equals(java.lang.Object pObject) |
protected void |
getAttributeXML(java.lang.StringBuilder sb) |
protected void |
getBodyXML(java.lang.StringBuilder sb) |
java.lang.String |
getDebugString()
Returns the debug string
|
protected static int |
getIntFromType(atg.search.routing.command.search.RefinementType pType,
boolean pIsRange) |
java.lang.String |
getMapping()
Returns the refinement mapping
|
java.lang.String |
getName()
Returns the refinement configuration name
|
Refinement |
getRefinement(int index)
Get a single Refinement.
|
Refinement[] |
getRefinements()
Returns array of refinements
|
java.util.ArrayList<Refinement> |
getRefinementsList()
Get a list of Refinements.
|
java.lang.String |
getRequestTag() |
SelectConfig |
getSelectConfig()
If refineDebug is true, and $map is passed as the refineConfig, this element
shows what configurations were considered and the one that was selected
|
int |
getSize()
Return the number of Refinements.
|
Source |
getSource()
Returns source information about how the refinement configuration was constructed
|
int |
hashCode()
Returns a hash code that is the concatenation of the hashes of the child refinements
|
protected void |
mergeRefinements(Refinements pRefinements,
int pRefineMin,
int pRefineTop)
Maps refinements by type and name to the index in the list of refinements.
|
void |
setDebugString(java.lang.String ds)
Sets the debug string
|
void |
setMapping(java.lang.String mapping)
Sets the refinement mapping
|
void |
setName(java.lang.String pName)
Sets the refinement configuration name
|
void |
setRefinements(Refinement[] refinements)
Appends a set of Refinements to this Refinements object.
|
void |
setRefinementsList(java.util.ArrayList<Refinement> refinementList)
Replaces the list of mRefinements
|
void |
setSelectConfig(SelectConfig pSelectConfig)
Sets the select config.
|
void |
setSource(Source pSource)
Sets source information about how the refinement configuration was constructed
|
appendComplexXml, appendOptionalAttr, appendOptionalElem, appendOptionalElem, appendOptionalElem, appendOptionalValue, appendRequiredAttr, appendRequiredElem, appendRequiredElem, appendRequiredValue, getAllAttributeXML, getAllBodyXML, getDefaultXmlBytes, getParentXMLObject, getXmlPath, isPrintedFirstChild, setParentXMLObject, setPrintedFirstChild, toString, toXML, toXML
public boolean equals(java.lang.Object pObject)
equals
in class java.lang.Object
public int getSize()
public Refinement[] getRefinements()
public void setRefinements(Refinement[] refinements)
refinements
- array of Refinements to addpublic Refinement getRefinement(int index) throws java.lang.IndexOutOfBoundsException
index
- which RefinementRefinement
objectjava.lang.IndexOutOfBoundsException
setRefinements(atg.search.routing.command.search.Refinement[])
public java.util.ArrayList<Refinement> getRefinementsList()
ArrayList
of refinement objectspublic void setRefinementsList(java.util.ArrayList<Refinement> refinementList)
refinementList
- the list of refinementspublic 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
public int hashCode()
hashCode
in class java.lang.Object
public java.lang.String getDebugString()
public void setDebugString(java.lang.String ds)
ds
- the debug stringpublic java.lang.String getMapping()
public void setMapping(java.lang.String mapping)
mapping
- the refinement mappingpublic java.lang.String getName()
public void setName(java.lang.String pName)
pName
- the refinement configuration namepublic void setSelectConfig(SelectConfig pSelectConfig)
pSelectConfig
- the select configpublic SelectConfig getSelectConfig()
public void setSource(Source pSource)
pSource
- source information about how the refinement configuration was constructedpublic Source getSource()
protected static int getIntFromType(atg.search.routing.command.search.RefinementType pType, boolean pIsRange)
protected static int compareValueTo(int pType, RefinementValue pLeft, RefinementValue pRight)
protected void mergeRefinements(Refinements pRefinements, int pRefineMin, int pRefineTop)
getRefinementsList()
.pRefinements
- pRefineMin
- minimum count for a refinement value to be includedpRefineTop
- top-number of refinement values to return after sorting