|
|||||||||
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.DocumentSetConstraint atg.search.routing.command.search.BaseConstraint atg.search.routing.command.search.ConstraintsGroup
public class ConstraintsGroup
Represents multiple DocumentSetConstraint or ConstraintGroup instances with an operation definition. This is used to define compositions of multiple constraints.
Field Summary | |
---|---|
static java.lang.String |
CLASS_VERSION
|
Constructor Summary | |
---|---|
ConstraintsGroup()
|
|
ConstraintsGroup(java.util.Collection<DocumentSetConstraint> pConstraints)
Create a constraints group specifying the constraints list. |
|
ConstraintsGroup(java.util.Collection<DocumentSetConstraint> pConstraints,
BooleanExpressionType pOperation)
Create a constraints group specifying the operation and constraints list. |
|
ConstraintsGroup(DocumentSetConstraint[] pConstraints)
Create a constraints group specifying a constraints array. |
|
ConstraintsGroup(DocumentSetConstraint[] pConstraints,
BooleanExpressionType pOperation)
Create a constraints group specifying the operation and constraints array. |
Method Summary | |
---|---|
ConstraintsGroup |
add(DocumentSetConstraint pConstraint)
Adds a constraint to the list of constraints, and returns this. |
protected ConstraintsGroup |
createFromParser(atg.search.routing.utils.SearchMessageNode pRoot)
|
boolean |
equals(java.lang.Object pObject)
compares this with another by an XML comparison Note that this will generate full xml. |
protected void |
getAttributeXML(java.lang.StringBuilder sb)
|
protected void |
getBodyXML(java.lang.StringBuilder sb)
|
DocumentSetConstraint[] |
getConstraints()
Returns the constraints as an array |
DocumentSetConstraint |
getConstraints(int pIndex)
Indexed getter for constraints |
java.lang.String |
getName()
Returns the name of the operation, only used for the root operation |
BooleanExpressionType |
getOperation()
Returns the operation for the constraint group |
java.util.List<PropConstraint> |
getPropConstraints()
Helper method that returns PropConstraints only |
java.lang.String |
getRequestTag()
|
void |
setConstraints(DocumentSetConstraint[] pConstraints)
Sets the list of constraints from an array |
void |
setConstraints(int pIndex,
DocumentSetConstraint pConstraint)
Sets the constraint at the provided index; if the list of constraints is not big enough, it is enlarged with null constraints in the intervening slots. |
void |
setName(java.lang.String pName)
Sets the name of the operation. |
void |
setOperation(BooleanExpressionType pOperation)
|
java.lang.String |
toXml()
|
Methods inherited from class atg.search.routing.command.search.BaseConstraint |
---|
getXml, setXml |
Methods inherited from class atg.search.routing.command.search.DocumentSetConstraint |
---|
createFromXML, getParser, valueOf |
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 final java.lang.String CLASS_VERSION
Constructor Detail |
---|
public ConstraintsGroup()
public ConstraintsGroup(java.util.Collection<DocumentSetConstraint> pConstraints)
pConstraints
- a collection of constraints, possibly nullpublic ConstraintsGroup(java.util.Collection<DocumentSetConstraint> pConstraints, BooleanExpressionType pOperation)
pOperation
- The operation typepConstraints
- a collection of constraints, possibly nullpublic ConstraintsGroup(DocumentSetConstraint[] pConstraints)
pConstraints
- an array of constraints, possibly nullpublic ConstraintsGroup(DocumentSetConstraint[] pConstraints, BooleanExpressionType pOperation)
pOperation
- The operation typepConstraints
- an array of constraints, possibly nullMethod Detail |
---|
public boolean equals(java.lang.Object pObject)
equals
in class java.lang.Object
pObject
- another DocumentSetConstraint
public java.util.List<PropConstraint> getPropConstraints()
getPropConstraints
in class DocumentSetConstraint
PropConstraint
s, possibly empty but never nullpublic java.lang.String toXml()
public void setOperation(BooleanExpressionType pOperation)
pOperation
- the operation for the constraint grouppublic BooleanExpressionType getOperation()
public java.lang.String getName()
public void setName(java.lang.String pName)
pName
- a name for the operationpublic ConstraintsGroup add(DocumentSetConstraint pConstraint)
pConstraint
-
public void setConstraints(DocumentSetConstraint[] pConstraints)
pConstraints
- Array of DocumentSetConstraint
public void setConstraints(int pIndex, DocumentSetConstraint pConstraint)
pIndex
- index for the constraintpConstraint
- the constraintpublic DocumentSetConstraint getConstraints(int pIndex)
pIndex
-
public DocumentSetConstraint[] getConstraints()
DocumentSetConstraint
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
protected ConstraintsGroup createFromParser(atg.search.routing.utils.SearchMessageNode pRoot)
createFromParser
in class DocumentSetConstraint
public java.lang.String getRequestTag()
getRequestTag
in class atg.search.routing.command.SearchXMLObject
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |