Package jakarta.nosql.column

Interface ColumnCondition

public interface ColumnCondition

An unit condition to run a column family select

See Also:

ColumnFamilyManager.select(ColumnQuery)

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	ColumnCondition.ColumnConditionProvider	A Supplier of ColumnCondition where it will create from two parameters: The first one is Column The second one is the Condition

Method Summary

Modifier and Type	Method	Description
ColumnCondition	and(ColumnCondition condition)	Creates a new ColumnCondition using the Condition.AND
static ColumnCondition	and(ColumnCondition... conditions)	Returns a new ColumnCondition aggregating ,as ¨AND", all the conditions as just one condition.
static ColumnCondition	between(Column column)	Creates a ColumnCondition that has a Condition.BETWEEN, it means a select will scanning to a column family that is between two values informed on a column name.
static ColumnCondition	eq(Column column)	Creates a ColumnCondition that has a Condition.EQUALS, it means a select will scanning to a column family that has the same name and equals value informed in this column.
Column	getColumn()	Gets the column to be used in the select
Condition	getCondition()	Gets the conditions to be used in the select
static ColumnCondition	gt(Column column)	Creates a ColumnCondition that has a Condition.GREATER_THAN, it means a select will scanning to a column family that has the same name and the value greater than informed in this column.
static ColumnCondition	gte(Column column)	Creates a ColumnCondition that has a Condition.GREATER_EQUALS_THAN, it means a select will scanning to a column family that has the same name and the value greater or equals than informed in this column.
static ColumnCondition	in(Column column)	Creates a ColumnCondition that has a Condition.IN, it means a select will scanning to a column family that has the same name and the value is within informed in this column.
static ColumnCondition	like(Column column)	Creates a ColumnCondition that has a Condition.LIKE, it means a select will scanning to a column family that has the same name and the value is like than informed in this column.
static ColumnCondition	lt(Column column)	Creates a ColumnCondition that has a Condition.LESSER_THAN, it means a select will scanning to a column family that has the same name and the value lesser than informed in this column.
static ColumnCondition	lte(Column column)	Creates a ColumnCondition that has a Condition.LESSER_EQUALS_THAN, it means a select will scanning to a column family that has the same name and the value lesser or equals than informed in this column.
ColumnCondition	negate()	Creates a new ColumnCondition negating the current one
ColumnCondition	or(ColumnCondition condition)	Creates a new ColumnCondition using the Condition.OR
static ColumnCondition	or(ColumnCondition... conditions)	Returns a new ColumnCondition aggregating ,as ¨OR", all the conditions as just one condition.

Method Detail

getColumn

Column getColumn()

Gets the column to be used in the select

Returns:

a column instance

getCondition

Condition getCondition()

Gets the conditions to be used in the select

Returns:

a Condition instance

See Also:

Condition

and

ColumnCondition and(ColumnCondition condition)

Creates a new ColumnCondition using the Condition.AND

Parameters:

condition - the condition to be agregated

Returns:

the conditions joined as AND

Throws:

NullPointerException - when the condition is null

negate

ColumnCondition negate()

Creates a new ColumnCondition negating the current one

Returns:

the negated condition

See Also:

Condition.NOT

or

ColumnCondition or(ColumnCondition condition)

Creates a new ColumnCondition using the Condition.OR

Parameters:

condition - the condition to be agregated

Returns:

the conditions joined as AND

Throws:

NullPointerException - when the condition is null

eq

static ColumnCondition eq(Column column)

Creates a ColumnCondition that has a Condition.EQUALS, it means a select will scanning to a column family that has the same name and equals value informed in this column.

Parameters:

column - a column instance

Returns:

a ColumnCondition with Condition.EQUALS

Throws:

NullPointerException - when column is null

gt

static ColumnCondition gt(Column column)

Creates a ColumnCondition that has a Condition.GREATER_THAN, it means a select will scanning to a column family that has the same name and the value greater than informed in this column.

Parameters:

column - a column instance

Returns:

a ColumnCondition with Condition.GREATER_THAN

Throws:

NullPointerException - when column is null

gte

static ColumnCondition gte(Column column)

Creates a ColumnCondition that has a Condition.GREATER_EQUALS_THAN, it means a select will scanning to a column family that has the same name and the value greater or equals than informed in this column.

Parameters:

column - a column instance

Returns:

a ColumnCondition with Condition.GREATER_EQUALS_THAN

Throws:

NullPointerException - when column is null

lt

static ColumnCondition lt(Column column)

Creates a ColumnCondition that has a Condition.LESSER_THAN, it means a select will scanning to a column family that has the same name and the value lesser than informed in this column.

Parameters:

column - a column instance

Returns:

a ColumnCondition with Condition.LESSER_THAN

Throws:

NullPointerException - when column is null

lte

static ColumnCondition lte(Column column)

Creates a ColumnCondition that has a Condition.LESSER_EQUALS_THAN, it means a select will scanning to a column family that has the same name and the value lesser or equals than informed in this column.

Parameters:

column - a column instance

Returns:

a ColumnCondition with Condition.LESSER_EQUALS_THAN

Throws:

NullPointerException - when column is null

in

static ColumnCondition in(Column column)

Creates a ColumnCondition that has a Condition.IN, it means a select will scanning to a column family that has the same name and the value is within informed in this column.

Parameters:

column - a column instance

Returns:

a ColumnCondition with Condition.IN

Throws:

NullPointerException - when column is null

IllegalArgumentException - when the Column.get() in not an iterable implementation

like

static ColumnCondition like(Column column)

Creates a ColumnCondition that has a Condition.LIKE, it means a select will scanning to a column family that has the same name and the value is like than informed in this column.

Parameters:

column - a column instance

Returns:

a ColumnCondition with Condition.LIKE

Throws:

NullPointerException - when column is null

between

static ColumnCondition between(Column column)

Creates a ColumnCondition that has a Condition.BETWEEN, it means a select will scanning to a column family that is between two values informed on a column name. The column must have a Column.get() an Iterable implementation with just two elements.

Parameters:

column - a column instance

Returns:

The between condition

Throws:

NullPointerException - when column is null

IllegalArgumentException - When the column neither has an Iterable instance or two elements on an Iterable.

and

static ColumnCondition and(ColumnCondition... conditions)

Returns a new ColumnCondition aggregating ,as ¨AND", all the conditions as just one condition. The Column will storage the Condition.getNameField() as key and the value gonna be the List of all conditions, in other words.

Given:

Column age = Column.of("age", 26); Column name = Column.of("name", "otavio"); ColumnCondition condition = ColumnCondition.eq(name).and(ColumnCondition.gte(age)); The getColumn() will have "_AND" as key and the list of condition as value.

Parameters:

conditions - the conditions to be aggregated

Returns:

the new ColumnCondition instance

Throws:

NullPointerException - when the conditions is null

or

static ColumnCondition or(ColumnCondition... conditions)

Returns a new ColumnCondition aggregating ,as ¨OR", all the conditions as just one condition. The Column will storage the Condition.getNameField() as key and the value gonna be the List of all conditions, in other words.

Given:

Column age = Column.of("age", 26); Column name = Column.of("name", "otavio"); ColumnCondition condition = ColumnCondition.eq(name).or(ColumnCondition.gte(age)); The getColumn() will have "_OR" as key and the list of condition as value.

Parameters:

conditions - the conditions to be aggregated

Returns:

the new ColumnCondition instance

Throws:

NullPointerException - when the condition is null