atg.search.routing.command.search
Class SetConstraint

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

All Implemented Interfaces:

java.io.Serializable

public class SetConstraint
extends BaseConstraint

Set constraint is used to constraint the result on a directory path of the indexed documents. This will be typically used to implement topic (taxonomy) constraints.

See Also:

Serialized Form

Field Summary

static java.lang.String	CLASS_VERSION
static java.lang.String	TAG

Constructor Summary

SetConstraint()

Method Summary

protected SetConstraint	createFromParser(atg.search.routing.utils.FastXMLModel pXml, int rootIdx)
java.lang.String	getPath() Returns the set path
java.lang.Boolean	getRecurse() Indicates whether the constraint is recursive
static java.lang.String	getTag()
java.lang.Float	getWeight() Returns the weight of the constraint
java.lang.Boolean	isRecurse() Same as getRecurse().
void	setPath(java.lang.String pPath) Sets the set path
void	setRecurse(java.lang.Boolean pRecurse) Controls whether the constraint is recursive
void	setWeight(java.lang.Float weight) Sets the weight of the constraint
java.lang.String	toXml() Converts this constraint to the XML representation that can be sent in request.
static SetConstraint	valueOf(java.lang.String pXml) Constructs a set constraint from xml.

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

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

See Also:

Constant Field Values

TAG

public static final java.lang.String TAG

See Also:

Constant Field Values

Constructor Detail

SetConstraint

public SetConstraint()

Method Detail

getTag

public static java.lang.String getTag()

getRecurse

public java.lang.Boolean getRecurse()

Indicates whether the constraint is recursive

Returns:

whether the constraint is recursive

setRecurse

public void setRecurse(java.lang.Boolean pRecurse)

Controls whether the constraint is recursive

Parameters:

pRecurse - whether the constraint is recursive

setPath

public void setPath(java.lang.String pPath)

Sets the set path

Parameters:

pPath - the set 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 set path

Returns:

the set path

isRecurse

public java.lang.Boolean isRecurse()

Same as getRecurse().

Returns:

Same as getRecurse()

toXml

public java.lang.String toXml()

Description copied from class: DocumentSetConstraint

Converts this constraint to the XML representation that can be sent in request. You must override this to provide constraint-specific XML generation.

Specified by:

toXml in class DocumentSetConstraint

Returns:

xml

valueOf

public static SetConstraint valueOf(java.lang.String pXml)

Constructs a set constraint from xml.

Parameters:

pXml - xml

Returns:

a new set constraint

createFromParser

protected SetConstraint createFromParser(atg.search.routing.utils.FastXMLModel pXml,
                                         int rootIdx)

Specified by:

createFromParser in class DocumentSetConstraint