com.adobe.cq.social.ugc.api

Class RangeConstraint<T>

java.lang.Object

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

com.adobe.cq.social.ugc.api.AbstractPropertyConstraint

com.adobe.cq.social.ugc.api.RangeConstraint<T>

Type Parameters:

T - the type of object that is being queried.

All Implemented Interfaces:

Constraint

public class RangeConstraint<T>
extends AbstractPropertyConstraint
implements Constraint

RangeConstraint is a property constraint which restricts the value of a property to a specific range.

Constructor Summary

Constructors

Constructor and Description
RangeConstraint(java.lang.String propertyName, T minValue, T maxValue) Creates a new instance of RangeConstraint (inclusive) against the given propertyName with minValue and maxValue.
RangeConstraint(java.lang.String propertyName, T minValue, T maxValue, boolean inclusive) Creates a new instance of RangeConstraint against the given propertyName with minValue and maxValue.
RangeConstraint(java.lang.String propertyName, T minValue, T maxValue, boolean inclusive, Operator operator) Creates a new instance of RangeConstraint against the given propertyName with minValue and maxValue.

Method Summary

Modifier and Type	Method and Description
void	accept(ConstraintVisitor constraintVisitor) Visit this range constraint.
T	getMaxValue() Gets the maximum value of this constraint.
T	getMinValue() Gets the minimum value of this constraint.
boolean	isInclusive() Whether the range should include the minimum value and maximum value (inclusive) or not.
void	setMaxValue(T maxValue) Gets the maximum value of this constraint.
void	setMinValue(T minValue) Sets the minimum value of this constraint.

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

getPropertyName

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

RangeConstraint

public RangeConstraint(java.lang.String propertyName,
                       T minValue,
                       T maxValue)

Creates a new instance of RangeConstraint (inclusive) against the given propertyName with minValue and maxValue.

Parameters:

propertyName - Name of the property being constrained.

minValue - Minimum value for the range.

maxValue - Maximum value for the range.

RangeConstraint

public RangeConstraint(java.lang.String propertyName,
                       T minValue,
                       T maxValue,
                       boolean inclusive)

Creates a new instance of RangeConstraint against the given propertyName with minValue and maxValue.

Parameters:

propertyName - Name of the property being constrained.

minValue - Minimum value for the range.

maxValue - Maximum value for the range.

inclusive - True if the results should include minValue and maxValue, false otherwise.

RangeConstraint

public RangeConstraint(java.lang.String propertyName,
                       T minValue,
                       T maxValue,
                       boolean inclusive,
                       Operator operator)

Creates a new instance of RangeConstraint against the given propertyName with minValue and maxValue.

Parameters:

propertyName - Name of the property being constrained.

minValue - Minimum value for the range.

maxValue - Maximum value for the range.

inclusive - True if the results should include minValue and maxValue, false otherwise.

operator - Operator that defines how this constraint is joined with other constraints.

Method Detail

getMinValue

public T getMinValue()

Gets the minimum value of this constraint.

Returns:

The minimum value of this constraint.

setMinValue

public void setMinValue(T minValue)

Sets the minimum value of this constraint.

Parameters:

minValue - The minimum value of this constraint.

getMaxValue

public T getMaxValue()

Gets the maximum value of this constraint.

Returns:

The maximum value of this constraint.

setMaxValue

public void setMaxValue(T maxValue)

Gets the maximum value of this constraint.

Parameters:

maxValue - The minimum value of this constraint.

isInclusive

public boolean isInclusive()

Whether the range should include the minimum value and maximum value (inclusive) or not.

Returns:

True if the range is inclusive, false otherwise.

accept

public void accept(ConstraintVisitor constraintVisitor)

Visit this range constraint.

Specified by:

accept in interface Constraint

Parameters:

constraintVisitor - the ConstraintVisitor.