Top Description Inners Fields Constructors Methods
org.hibernate.query.criteria.internal.predicate

public Class ComparisonPredicate

extends AbstractSimplePredicate
implements BinaryOperatorExpression<Boolean>, Serializable
Class Inheritance
All Implemented Interfaces
java.io.Serializable, org.hibernate.query.criteria.internal.expression.BinaryOperatorExpression, javax.persistence.criteria.Expression, javax.persistence.criteria.Selection, javax.persistence.TupleElement
Imports
java.io.Serializable, javax.persistence.criteria.Expression, org.hibernate.query.criteria.internal.CriteriaBuilderImpl, .ParameterRegistry, .Renderable, .ValueHandlerFactory, org.hibernate.query.criteria.internal.compile.RenderingContext, org.hibernate.query.criteria.internal.expression.BinaryOperatorExpression, .LiteralExpression

Models a basic relational comparison predicate.
Author
Steve Ebersole

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static enum
ComparisonPredicate.ComparisonOperator

Defines the comparison operators.

Field Summary

Modifier and TypeField and Description
private final ComparisonPredicate.ComparisonOperator
private final Expression<?>
private final Expression<?>

Constructor Summary

AccessConstructor and Description
public
ComparisonPredicate(CriteriaBuilderImpl criteriaBuilder, ComparisonPredicate.ComparisonOperator comparisonOperator, Expression<?> leftHandSide, Expression<?> rightHandSide)

public
ComparisonPredicate(CriteriaBuilderImpl criteriaBuilder, ComparisonPredicate.ComparisonOperator comparisonOperator, Expression<?> leftHandSide, Object rightHandSide)

public <N extends Number>
ComparisonPredicate(CriteriaBuilderImpl criteriaBuilder, ComparisonPredicate.ComparisonOperator comparisonOperator, Expression<N> leftHandSide, Number rightHandSide)

Method Summary

Modifier and TypeMethod and Description
public ComparisonPredicate.ComparisonOperator
public ComparisonPredicate.ComparisonOperator
getComparisonOperator(boolean isNegated)

public Expression<T>
public Expression<T>
public void
registerParameters(ParameterRegistry
The parameter registry with which to register.
registry
)

Implements org.hibernate.query.criteria.internal.ParameterContainer.registerParameters.

Register any parameters contained within this query component with the given registry.
public String
render(boolean
Should the predicate be negated.
isNegated
,
RenderingContext
The context for rendering
renderingContext
)

Implements org.hibernate.query.criteria.internal.predicate.PredicateImplementor.render.

Form of Renderable#render used when the predicate is wrapped in a negated wrapper.
Inherited from org.hibernate.query.criteria.internal.predicate.AbstractSimplePredicate:
getExpressionsgetOperatorisJunctionrender

Field Detail

comparisonOperatorback to summary
private final ComparisonPredicate.ComparisonOperator comparisonOperator
leftHandSideback to summary
private final Expression<?> leftHandSide
rightHandSideback to summary
private final Expression<?> rightHandSide

Constructor Detail

ComparisonPredicateback to summary
public ComparisonPredicate(CriteriaBuilderImpl criteriaBuilder, ComparisonPredicate.ComparisonOperator comparisonOperator, Expression<?> leftHandSide, Expression<?> rightHandSide)
ComparisonPredicateback to summary
public ComparisonPredicate(CriteriaBuilderImpl criteriaBuilder, ComparisonPredicate.ComparisonOperator comparisonOperator, Expression<?> leftHandSide, Object rightHandSide)
Annotations
@SuppressWarnings:unchecked
ComparisonPredicateback to summary
public <N extends Number> ComparisonPredicate(CriteriaBuilderImpl criteriaBuilder, ComparisonPredicate.ComparisonOperator comparisonOperator, Expression<N> leftHandSide, Number rightHandSide)
Annotations
@SuppressWarnings:unchecked

Method Detail

getComparisonOperatorback to summary
public ComparisonPredicate.ComparisonOperator getComparisonOperator()
getComparisonOperatorback to summary
public ComparisonPredicate.ComparisonOperator getComparisonOperator(boolean isNegated)
getLeftHandOperandback to summary
public Expression<T> getLeftHandOperand()

Implements org.hibernate.query.criteria.internal.expression.BinaryOperatorExpression.getLeftHandOperand.

Doc from org.hibernate.query.criteria.internal.expression.BinaryOperatorExpression.getLeftHandOperand.

Get the left-hand operand.

Returns:Expression<T>

The left-hand operand.

Annotations
@Override
getRightHandOperandback to summary
public Expression<T> getRightHandOperand()

Implements org.hibernate.query.criteria.internal.expression.BinaryOperatorExpression.getRightHandOperand.

Doc from org.hibernate.query.criteria.internal.expression.BinaryOperatorExpression.getRightHandOperand.

Get the right-hand operand.

Returns:Expression<T>

The right-hand operand.

Annotations
@Override
registerParametersback to summary
public void registerParameters(ParameterRegistry registry)

Implements org.hibernate.query.criteria.internal.ParameterContainer.registerParameters.

Doc from org.hibernate.query.criteria.internal.ParameterContainer.registerParameters.

Register any parameters contained within this query component with the given registry.

Parameters
registry:ParameterRegistry

The parameter registry with which to register.

Annotations
@Override
renderback to summary
public String render(boolean isNegated, RenderingContext renderingContext)

Implements org.hibernate.query.criteria.internal.predicate.PredicateImplementor.render.

Doc from org.hibernate.query.criteria.internal.predicate.PredicateImplementor.render.

Form of Renderable#render used when the predicate is wrapped in a negated wrapper. Allows passing down the negation flag.

Note that this form is no-op in compound (junction) predicates. The reason being that compound predicates are more complex and the negation is applied during its creation.

Parameters
isNegated:boolean

Should the predicate be negated.

renderingContext:RenderingContext

The context for rendering

Returns:String

The rendered predicate fragment.

Annotations
@Override
org.hibernate.query.criteria.internal.predicate back to summary

public sealed Enum ComparisonPredicate.ComparisonOperator

extends Enum<ComparisonPredicate.ComparisonOperator>
Class Inheritance

Defines the comparison operators. We could also get away with only 3 and use negation...

Field Summary

Modifier and TypeField and Description
public static final ComparisonPredicate.ComparisonOperator
public static final ComparisonPredicate.ComparisonOperator
public static final ComparisonPredicate.ComparisonOperator
public static final ComparisonPredicate.ComparisonOperator
public static final ComparisonPredicate.ComparisonOperator
public static final ComparisonPredicate.ComparisonOperator

Constructor Summary

AccessConstructor and Description
private

Method Summary

Modifier and TypeMethod and Description
public abstract ComparisonPredicate.ComparisonOperator
public abstract String
public static ComparisonPredicate.ComparisonOperator
public static ComparisonPredicate.ComparisonOperator[]
Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinaltoStringvalueOf

Field Detail

EQUALback to summary
public static final ComparisonPredicate.ComparisonOperator EQUAL
GREATER_THANback to summary
public static final ComparisonPredicate.ComparisonOperator GREATER_THAN
GREATER_THAN_OR_EQUALback to summary
public static final ComparisonPredicate.ComparisonOperator GREATER_THAN_OR_EQUAL
LESS_THANback to summary
public static final ComparisonPredicate.ComparisonOperator LESS_THAN
LESS_THAN_OR_EQUALback to summary
public static final ComparisonPredicate.ComparisonOperator LESS_THAN_OR_EQUAL
NOT_EQUALback to summary
public static final ComparisonPredicate.ComparisonOperator NOT_EQUAL

Constructor Detail

ComparisonOperatorback to summary
private ComparisonOperator()

Method Detail

negatedback to summary
public abstract ComparisonPredicate.ComparisonOperator negated()
renderedback to summary
public abstract String rendered()
valueOfback to summary
public static ComparisonPredicate.ComparisonOperator valueOf(String name)
valuesback to summary
public static ComparisonPredicate.ComparisonOperator[] values()