org.seasar.doma.jdbc.entity

Interface EntityPropertyType<ENTITY,BASIC>

Type Parameters:

ENTITY - the entity type

BASIC - the basic type

All Known Implementing Classes:

AssignedIdPropertyType, DefaultPropertyType, GeneratedIdPropertyType, TenantIdPropertyType, VersionPropertyType

public interface EntityPropertyType<ENTITY,BASIC>

A entity property description.

This instance is not required to be thread safe.

Method Summary

Modifier and Type	Method and Description
void	copy(ENTITY dest, ENTITY src) Copies this property value.
Property<ENTITY,BASIC>	createProperty() Creates the property.
java.lang.String	getColumnName() Return the column name.
java.lang.String	getColumnName(java.util.function.BiFunction<NamingType,java.lang.String,java.lang.String> namingFunction) Return the column name.
java.lang.String	getColumnName(java.util.function.BiFunction<NamingType,java.lang.String,java.lang.String> namingFunction, java.util.function.Function<java.lang.String,java.lang.String> quoteFunction) Return the column name.
java.lang.String	getColumnName(java.util.function.Function<java.lang.String,java.lang.String> quoteFunction) Return the column name.
java.lang.String	getName() Returns the property name.
boolean	isId() Whether this property is an identifier.
boolean	isInsertable() Whether the column that is mapped to this property is included in SQL INSERT statements.
boolean	isQuoteRequired() Whether quotation marks are required to the column name.
boolean	isTenantId() Whether this property is a tenant id.
boolean	isUpdatable() Whether the column that is mapped to this property is included in SQL UPDATE statements.
boolean	isVersion() Whether this property is a version.

Method Detail

getName

java.lang.String getName()

Returns the property name.

Returns:

the property name

getColumnName

java.lang.String getColumnName()

Return the column name.

Returns:

the column name

getColumnName

java.lang.String getColumnName(java.util.function.Function<java.lang.String,java.lang.String> quoteFunction)

Return the column name.

Parameters:

quoteFunction - the function that applies quotation marks

Returns:

the name of the column.

getColumnName

java.lang.String getColumnName(java.util.function.BiFunction<NamingType,java.lang.String,java.lang.String> namingFunction)

Return the column name.

Parameters:

namingFunction - the function that applies naming convention

Returns:

the name of the column.

getColumnName

java.lang.String getColumnName(java.util.function.BiFunction<NamingType,java.lang.String,java.lang.String> namingFunction,
                               java.util.function.Function<java.lang.String,java.lang.String> quoteFunction)

Return the column name.

Parameters:

namingFunction - the function that applies naming convention

quoteFunction - the function that applies quotation marks

Returns:

the name of the column

isQuoteRequired

boolean isQuoteRequired()

Whether quotation marks are required to the column name.

Returns:

true if required

isId

boolean isId()

Whether this property is an identifier.

Returns:

true if this property is an identifier

isVersion

boolean isVersion()

Whether this property is a version.

Returns:

true if this property is a version

isTenantId

boolean isTenantId()

Whether this property is a tenant id.

Returns:

true if this property is a tenant id

isInsertable

boolean isInsertable()

Whether the column that is mapped to this property is included in SQL INSERT statements.

Returns:

true if included in SQL INSERT statements.

isUpdatable

boolean isUpdatable()

Whether the column that is mapped to this property is included in SQL UPDATE statements.

Returns:

true if included in SQL UPDATE statements.

createProperty

Property<ENTITY,BASIC> createProperty()

Creates the property.

Returns:

the property

copy

void copy(ENTITY dest,
          ENTITY src)

Copies this property value.

This method does deep copy. But this method does not copy JDBC specific objects such as Blob.

Parameters:

dest - the entity that is the copy destination

src - the entity that is the copy source