atg.search.routing.command.search
Class SelectConfig

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

All Implemented Interfaces:

java.io.Serializable

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

If refineDebug is true, and $map is passed as the refineConfig, this element shows what configurations were considered and the one that was selected

See Also:

Serialized Form

Field Summary

static java.lang.String

CLASS_VERSION Class version string

Constructor Summary

SelectConfig()

Method Summary

boolean	equals(java.lang.Object pObject)
protected static SelectConfig	fromXmlParser(atg.search.routing.utils.SearchMessageNode xml)
protected void	getAttributeXML(java.lang.StringBuilder sb)
protected void	getBodyXML(java.lang.StringBuilder sb)
java.util.List<SelectConfigMapping>	getMappings() Returns the list of mappings
java.lang.String	getProperty() Returns the name of the meta-data property whose values are used for mapping to the refinement configurations
java.lang.String	getRequestTag()
int	getTotal() Returns the total number of candidate items considered for refinements
void	setMappings(java.util.List<SelectConfigMapping> pMappings) Sets the list of mappings
void	setProperty(java.lang.String pProperty) Sets the name of the meta-data property whose values are used for mapping to the refinement configurations
void	setTotal(int pTotal) Sets the total number of candidate items considered for refinements

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

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Class version string

Constructor Detail

SelectConfig

public SelectConfig()

Method Detail

equals

public boolean equals(java.lang.Object pObject)

Overrides:

equals in class java.lang.Object

getMappings

public java.util.List<SelectConfigMapping> getMappings()

Returns the list of mappings

Returns:

the list of mappings

setMappings

public void setMappings(java.util.List<SelectConfigMapping> pMappings)

Sets the list of mappings

Parameters:

pMappings - the list of mappings

getTotal

public int getTotal()

Returns the total number of candidate items considered for refinements

Returns:

Total number of candidate items considered for refinements

getProperty

public java.lang.String getProperty()

Returns the name of the meta-data property whose values are used for mapping to the refinement configurations

Returns:

The name of the meta-data property whose values are used for mapping to the refinement configurations

setTotal

public void setTotal(int pTotal)

Sets the total number of candidate items considered for refinements

Parameters:

pTotal - Total number of candidate items considered for refinements

setProperty

public void setProperty(java.lang.String pProperty)

Sets the name of the meta-data property whose values are used for mapping to the refinement configurations

Parameters:

pProperty - The name of the meta-data property whose values are used for mapping to the refinement configurations

fromXmlParser

protected static SelectConfig fromXmlParser(atg.search.routing.utils.SearchMessageNode xml)

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