atg.search.routing.command.search
Class KeywordConstraint

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

All Implemented Interfaces:

java.io.Serializable

public class KeywordConstraint
extends BaseConstraint

This constraint is used for keyword constraints on the query. See KeywordType for the types of constraints.

See Also:

Serialized Form

Field Summary

static java.lang.String

CLASS_VERSION

Constructor Summary

KeywordConstraint()

Method Summary

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)
KeywordType	getMode() Returns the mode
java.lang.String	getRequestTag()
java.lang.String	getValue() Returns the keywords
java.lang.Float	getWeight() Returns the preference value if this expression is used in a weightedProps
void	setMode(KeywordType pMode) Sets the mode, or keyword type
void	setValue(java.lang.String pValue) Sets the keywords, which should be space-delimited
void	setWeight(java.lang.Float pWeight) Sets the preference value if this expression is used in a weightedProps
static KeywordConstraint	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, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

CLASS_VERSION

public static final java.lang.String CLASS_VERSION

See Also:

Constant Field Values

Constructor Detail

KeywordConstraint

public KeywordConstraint()

Method Detail

equals

public boolean equals(java.lang.Object pObject)

Overrides:

equals in class java.lang.Object

setMode

public void setMode(KeywordType pMode)

Sets the mode, or keyword type

Parameters:

pMode -

setValue

public void setValue(java.lang.String pValue)

Sets the keywords, which should be space-delimited

Parameters:

pValue - keywords, space-delimited

getMode

public KeywordType getMode()

Returns the mode

Returns:

mode.

getValue

public java.lang.String getValue()

Returns the keywords

Returns:

Returns the value.

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

getRequestTag

public java.lang.String getRequestTag()

Specified by:

getRequestTag in class atg.search.routing.command.SearchXMLObject

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

setWeight

public void setWeight(java.lang.Float pWeight)

Sets the preference value if this expression is used in a weightedProps

Parameters:

pWeight -

getWeight

public java.lang.Float getWeight()

Returns the preference value if this expression is used in a weightedProps

Returns:

preference value if this expression is used in a weightedProps

valueOf

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

createFromParser

protected DocumentSetConstraint createFromParser(atg.search.routing.utils.SearchMessageNode pXml)

Specified by:

createFromParser in class DocumentSetConstraint