atg.search.routing.command.search
Class StringConstraint

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

All Implemented Interfaces:

java.io.Serializable

public class StringConstraint
extends BaseConstraint

String value constraint on the query

See Also:

Serialized Form

Field Summary

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

Constructor Summary

StringConstraint()

Method Summary

protected StringConstraint	createFromParser(atg.search.routing.utils.FastXMLModel pXml, int rootIdx)
StringOp	getOperation() Returns the operation
java.lang.String	getProperty() Returns the property
java.lang.String	getRepositoryId() Returns the optional repository id, or null if not provided.
static java.lang.String	getTag()
java.lang.String	getValue() Returns the value, which might be the first part of a range
java.lang.String	getValue1() Returns the first value of the range, same as getValue()
java.lang.String	getValue2() Returns the second value if this is a range value, otherwise null
java.lang.Float	getWeight() Returns the weight
java.lang.Boolean	isCaseSensitive() Indicates whether the constraint is case sensitive
void	setCaseSensitive(java.lang.Boolean pCaseSensitive) Sets whether the constraint is case sensitive
void	setOperation(StringOp pOperation) Sets the string operation
void	setProperty(java.lang.String pProperty) Sets the property
void	setRepositoryId(java.lang.String pRepositoryId) An optional value used for reporting purposes.
void	setValue(java.lang.String pValue) sets the value or the first part of a range value.
void	setValue2(java.lang.String pValue2) Sets the second value if this is a range value
void	setWeight(java.lang.Float pWeight) Sets the weight
java.lang.String	toXml() Converts this constraint to the XML representation that can be sent in request.
static StringConstraint	valueOf(java.lang.String pXml) Constructs a new string 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

StringConstraint

public StringConstraint()

Method Detail

getTag

public static java.lang.String getTag()

getRepositoryId

public java.lang.String getRepositoryId()

Returns the optional repository id, or null if not provided. always null if this is part of a response

Returns:

the optional repository id, or null if not provided. always null if this is part of a response

setRepositoryId

public void setRepositoryId(java.lang.String pRepositoryId)

An optional value used for reporting purposes. it is not used by the engine

Parameters:

pRepositoryId - repository id

setProperty

public void setProperty(java.lang.String pProperty)

Sets the property

Parameters:

pProperty - the property

setValue

public void setValue(java.lang.String pValue)

sets the value or the first part of a range value. Also see setValue2(String)

Parameters:

pValue - value or part of range

setOperation

public void setOperation(StringOp pOperation)

Sets the string operation

Parameters:

pOperation -

isCaseSensitive

public java.lang.Boolean isCaseSensitive()

Indicates whether the constraint is case sensitive

Returns:

whether the constraint is case sensitive

setCaseSensitive

public void setCaseSensitive(java.lang.Boolean pCaseSensitive)

Sets whether the constraint is case sensitive

Parameters:

pCaseSensitive - whether the constraint is case sensitive

getOperation

public StringOp getOperation()

Returns the operation

Returns:

the operation

getProperty

public java.lang.String getProperty()

Returns the property

Returns:

the property

getValue

public java.lang.String getValue()

Returns the value, which might be the first part of a range

Returns:

the value, which might be the first part of a range

getWeight

public java.lang.Float getWeight()

Returns the weight

Returns:

the weight

setWeight

public void setWeight(java.lang.Float pWeight)

Sets the weight

Parameters:

pWeight - the weight

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 StringConstraint valueOf(java.lang.String pXml)

Constructs a new string constraint from xml

Parameters:

pXml - the xml

Returns:

a new string constraint

createFromParser

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

Specified by:

createFromParser in class DocumentSetConstraint

getValue1

public java.lang.String getValue1()

Returns the first value of the range, same as getValue()

Returns:

first value of the range, same as getValue()

setValue2

public void setValue2(java.lang.String pValue2)

Sets the second value if this is a range value

Parameters:

pValue2 - the second value if this is a range value

getValue2

public java.lang.String getValue2()

Returns the second value if this is a range value, otherwise null

Returns:

the second value if this is a range value, otherwise null