com.adobe.cq.social.ugc.api

Class FullTextConstraint

java.lang.Object

com.adobe.cq.social.ugc.api.AbstractConstraint

com.adobe.cq.social.ugc.api.FullTextConstraint

All Implemented Interfaces:

Constraint

public class FullTextConstraint
extends AbstractConstraint
implements Constraint

FullTextConstraint restricts the results to a specific full text expression.

Constructor Summary

Constructors

Constructor and Description
FullTextConstraint(String expression) Creates a new instance of FullTextConstraint with the given expression.
FullTextConstraint(String expression, String propertyName) Creates a new instance of FullTextConstraint with the given expression.

Method Summary

Modifier and Type	Method and Description
void	accept(ConstraintVisitor constraintVisitor) Visit this constraint.
boolean	definesPropertiesToInclude() Gets whether or not the constraint defines which properties should be included in the full text search.
String	getExpression() Gets the full text expression to match.
List<String>	getIncludedProperties() Gets the list of included properties.
void	includeProperty(String propertyName) Adds a property to include in the full text search.
void	setExpression(String expression) Sets the full text expression to match.

Methods inherited from class com.adobe.cq.social.ugc.api.AbstractConstraint

getOperator, isNegated, negate, setOperator

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.adobe.cq.social.ugc.api.Constraint

getOperator, isNegated, negate, setOperator

Constructor Detail

FullTextConstraint

public FullTextConstraint(String expression)

Creates a new instance of FullTextConstraint with the given expression.

Parameters:

expression - String containing the full text expression.

FullTextConstraint

public FullTextConstraint(String expression,
                          String propertyName)

Creates a new instance of FullTextConstraint with the given expression.

Parameters:

expression - String containing the full text expression.

propertyName - String containing the name of a property to include in the search.

Method Detail

definesPropertiesToInclude

public boolean definesPropertiesToInclude()

Gets whether or not the constraint defines which properties should be included in the full text search.

Returns:

True if this constraint defines the properties to include, false otherwise.

includeProperty

public void includeProperty(String propertyName)

Adds a property to include in the full text search.

Parameters:

propertyName - String containing the name of the property to include.

getExpression

public String getExpression()

Gets the full text expression to match.

Returns:

String containing the full text expression.

setExpression

public void setExpression(String expression)

Sets the full text expression to match.

Parameters:

expression - String containing the full text expression to match.

getIncludedProperties

public List<String> getIncludedProperties()

Gets the list of included properties.

Returns:

the list of included properties.

accept

public void accept(ConstraintVisitor constraintVisitor)

Visit this constraint.

Specified by:

accept in interface Constraint

Parameters:

constraintVisitor - the visitor for this constraint.