atg.search.routing.command.search

Class NumericConstraint

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.NumericConstraint

All Implemented Interfaces:

java.io.Serializable

public class NumericConstraint
extends BaseConstraint

Numeric value constraint on the query.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION

Constructor Summary

Constructors

Constructor and Description
NumericConstraint()

Method Summary

Methods

Modifier and Type	Method and Description
protected DocumentSetConstraint	createFromParser(atg.search.routing.utils.SearchMessageNode pXml)
boolean	equals(java.lang.Object pObject)
protected void	getAttributeXML(java.lang.StringBuilder sb)
protected void	getBodyXML(java.lang.StringBuilder sb)
java.lang.String	getName() Returns the name of the property to constrain against
NumOp	getOperation() Returns the operation
java.lang.String	getProperty() Deprecated. Use getName() instead
java.lang.String	getRepositoryId() Get the repository ID, an optional value used for reporting purposes.
java.lang.String	getRequestTag()
static java.lang.String	getTag()
java.lang.Double	getValue() Returns the value (same as getValue1())
java.lang.Double	getValue1() Returns the value, or the first part of a range.
java.lang.Double	getValue2() Returns the second part of a range value, or null.
java.lang.Float	getWeight() Returns the weight
int	hashCode()
void	setName(java.lang.String pName) Sets the name of the property to constrain against
void	setOperation(NumOp pOperation) Sets the comparison operation to use
void	setProperty(java.lang.String pProperty) Deprecated. Use setName(String) instead
void	setRepositoryId(java.lang.String pRepositoryId) Set the repository ID, an optional value used for reporting purposes.
void	setValue1(java.lang.Double pValue1) Sets the first or only numerica value
void	setValue2(java.lang.Double pValue2) Sets the second numeric value, in the case of a range.
void	setWeight(java.lang.Float pWeight) Sets the weight
static NumericConstraint	valueOf(java.lang.String pXml)

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

getXml, setXml

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

createFromXML, getParser, getPropConstraints

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, notify, notifyAll, wait, wait, wait

Field Detail

CLASS_VERSION

public static final java.lang.String CLASS_VERSION

See Also:

Constant Field Values

Constructor Detail

NumericConstraint

public NumericConstraint()

Method Detail

getTag

public static java.lang.String getTag()

equals

public boolean equals(java.lang.Object pObject)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

getRepositoryId

public java.lang.String getRepositoryId()

Get the repository ID, an optional value used for reporting purposes. it is not used by the engine. Returns the 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)

Set the repository ID, an optional value used for reporting purposes. it is not used by the engine.

Parameters:

pRepositoryId - repository id

getWeight

public java.lang.Float getWeight()

Returns the weight

Returns:

weight

setWeight

public void setWeight(java.lang.Float pWeight)

Sets the weight

Parameters:

pWeight -

getOperation

public NumOp getOperation()

Returns the operation

Returns:

operation.

getValue

public java.lang.Double getValue()

Returns the value (same as getValue1())

Returns:

the value (same as getValue1()).

getValue1

public java.lang.Double getValue1()

Returns the value, or the first part of a range.

Returns:

the value, or the first part of a range.

getValue2

public java.lang.Double getValue2()

Returns the second part of a range value, or null.

Returns:

the second part of a range value, or null.

getProperty

public java.lang.String getProperty()

Deprecated. Use getName() instead

Returns the name of the property to constrain against

Returns:

name of the property to constrain against

setProperty

public void setProperty(java.lang.String pProperty)

Deprecated. Use setName(String) instead

Sets the property to constrain against

Parameters:

pProperty - the property to constrain against

getName

public java.lang.String getName()

Returns the name of the property to constrain against

Returns:

name of the property to constrain against

setName

public void setName(java.lang.String pName)

Sets the name of the property to constrain against

Parameters:

pProperty - the name of the property to constrain against

setValue1

public void setValue1(java.lang.Double pValue1)

Sets the first or only numerica value

Parameters:

pValue1 - the numeric value

setValue2

public void setValue2(java.lang.Double pValue2)

Sets the second numeric value, in the case of a range. Do not set this if a range is not desired.

Parameters:

pValue2 - the second numeric value, in the case of a range. Do not set this if a range is not desired.

setOperation

public void setOperation(NumOp pOperation)

Sets the comparison operation to use

Parameters:

pOperation - the comparison operation to use

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

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