atg.search.routing.command.search
Class KeywordConstraint

java.lang.Object
  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 KeywordConstraint	createFromParser(atg.search.routing.utils.FastXMLModel pXml, int rootIdx)
KeywordType	getMode() Returns the mode
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
java.lang.String	toXml() Converts this constraint to the XML representation that can be sent in request.
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, 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

Constructor Detail

KeywordConstraint

public KeywordConstraint()

Method Detail

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.

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

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 KeywordConstraint createFromParser(atg.search.routing.utils.FastXMLModel pXml,
                                             int rootIdx)

Specified by:

createFromParser in class DocumentSetConstraint