atg.search.routing.command.search
Class CollectionConstraint
java.lang.Object
atg.search.routing.command.SearchXMLObject
atg.search.routing.command.search.DocumentSetConstraint
atg.search.routing.command.search.BaseConstraint
atg.search.routing.command.search.CollectionConstraint
- All Implemented Interfaces:
- java.io.Serializable
public class CollectionConstraint
- extends BaseConstraint
Collection constraint is used to constraint the result on a directory path of the indexed documents. This will be typically
used when there is a large number of collections (document sets).
- See Also:
- Serialized Form
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 |
CLASS_VERSION
public static final java.lang.String CLASS_VERSION
- See Also:
- Constant Field Values
TAG
public static final java.lang.String TAG
- See Also:
- Constant Field Values
CollectionConstraint
public CollectionConstraint()
getTag
public static java.lang.String getTag()
equals
public boolean equals(java.lang.Object pObject)
- Overrides:
equals
in class java.lang.Object
setPath
public void setPath(java.lang.String pPath)
- Sets the collection path
- Parameters:
pPath
- the collection path
getWeight
public java.lang.Float getWeight()
- Returns the weight of the constraint
- Returns:
- the weight of the constraint
setWeight
public void setWeight(java.lang.Float weight)
- Sets the weight of the constraint
- Parameters:
weight
- the weight of the constraint
getPath
public java.lang.String getPath()
- Returns the collection path
- Returns:
- the collection path
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
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
valueOf
public static CollectionConstraint valueOf(java.lang.String pXml)
- Constructs a collection constraint from xml.
- Parameters:
pXml
- xml
- Returns:
- a new collection constraint
createFromParser
protected DocumentSetConstraint createFromParser(atg.search.routing.utils.SearchMessageNode pXml)
- Specified by:
createFromParser
in class DocumentSetConstraint
getRequestTag
public java.lang.String getRequestTag()
- Specified by:
getRequestTag
in class atg.search.routing.command.SearchXMLObject