org.xcmis.search.model.constraint
Class FullTextSearch

java.lang.Object
  org.xcmis.search.model.constraint.Constraint
      org.xcmis.search.model.constraint.FullTextSearch

All Implemented Interfaces:

Serializable, QueryElement

public class FullTextSearch
extends Constraint

A constraint that evaluates to true only when a full-text search applied to the search scope results in positive findings. If a property name is supplied, then the search is limited to the value(s) of the named property on the node(s) in the search scope.

See Also:

Serialized Form

Constructor Summary

FullTextSearch(SelectorName selectorName, String propertyName, String fullTextSearchExpression)
Create a constraint defining a full-text search against the property values on node within the search scope.

Method Summary

void	accept(QueryObjectModelVisitor visitor) Accepts a visitor and calls the appropriate visit method depending on the type of this QOM node.
boolean	equals(Object obj)
String	getFullTextSearchExpression() Get the full-text search expression, as a string.
String	getPropertyName() Get the name of the property that is to be searched.
SelectorName	getSelectorName() Get the name of the selector that is to be searched.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

FullTextSearch

public FullTextSearch(SelectorName selectorName,
                      String propertyName,
                      String fullTextSearchExpression)

Create a constraint defining a full-text search against the property values on node within the search scope.

Parameters:

selectorName - the name of the node selector defining the search scope

propertyName - the name of the property to be searched; may be null if all property values are to be searched

fullTextSearchExpression - the search expression

Method Detail

accept

public void accept(QueryObjectModelVisitor visitor)
            throws VisitException

Description copied from interface: QueryElement

Accepts a visitor and calls the appropriate visit method depending on the type of this QOM node.

Parameters:

visitor - the visitor.

Throws:

VisitException

See Also:

QueryElement.accept(org.xcmis.search.QueryObjectModelVisitor)

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

See Also:

Object.equals(java.lang.Object)

getFullTextSearchExpression

public final String getFullTextSearchExpression()

Get the full-text search expression, as a string.

Returns:

the search expression; never null

getPropertyName

public final String getPropertyName()

Get the name of the property that is to be searched.

Returns:

the property name; never null

getSelectorName

public final SelectorName getSelectorName()

Get the name of the selector that is to be searched.

Returns:

the selector name; never null

hashCode

public int hashCode()

Overrides:

hashCode in class Object

See Also:

Object.hashCode()

toString

public String toString()

Overrides:

toString in class Object

See Also:

Object.toString()