atg.search.routing.command.search
Class XmlDocumentSetConstraint

java.lang.Object
  atg.search.routing.command.search.DocumentSetConstraint
      atg.search.routing.command.search.BaseConstraint
          atg.search.routing.command.search.XmlDocumentSetConstraint

All Implemented Interfaces:

java.io.Serializable

public class XmlDocumentSetConstraint
extends BaseConstraint

Allows an ATG DocumentSetConstraint to be defined by defining the raw XML constraint element.

See Also:

Serialized Form

Field Summary

static java.lang.String

CLASS_VERSION Class version string

Constructor Summary

XmlDocumentSetConstraint()

XmlDocumentSetConstraint(java.lang.String pXmlConstraint)

Method Summary

protected DocumentSetConstraint	createFromParser(atg.search.routing.utils.FastXMLModel pXml, int pRootIdx)
java.lang.String	getXmlConstraint() Returns the xml constraint.
void	setXmlConstraint(java.lang.String pXmlConstraint) Bypasses the helper doc set constraint classes that generate ATG Search doc set cosntraint xml and instead defines the constraint as a raw XML string See the ATG Search Reference Guide for a description of the doc set cosntraint syntax.
java.lang.String	toXml() Returns the raw XML defined by setXmlConstraint

Methods inherited from class atg.search.routing.command.search.BaseConstraint

getXml, setXml

Methods inherited from class atg.search.routing.command.search.DocumentSetConstraint

createFromXML, equals, escapeToXml, getParser, getPropConstraints, toString, valueOf

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

CLASS_VERSION

public static final java.lang.String CLASS_VERSION

Class version string

See Also:

Constant Field Values

Constructor Detail

XmlDocumentSetConstraint

public XmlDocumentSetConstraint()

XmlDocumentSetConstraint

public XmlDocumentSetConstraint(java.lang.String pXmlConstraint)

Method Detail

getXmlConstraint

public java.lang.String getXmlConstraint()

Returns the xml constraint.

Returns:

the xml constraint

setXmlConstraint

public void setXmlConstraint(java.lang.String pXmlConstraint)

Bypasses the helper doc set constraint classes that generate ATG Search doc set cosntraint xml and instead defines the constraint as a raw XML string See the ATG Search Reference Guide for a description of the doc set cosntraint syntax.

Parameters:

pXmlConstraint - xml

toXml

public java.lang.String toXml()

Returns the raw XML defined by setXmlConstraint

Specified by:

toXml in class DocumentSetConstraint

Returns:

xml

See Also:

DocumentSetConstraint.toXml()

createFromParser

protected DocumentSetConstraint createFromParser(atg.search.routing.utils.FastXMLModel pXml,
                                                 int pRootIdx)

Specified by:

createFromParser in class DocumentSetConstraint