Module is.codion.framework.domain

Package is.codion.framework.domain.entity.attribute

Interface Column.ColumnDefiner<T>

Type Parameters:

T - the column type

All Superinterfaces:

Attribute.AttributeDefiner<T>

Enclosing interface:

Column<T>

public static interface Column.ColumnDefiner<T>
extends Attribute.AttributeDefiner<T>

Provides ColumnDefinition.Builder instances.

Method Summary

Modifier and Type	Method	Description
<B extends ColumnDefinition.Builder<T, B>> ColumnDefinition.Builder<T,B>	auditInsertTimeColumn()	Creates a new ColumnDefinition.Builder instance, representing the time a row was inserted.
<B extends ColumnDefinition.Builder<String, B>> ColumnDefinition.Builder<String,B>	auditInsertUserColumn()	Creates a new ColumnDefinition.Builder instance, representing the username of the user who inserted a row.
<B extends ColumnDefinition.Builder<T, B>> ColumnDefinition.Builder<T,B>	auditUpdateTimeColumn()	Creates a new ColumnDefinition.Builder instance, representing the time a row was updated.
<B extends ColumnDefinition.Builder<String, B>> ColumnDefinition.Builder<String,B>	auditUpdateUserColumn()	Creates a new ColumnDefinition.Builder instance, representing the username of the user who updated a row.
<C, B extends ColumnDefinition.Builder<Boolean, B>> ColumnDefinition.Builder<Boolean,B>	booleanColumn(Class<C> columnClass, C trueValue, C falseValue)	Creates a new ColumnDefinition.Builder instance representing a Boolean value.
static <C> Column.Converter<Boolean,C>	booleanConverter(C trueValue, C falseValue)	A convenience method for a Column.Converter for boolean columns
<B extends ColumnDefinition.Builder<T, B>> ColumnDefinition.Builder<T,B>	column()	Creates a new ColumnDefinition.Builder instance.
<B extends ColumnDefinition.Builder<T, B>> ColumnDefinition.Builder<T,B>	primaryKey()	Returns a new ColumnDefinition.Builder instance, with the primary key index 0.
<B extends ColumnDefinition.Builder<T, B>> ColumnDefinition.Builder<T,B>	primaryKey(int index)	Returns a new ColumnDefinition.Builder instance, with the given primary key index.
<B extends ColumnDefinition.Builder<T, B>> ColumnDefinition.Builder<T,B>	subquery(String subquery)	Creates a new ColumnDefinition.Builder instance, based on a subquery.

Methods inherited from interface is.codion.framework.domain.entity.attribute.Attribute.AttributeDefiner

attribute, denormalized, derived

Method Details

column

<B extends ColumnDefinition.Builder<T,
B>>
ColumnDefinition.Builder<T,B> column()

Creates a new ColumnDefinition.Builder instance.

Type Parameters:

B - the builder type

Returns:

a new ColumnDefinition.Builder

primaryKey

<B extends ColumnDefinition.Builder<T,
B>>
ColumnDefinition.Builder<T,B> primaryKey()

Returns a new ColumnDefinition.Builder instance, with the primary key index 0. Note that this renders this column non-null and non-updatable by default, this can be reverted by setting it as updatable and/or nullable after defining a primary key column.

   ...
   .primaryKey()
   .nullable(true)
   .updatable(true)
 

Type Parameters:

B - the builder type

Returns:

a new ColumnDefinition.Builder with primary key index 0

See Also:

• AttributeDefinition.Builder.nullable(boolean)
• ColumnDefinition.Builder.updatable(boolean)

primaryKey

<B extends ColumnDefinition.Builder<T,
B>>
ColumnDefinition.Builder<T,B> primaryKey(int index)

Returns a new ColumnDefinition.Builder instance, with the given primary key index. Note that this renders this column non-null and non-updatable by default, this can be reverted by setting it as updatable and/or nullable after defining a primary key column.

   ...
   .primaryKey()
   .nullable(true)
   .updatable(true)
 

Type Parameters:

B - the builder type

Parameters:

index - the zero-based index of this column in the primary key

Returns:

a new ColumnDefinition.Builder with the given primary key index

Throws:

IllegalArgumentException - in case index is a negative number

See Also:

• AttributeDefinition.Builder.nullable(boolean)
• ColumnDefinition.Builder.updatable(boolean)

subquery

<B extends ColumnDefinition.Builder<T,
B>>
ColumnDefinition.Builder<T,B> subquery(String subquery)

Creates a new ColumnDefinition.Builder instance, based on a subquery.

Type Parameters:

B - the builder type

Parameters:

subquery - the sql query

Returns:

a new ColumnDefinition.Builder

booleanColumn

<C,
B extends ColumnDefinition.Builder<Boolean,
B>>
ColumnDefinition.Builder<Boolean,B> booleanColumn(Class<C> columnClass,
 C trueValue,
 C falseValue)

Creates a new ColumnDefinition.Builder instance representing a Boolean value.

Type Parameters:

C - the column type

B - the builder type

Parameters:

columnClass - the underlying column data type class

trueValue - the value representing 'true' in the underlying column

falseValue - the value representing 'false' in the underlying column

Returns:

a new ColumnDefinition.Builder

Throws:

NullPointerException - in case either the true or false value is null

IllegalStateException - in case this column is not a boolean column

IllegalArgumentException - in case the values representing true and false are equal

auditInsertTimeColumn

<B extends ColumnDefinition.Builder<T,
B>>
ColumnDefinition.Builder<T,B> auditInsertTimeColumn()

Creates a new ColumnDefinition.Builder instance, representing the time a row was inserted.

Type Parameters:

B - the builder type

Returns:

a new ColumnDefinition.Builder

auditUpdateTimeColumn

<B extends ColumnDefinition.Builder<T,
B>>
ColumnDefinition.Builder<T,B> auditUpdateTimeColumn()

Creates a new ColumnDefinition.Builder instance, representing the time a row was updated.

Type Parameters:

B - the builder type

Returns:

a new ColumnDefinition.Builder

auditInsertUserColumn

<B extends ColumnDefinition.Builder<String,
B>>
ColumnDefinition.Builder<String,B> auditInsertUserColumn()

Creates a new ColumnDefinition.Builder instance, representing the username of the user who inserted a row.

Type Parameters:

B - the builder type

Returns:

a new ColumnDefinition.Builder

auditUpdateUserColumn

<B extends ColumnDefinition.Builder<String,
B>>
ColumnDefinition.Builder<String,B> auditUpdateUserColumn()

Creates a new ColumnDefinition.Builder instance, representing the username of the user who updated a row.

Type Parameters:

B - the builder type

Returns:

a new ColumnDefinition.Builder

booleanConverter

static <C> Column.Converter<Boolean,C> booleanConverter(C trueValue,
 C falseValue)

A convenience method for a Column.Converter for boolean columns

Type Parameters:

C - the actual column type

Parameters:

trueValue - the true value

falseValue - the false value

Returns:

a boolean value converter

Throws:

NullPointerException - in case either the true or false value is null

IllegalArgumentException - in case the values representing true and false are equal