Module is.codion.framework.domain

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

Interface ColumnDefinition<T>

Type Parameters:

T - the underlying type

All Superinterfaces:

AttributeDefinition<T>

All Known Subinterfaces:

AuditColumnDefinition<T>

public interface ColumnDefinition<T>
extends AttributeDefinition<T>

Specifies a attribute definition based on a table column

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	ColumnDefinition.Builder<T,B extends ColumnDefinition.Builder<T,B>>	Builds a ColumnDefinition

Nested classes/interfaces inherited from interface is.codion.framework.domain.entity.attribute.AttributeDefinition

AttributeDefinition.ValueSupplier<T>

Field Summary

Fields inherited from interface is.codion.framework.domain.entity.attribute.AttributeDefinition

DATE_FORMAT, DATE_TIME_FORMAT, DECIMAL_ROUNDING_MODE, DECIMAL_SEPARATOR, DEFAULT_MAXIMUM_FRACTION_DIGITS, GROUPING_SEPARATOR, MAXIMUM_FRACTION_DIGITS, MNEMONIC_RESOURCE_SUFFIX, NUMBER_FORMAT_GROUPING, TIME_FORMAT, TRIM_STRINGS, USE_LEXICAL_STRING_COMPARATOR

Method Summary

Modifier and Type	Method	Description
boolean	aggregate()
Column<T>	attribute()	The Attribute this definition is based on, should be unique within an Entity.
boolean	columnHasDefaultValue()
<C> Column.Converter<C,T>	converter()	Note: returns null when used in a remote connection context.
String	expression()	Note: returns null when used in a remote connection context.
T	get(ResultSet resultSet, int index)	Fetches a value for this column from a ResultSet
boolean	groupBy()
boolean	insertable()	Specifies whether this column is insertable
String	name()	Note: returns null when used in a remote connection context.
boolean	primaryKey()
int	primaryKeyIndex()
boolean	readOnly()
boolean	searchable()
boolean	selected()
void	set(PreparedStatement statement, int index, T value)	Sets a parameter for this column in a PreparedStatement
int	type()
boolean	updatable()	Indicates whether this column is updatable

Methods inherited from interface is.codion.framework.domain.entity.attribute.AttributeDefinition

caption, comparator, dateTimeFormatter, dateTimePattern, decimalRoundingMode, defaultValue, derived, description, entityType, format, hasDefaultValue, hidden, items, maximumFractionDigits, maximumLength, maximumValue, minimumValue, mnemonic, nullable, string, trim, validItem

Method Details

attribute

Column<T> attribute()

Description copied from interface: AttributeDefinition

The Attribute this definition is based on, should be unique within an Entity. By default, the Attribute.name() serves as column name for database columns.

Specified by:

attribute in interface AttributeDefinition<T>

Returns:

the attribute this definition is based on

name

String name()

Note: returns null when used in a remote connection context.

Returns:

the column name

expression

String expression()

Note: returns null when used in a remote connection context.

Returns:

the column expression to use when selecting or the column name if no expression has been set

type

int type()

Returns:

the sql data type of the underlying column (Types.

converter

<C> Column.Converter<C,T> converter()

Note: returns null when used in a remote connection context.

Type Parameters:

C - the colum value type

Returns:

the Column.Converter for this column.

primaryKeyIndex

int primaryKeyIndex()

Returns:

this columns zero based index in the primary key, -1 if this column is not part of a primary key

primaryKey

boolean primaryKey()

Returns:

true if this column is part of a primary key

groupBy

boolean groupBy()

Returns:

true if this column should be grouped by

aggregate

boolean aggregate()

Returns:

true if this column is based on an aggregate function

selected

boolean selected()

Returns:

true if this column should be selected by default

insertable

boolean insertable()

Specifies whether this column is insertable

Returns:

true if this column is insertable

updatable

boolean updatable()

Indicates whether this column is updatable

Returns:

true if this column is updatable

readOnly

boolean readOnly()

Returns:

true if this column is neither insertable nor updatable.

columnHasDefaultValue

boolean columnHasDefaultValue()

Returns:

true if the underlying column has a default value

searchable

boolean searchable()

Returns:

true if this column should be included when searching by string

get

T get(ResultSet resultSet,
 int index)
throws SQLException

Fetches a value for this column from a ResultSet

Parameters:

resultSet - the ResultSet

index - this columns index in the result

Returns:

a single value fetched from the given ResultSet

Throws:

SQLException - in case of an exception

set

void set(PreparedStatement statement,
 int index,
 T value)
  throws SQLException

Sets a parameter for this column in a PreparedStatement

Parameters:

statement - the statement

index - the parameter index

value - the value to set, may be null

Throws:

SQLException - in case of an exception