Module io.helidon.data.codegen.query

Package io.helidon.data.codegen.query

Interface CriteriaCondition

All Superinterfaces:

Prototype.Api

All Known Implementing Classes:

CriteriaCondition.BuilderBase.CriteriaConditionImpl

public interface CriteriaCondition
extends Prototype.Api

Criteria condition. Condition always consists of entity property, criteria parameters and condition operator, e.g. entity.age <= :age

See Also:

• builder()
• create()

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	CriteriaCondition.Builder	Fluent API builder for CriteriaCondition.
static class	CriteriaCondition.BuilderBase<BUILDER extends CriteriaCondition.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends CriteriaCondition>	Fluent API builder base for CriteriaCondition.

Method Summary

Modifier and Type	Method	Description
static CriteriaCondition.Builder	builder()	Create a new fluent API builder to customize configuration.
static CriteriaCondition.Builder	builder(CriteriaCondition instance)	Create a new fluent API builder from an existing instance.
static CriteriaCondition	create()	Create a new instance with default values.
static CriteriaCondition	createEqual(Property property)	Create criteria condition with CriteriaOperator.Equal.
static CriteriaCondition	createEqual(Property property, CharSequence parameter)	Create criteria condition with CriteriaOperator.Equal.
boolean	ignoreCase()	Whether String arguments are case-insensitive.
boolean	not()	Whether condition is negated.
CriteriaOperator	operator()	Condition operator.
Optional<CriteriaParameters>	parameters()	Condition parameters.
Property	property()	Condition entity property.

Method Details

builder

static CriteriaCondition.Builder builder()

Create a new fluent API builder to customize configuration.

Returns:

a new builder

builder

static CriteriaCondition.Builder builder(CriteriaCondition instance)

Create a new fluent API builder from an existing instance.

Parameters:

instance - an existing instance used as a base for the builder

Returns:

a builder based on an instance

create

static CriteriaCondition create()

Create a new instance with default values.

Returns:

a new instance

createEqual

static CriteriaCondition createEqual(Property property,
 CharSequence parameter)

Create criteria condition with CriteriaOperator.Equal. Condition parameter is set and will not be required externally.

Parameters:

property - condition entity property

parameter - condition parameter

Returns:

new instance of criteria condition

createEqual

static CriteriaCondition createEqual(Property property)

Create criteria condition with CriteriaOperator.Equal. Condition parameter is not set and must be provided later in query transformation stage.

Parameters:

property - condition entity property

Returns:

new instance of criteria condition

operator

CriteriaOperator operator()

Condition operator.

Returns:

the condition operator

property

Property property()

Condition entity property.

Returns:

the entity property

parameters

Optional<CriteriaParameters> parameters()

Condition parameters. Number of required parameters are specified by CriteriaOperator.paramsCount(). Parameters may be supplied as part of DataQuery definition or as part of query transformation process (e.g. as query method parameters).

Returns:

the condition parameters

not

boolean not()

Whether condition is negated.

Returns:

value of true when condition is negated or false otherwise

ignoreCase

boolean ignoreCase()

Whether String arguments are case-insensitive.

Returns:

value of true when String arguments are case-insensitive or false otherwise