com.primus.searchcommon.constraint
Class SetConstraint

java.lang.Object
  com.primus.searchcommon.constraint.BaseConstraint
      com.primus.searchcommon.constraint.SetConstraint

All Implemented Interfaces:

DocumentSetConstraint, 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

Constructor Summary

SetConstraint(java.lang.String pPath)

SetConstraint(java.lang.String pPath, boolean pRecurse)
Deprecated. Use SetConstraint(String, Boolean)

SetConstraint(java.lang.String pPath, java.lang.Boolean pRecurse)

SetConstraint(java.lang.String pPath, java.lang.Boolean pRecurse, java.lang.Float weight)
use others to use default values for recurse and weight

Method Summary

java.lang.String	getPath()
java.lang.Float	getWeight()
java.lang.Boolean	isRecurse()
void	setWeight(java.lang.Float weight)
java.lang.String	toXml() Converts this constraint to the XML representation that can be sent in the ES Query.

Methods inherited from class com.primus.searchcommon.constraint.BaseConstraint

escapeToXml, toString

Methods inherited from class java.lang.Object

clone, equals, 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

SetConstraint

public SetConstraint(java.lang.String pPath,
                     java.lang.Boolean pRecurse,
                     java.lang.Float weight)

use others to use default values for recurse and weight

Parameters:

pPath -

pRecurse -

weight -

SetConstraint

public SetConstraint(java.lang.String pPath,
                     boolean pRecurse)

Deprecated. Use SetConstraint(String, Boolean)

SetConstraint

public SetConstraint(java.lang.String pPath,
                     java.lang.Boolean pRecurse)

SetConstraint

public SetConstraint(java.lang.String pPath)

Parameters:

pPath -

Method Detail

getWeight

public java.lang.Float getWeight()

setWeight

public void setWeight(java.lang.Float weight)

getPath

public java.lang.String getPath()

Returns:

Returns the path.

isRecurse

public java.lang.Boolean isRecurse()

Returns:

Returns the recurse.

toXml

public java.lang.String toXml()

Description copied from interface: DocumentSetConstraint

Converts this constraint to the XML representation that can be sent in the ES Query.

Returns: