org.seasar.doma.jdbc.entity

Class DefaultPropertyType<ENTITY,BASIC,CONTAINER>

java.lang.Object

org.seasar.doma.jdbc.entity.DefaultPropertyType<ENTITY,BASIC,CONTAINER>

Type Parameters:

ENTITY - the entity type

BASIC - the property basic type

CONTAINER - the property container type

All Implemented Interfaces:

EntityPropertyType<ENTITY,BASIC>

Direct Known Subclasses:

AssignedIdPropertyType, GeneratedIdPropertyType, TenantIdPropertyType, VersionPropertyType

public class DefaultPropertyType<ENTITY,BASIC,CONTAINER>
extends java.lang.Object
implements EntityPropertyType<ENTITY,BASIC>

A description for a default property.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	DefaultPropertyType.DefaultProperty

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	columnName
protected java.lang.Class<ENTITY>	entityClass
protected org.seasar.doma.internal.jdbc.entity.PropertyField<ENTITY>	field
protected boolean	insertable
protected java.lang.String	name
protected NamingType	namingType
protected boolean	quoteRequired
protected java.util.function.Supplier<org.seasar.doma.internal.jdbc.scalar.Scalar<BASIC,CONTAINER>>	scalarSupplier
protected java.lang.String	simpleName
protected boolean	updatable

Constructor Summary

Constructors

Constructor and Description
DefaultPropertyType(java.lang.Class<ENTITY> entityClass, java.util.function.Supplier<org.seasar.doma.internal.jdbc.scalar.Scalar<BASIC,CONTAINER>> scalarSupplier, java.lang.String name, java.lang.String columnName, NamingType namingType, boolean insertable, boolean updatable, boolean quoteRequired)

Method Summary

Modifier and Type	Method and Description
void	copy(ENTITY destEntity, ENTITY srcEntity) 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.
protected <VALUE> ENTITY	modifyIfNecessary(EntityType<ENTITY> entityType, ENTITY entity, WrapperVisitor<java.lang.Boolean,VALUE,java.lang.Void,java.lang.RuntimeException> visitor, VALUE value)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

entityClass

protected final java.lang.Class<ENTITY> entityClass

scalarSupplier

protected final java.util.function.Supplier<org.seasar.doma.internal.jdbc.scalar.Scalar<BASIC,CONTAINER>> scalarSupplier

name

protected final java.lang.String name

simpleName

protected final java.lang.String simpleName

columnName

protected final java.lang.String columnName

namingType

protected final NamingType namingType

insertable

protected final boolean insertable

updatable

protected final boolean updatable

quoteRequired

protected final boolean quoteRequired

field

protected final org.seasar.doma.internal.jdbc.entity.PropertyField<ENTITY> field

Constructor Detail

DefaultPropertyType

public DefaultPropertyType(java.lang.Class<ENTITY> entityClass,
                           java.util.function.Supplier<org.seasar.doma.internal.jdbc.scalar.Scalar<BASIC,CONTAINER>> scalarSupplier,
                           java.lang.String name,
                           java.lang.String columnName,
                           NamingType namingType,
                           boolean insertable,
                           boolean updatable,
                           boolean quoteRequired)

Method Detail

createProperty

public Property<ENTITY,BASIC> createProperty()

Description copied from interface: EntityPropertyType

Creates the property.

Specified by:

createProperty in interface EntityPropertyType<ENTITY,BASIC>

Returns:

the property

copy

public void copy(ENTITY destEntity,
                 ENTITY srcEntity)

Description copied from interface: EntityPropertyType

Copies this property value.

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

Specified by:

copy in interface EntityPropertyType<ENTITY,BASIC>

Parameters:

destEntity - the entity that is the copy destination

srcEntity - the entity that is the copy source

getName

public java.lang.String getName()

Description copied from interface: EntityPropertyType

Returns the property name.

Specified by:

getName in interface EntityPropertyType<ENTITY,BASIC>

Returns:

the property name

getColumnName

public java.lang.String getColumnName()

Description copied from interface: EntityPropertyType

Return the column name.

Specified by:

getColumnName in interface EntityPropertyType<ENTITY,BASIC>

Returns:

the column name

getColumnName

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

Description copied from interface: EntityPropertyType

Return the column name.

Specified by:

getColumnName in interface EntityPropertyType<ENTITY,BASIC>

Parameters:

quoteFunction - the function that applies quotation marks

Returns:

the name of the column.

getColumnName

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

Description copied from interface: EntityPropertyType

Return the column name.

Specified by:

getColumnName in interface EntityPropertyType<ENTITY,BASIC>

Parameters:

namingFunction - the function that applies naming convention

Returns:

the name of the column.

getColumnName

public 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)

Description copied from interface: EntityPropertyType

Return the column name.

Specified by:

getColumnName in interface EntityPropertyType<ENTITY,BASIC>

Parameters:

namingFunction - the function that applies naming convention

quoteFunction - the function that applies quotation marks

Returns:

the name of the column

isQuoteRequired

public boolean isQuoteRequired()

Description copied from interface: EntityPropertyType

Whether quotation marks are required to the column name.

Specified by:

isQuoteRequired in interface EntityPropertyType<ENTITY,BASIC>

Returns:

true if required

isId

public boolean isId()

Description copied from interface: EntityPropertyType

Whether this property is an identifier.

Specified by:

isId in interface EntityPropertyType<ENTITY,BASIC>

Returns:

true if this property is an identifier

isVersion

public boolean isVersion()

Description copied from interface: EntityPropertyType

Whether this property is a version.

Specified by:

isVersion in interface EntityPropertyType<ENTITY,BASIC>

Returns:

true if this property is a version

isTenantId

public boolean isTenantId()

Description copied from interface: EntityPropertyType

Whether this property is a tenant id.

Specified by:

isTenantId in interface EntityPropertyType<ENTITY,BASIC>

Returns:

true if this property is a tenant id

isInsertable

public boolean isInsertable()

Description copied from interface: EntityPropertyType

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

Specified by:

isInsertable in interface EntityPropertyType<ENTITY,BASIC>

Returns:

true if included in SQL INSERT statements.

isUpdatable

public boolean isUpdatable()

Description copied from interface: EntityPropertyType

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

Specified by:

isUpdatable in interface EntityPropertyType<ENTITY,BASIC>

Returns:

true if included in SQL UPDATE statements.

modifyIfNecessary

protected <VALUE> ENTITY modifyIfNecessary(EntityType<ENTITY> entityType,
                                           ENTITY entity,
                                           WrapperVisitor<java.lang.Boolean,VALUE,java.lang.Void,java.lang.RuntimeException> visitor,
                                           VALUE value)