DeployBeanProperty (avaje-ebeanorm 3.3.1 API)

java.lang.Object
- com.avaje.ebeaninternal.server.deploy.meta.DeployBeanProperty

Direct Known Subclasses:

DeployBeanPropertyAssoc, DeployBeanPropertyCompound
```
public class DeployBeanProperty
extends Object
```
Description of a property of a bean. Includes its deployment information such as database column mapping information.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`EXCLUDE_FROM_DELETE_WHERE` Advanced bean deployment.
`static String`	`EXCLUDE_FROM_INSERT` Advanced bean deployment.
`static String`	`EXCLUDE_FROM_UPDATE` Advanced bean deployment.
`static String`	`EXCLUDE_FROM_UPDATE_WHERE` Advanced bean deployment.

Constructor Summary

Constructors
Constructor and Description
`DeployBeanProperty(DeployBeanDescriptor<?> desc, Class<?> propertyType, ScalarType<?> scalarType, ScalarTypeConverter<?,?> typeConverter)`

Method Summary

Methods
Modifier and Type	Method and Description
`String`	`getDbBind()` Return the DB Bind parameter.
`String`	`getDbColumn()` The database column name this is mapped to.
`String`	`getDbColumnDefn()` Return the DB column definition if defined.
`String`	`getDbConstraintExpression()`
`int`	`getDbEncryptedType()` Return the DB type for the encrypted property.
`DbEncryptFunction`	`getDbEncryptFunction()`
`int`	`getDbLength()` Return the DB column length for character columns.
`int`	`getDbScale()` Return the Db scale for numeric columns.
`int`	`getDbType()` Return the database jdbc data type this is mapped to.
`Object`	`getDefaultValue()` Return the default value.
`String`	`getElPlaceHolder(BeanDescriptor.EntityType et)`
`String`	`getExtraAttribute(String key)` Return an extra attribute set on this property.
`Map<String,String>`	`getExtraAttributeMap()`
`Field`	`getField()` Return the bean Field associated with this property.
`String`	`getFullBeanName()`
`GeneratedProperty`	`getGeneratedProperty()` Return the GeneratedValue.
`BeanReflectGetter`	`getGetter()`
`String`	`getName()` Return the name of the property.
`Class<?>`	`getOwningType()`
`Class<?>`	`getPropertyType()` Return the property type.
`Method`	`getReadMethod()` Return the getter method.
`ScalarType<?>`	`getScalarType()` Return the scalarType.
`String`	`getSecondaryTable()` Return the secondary table this property is associated with.
`DeployTableJoin`	`getSecondaryTableJoin()`
`String`	`getSecondaryTableJoinPrefix()`
`BeanReflectSetter`	`getSetter()`
`int`	`getSortOrder()` Return the sortOrder for the properties.
`int`	`getSortOverride()`
`String`	`getSqlFormulaJoin()`
`String`	`getSqlFormulaSelect()` Return the formula this property is based on.
`Method`	`getWriteMethod()` Return the setter method.
`boolean`	`isDbEncrypted()` Return true if this property is encrypted in the DB.
`boolean`	`isDbInsertable()`
`boolean`	`isDbRead()` Return true if this property is included in database queries.
`boolean`	`isDbUpdateable()`
`boolean`	`isEmbedded()` Return true if this is an Embedded property.
`boolean`	`isExposeDeserialize()`
`boolean`	`isExposeSerialize()`
`boolean`	`isFetchEager()` Return true if this should be eager fetched by default.
`boolean`	`isGenerated()` Return true if this is a generated property like update timestamp and create timestamp.
`boolean`	`isId()` Return true if this is included in the unique id.
`boolean`	`isLob()` Return true if this is mapped to a Clob Blob LongVarchar or LongVarbinary.
`boolean`	`isLocal()` Return true if this is local to this type - aka not from a super type.
`boolean`	`isLocalEncrypted()` Return true if the property is encrypted in java rather than in the DB.
`boolean`	`isNaturalKey()`
`boolean`	`isNullable()` Return true if this property is mandatory.
`boolean`	`isNullablePrimitive()` Return true if this is a primitive type with a nullable DB column.
`boolean`	`isScalar()` Return true is this is a simple scalar property.
`boolean`	`isSecondaryTable()` Return true if this property is based on a secondary table.
`boolean`	`isTransient()` Return true if the property is transient.
`boolean`	`isUndirectionalShadow()` Return true if this is a placeholder property for a unidirectional relationship.
`boolean`	`isUnique()` Return true if the DB column is unique.
`boolean`	`isVersionColumn()` Return true if this is a version column used for concurrency checking.
`void`	`setDbBind(String dbBind)` Set the DB bind parameter (if different from "?").
`void`	`setDbColumn(String dbColumn)` Set the database column name this is mapped to.
`void`	`setDbColumnDefn(String dbColumnDefn)` Set a specific DB column definition.
`void`	`setDbEncryptedType(int dbEncryptedType)` Set the DB type used to store the encrypted value.
`void`	`setDbEncryptFunction(DbEncryptFunction dbEncryptFunction, DbEncrypt dbEncrypt, int dbLen)`
`void`	`setDbInsertable(boolean insertable)`
`void`	`setDbLength(int dbLength)` Set the DB column length for character columns.
`void`	`setDbRead(boolean isDBRead)` Set to true if this property is included in database queries.
`void`	`setDbScale(int dbScale)` Set the Db scale for numeric columns.
`void`	`setDbType(int dbType)` Set the database jdbc data type this is mapped to.
`void`	`setDbUpdateable(boolean updateable)`
`void`	`setDefaultValue(Object defaultValue)` Set the default value.
`void`	`setEmbedded(boolean embedded)` Set to true if this is an embedded property.
`void`	`setExposeDeserialize(boolean exposeDeserialize)`
`void`	`setExposeSerialize(boolean exposeSerialize)`
`void`	`setExtraAttribute(String key, String value)` Set an extra attribute set on this property.
`void`	`setFetchType(javax.persistence.FetchType fetchType)` Set the default fetch type for this property.
`void`	`setField(Field field)` Set the bean Field associated with this property.
`void`	`setGeneratedProperty(GeneratedProperty generatedValue)` Set the GeneratedValue.
`void`	`setGetter(BeanReflectGetter getter)` Set the getter used to read the property value from a bean.
`void`	`setId(boolean id)` Set to true if this is included in the unique id.
`void`	`setLocalEncrypted(boolean localEncrypted)` Set to true when the property is encrypted in java rather than in the DB.
`void`	`setName(String name)` Set the name of the property.
`void`	`setNaturalKey(boolean naturalKey)`
`void`	`setNullable(boolean isNullable)` Set the not nullable of this property.
`void`	`setOwningType(Class<?> owningType)` Set to the owning type form a Inheritance heirarchy.
`void`	`setReadMethod(Method readMethod)` Set the bean read method.
`void`	`setScalarType(ScalarType<?> scalarType)`
`void`	`setSecondaryTable(String secondaryTable)` Set to true if this property is included in persisting.
`void`	`setSecondaryTableJoin(DeployTableJoin secondaryTableJoin, String prefix)`
`void`	`setSetter(BeanReflectSetter setter)` Set the setter used to set the property value to a bean.
`void`	`setSortOrder(int sortOrder)` Set the sortOrder for the properties.
`void`	`setSqlFormula(String formulaSelect, String formulaJoin)` The property is based on a formula.
`void`	`setTransient(boolean isTransient)` Mark the property explicitly as a transient property.
`void`	`setUndirectionalShadow(boolean undirectionalShadow)` Mark this property as a placeholder for a unidirectional relationship.
`void`	`setUnique(boolean unique)` Set to true if the DB column is unique.
`void`	`setVersionColumn(boolean isVersionColumn)` Set if this is a version column used for concurrency checking.
`void`	`setWriteMethod(Method writeMethod)` Set the bean write method.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - EXCLUDE_FROM_UPDATE_WHERE
```
public static final String EXCLUDE_FROM_UPDATE_WHERE
```
    Advanced bean deployment. To exclude this property from update where clause.
    
    See Also:
    Constant Field Values
  - EXCLUDE_FROM_DELETE_WHERE
```
public static final String EXCLUDE_FROM_DELETE_WHERE
```
    Advanced bean deployment. To exclude this property from delete where clause.
    
    See Also:
    Constant Field Values
  - EXCLUDE_FROM_INSERT
```
public static final String EXCLUDE_FROM_INSERT
```
    Advanced bean deployment. To exclude this property from insert.
    
    See Also:
    Constant Field Values
  - EXCLUDE_FROM_UPDATE
```
public static final String EXCLUDE_FROM_UPDATE
```
    Advanced bean deployment. To exclude this property from update set clause.
    
    See Also:
    Constant Field Values
- Constructor Detail
  - DeployBeanProperty
```
public DeployBeanProperty(DeployBeanDescriptor<?> desc,
                  Class<?> propertyType,
                  ScalarType<?> scalarType,
                  ScalarTypeConverter<?,?> typeConverter)
```
- Method Detail
  - getSortOverride
```
public int getSortOverride()
```
  - isScalar
```
public boolean isScalar()
```
    Return true is this is a simple scalar property.
  - getFullBeanName
```
public String getFullBeanName()
```
  - isNullablePrimitive
```
public boolean isNullablePrimitive()
```
    Return true if this is a primitive type with a nullable DB column.
    This should log a WARNING as primitive types can't be null.
  - getDbLength
```
public int getDbLength()
```
    Return the DB column length for character columns.
    Note if there is no length explicitly defined then the scalarType is checked to see if that has one (primarily to support putting a length on Enum types).
  - isExposeSerialize
```
public boolean isExposeSerialize()
```
  - setExposeSerialize
```
public void setExposeSerialize(boolean exposeSerialize)
```
  - isExposeDeserialize
```
public boolean isExposeDeserialize()
```
  - setExposeDeserialize
```
public void setExposeDeserialize(boolean exposeDeserialize)
```
  - getSortOrder
```
public int getSortOrder()
```
    Return the sortOrder for the properties.
  - setSortOrder
```
public void setSortOrder(int sortOrder)
```
    Set the sortOrder for the properties.
  - isUndirectionalShadow
```
public boolean isUndirectionalShadow()
```
    Return true if this is a placeholder property for a unidirectional relationship.
  - setUndirectionalShadow
```
public void setUndirectionalShadow(boolean undirectionalShadow)
```
    Mark this property as a placeholder for a unidirectional relationship.
  - isLocalEncrypted
```
public boolean isLocalEncrypted()
```
    Return true if the property is encrypted in java rather than in the DB.
  - setLocalEncrypted
```
public void setLocalEncrypted(boolean localEncrypted)
```
    Set to true when the property is encrypted in java rather than in the DB.
  - setDbLength
```
public void setDbLength(int dbLength)
```
    Set the DB column length for character columns.
  - getDbScale
```
public int getDbScale()
```
    Return the Db scale for numeric columns.
  - setDbScale
```
public void setDbScale(int dbScale)
```
    Set the Db scale for numeric columns.
  - getDbColumnDefn
```
public String getDbColumnDefn()
```
    Return the DB column definition if defined.
  - setDbColumnDefn
```
public void setDbColumnDefn(String dbColumnDefn)
```
    Set a specific DB column definition.
  - getDbConstraintExpression
```
public String getDbConstraintExpression()
```
  - getScalarType
```
public ScalarType<?> getScalarType()
```
    Return the scalarType. This returns null for native JDBC types, otherwise it is used to convert between logical types and jdbc types.
  - setScalarType
```
public void setScalarType(ScalarType<?> scalarType)
```
  - getGetter
```
public BeanReflectGetter getGetter()
```
  - getSetter
```
public BeanReflectSetter getSetter()
```
  - getReadMethod
```
public Method getReadMethod()
```
    Return the getter method.
  - getWriteMethod
```
public Method getWriteMethod()
```
    Return the setter method.
  - setOwningType
```
public void setOwningType(Class<?> owningType)
```
    Set to the owning type form a Inheritance heirarchy.
  - getOwningType
```
public Class<?> getOwningType()
```
  - isLocal
```
public boolean isLocal()
```
    Return true if this is local to this type - aka not from a super type.
  - setGetter
```
public void setGetter(BeanReflectGetter getter)
```
    Set the getter used to read the property value from a bean.
  - setSetter
```
public void setSetter(BeanReflectSetter setter)
```
    Set the setter used to set the property value to a bean.
  - getName
```
public String getName()
```
    Return the name of the property.
  - setName
```
public void setName(String name)
```
    Set the name of the property.
  - getField
```
public Field getField()
```
    Return the bean Field associated with this property.
  - setField
```
public void setField(Field field)
```
    Set the bean Field associated with this property.
  - isNaturalKey
```
public boolean isNaturalKey()
```
  - setNaturalKey
```
public void setNaturalKey(boolean naturalKey)
```
  - isGenerated
```
public boolean isGenerated()
```
    Return true if this is a generated property like update timestamp and create timestamp.
  - getGeneratedProperty
```
public GeneratedProperty getGeneratedProperty()
```
    Return the GeneratedValue. Used to generate update timestamp etc.
  - setGeneratedProperty
```
public void setGeneratedProperty(GeneratedProperty generatedValue)
```
    Set the GeneratedValue. Used to generate update timestamp etc.
  - isNullable
```
public boolean isNullable()
```
    Return true if this property is mandatory.
  - setNullable
```
public void setNullable(boolean isNullable)
```
    Set the not nullable of this property.
  - isUnique
```
public boolean isUnique()
```
    Return true if the DB column is unique.
  - setUnique
```
public void setUnique(boolean unique)
```
    Set to true if the DB column is unique.
  - isVersionColumn
```
public boolean isVersionColumn()
```
    Return true if this is a version column used for concurrency checking.
  - setVersionColumn
```
public void setVersionColumn(boolean isVersionColumn)
```
    Set if this is a version column used for concurrency checking.
  - isFetchEager
```
public boolean isFetchEager()
```
    Return true if this should be eager fetched by default.
  - setFetchType
```
public void setFetchType(javax.persistence.FetchType fetchType)
```
    Set the default fetch type for this property.
  - getSqlFormulaSelect
```
public String getSqlFormulaSelect()
```
    Return the formula this property is based on.
  - getSqlFormulaJoin
```
public String getSqlFormulaJoin()
```
  - setSqlFormula
```
public void setSqlFormula(String formulaSelect,
                 String formulaJoin)
```
    The property is based on a formula.
  - getElPlaceHolder
```
public String getElPlaceHolder(BeanDescriptor.EntityType et)
```
  - getDbColumn
```
public String getDbColumn()
```
    The database column name this is mapped to.
  - setDbColumn
```
public void setDbColumn(String dbColumn)
```
    Set the database column name this is mapped to.
  - getDbType
```
public int getDbType()
```
    Return the database jdbc data type this is mapped to.
  - setDbType
```
public void setDbType(int dbType)
```
    Set the database jdbc data type this is mapped to.
  - isLob
```
public boolean isLob()
```
    Return true if this is mapped to a Clob Blob LongVarchar or LongVarbinary.
  - isSecondaryTable
```
public boolean isSecondaryTable()
```
    Return true if this property is based on a secondary table.
  - getSecondaryTable
```
public String getSecondaryTable()
```
    Return the secondary table this property is associated with.
  - setSecondaryTable
```
public void setSecondaryTable(String secondaryTable)
```
    Set to true if this property is included in persisting.
  - getSecondaryTableJoinPrefix
```
public String getSecondaryTableJoinPrefix()
```
  - getSecondaryTableJoin
```
public DeployTableJoin getSecondaryTableJoin()
```
  - setSecondaryTableJoin
```
public void setSecondaryTableJoin(DeployTableJoin secondaryTableJoin,
                         String prefix)
```
  - getDbBind
```
public String getDbBind()
```
    Return the DB Bind parameter. Typically is "?" but can be different for encrypted bind.
  - setDbBind
```
public void setDbBind(String dbBind)
```
    Set the DB bind parameter (if different from "?").
  - isDbEncrypted
```
public boolean isDbEncrypted()
```
    Return true if this property is encrypted in the DB.
  - getDbEncryptFunction
```
public DbEncryptFunction getDbEncryptFunction()
```
  - setDbEncryptFunction
```
public void setDbEncryptFunction(DbEncryptFunction dbEncryptFunction,
                        DbEncrypt dbEncrypt,
                        int dbLen)
```
  - getDbEncryptedType
```
public int getDbEncryptedType()
```
    Return the DB type for the encrypted property. This can differ from the logical type (String encrypted and stored in a VARBINARY)
  - setDbEncryptedType
```
public void setDbEncryptedType(int dbEncryptedType)
```
    Set the DB type used to store the encrypted value.
  - isDbRead
```
public boolean isDbRead()
```
    Return true if this property is included in database queries.
  - setDbRead
```
public void setDbRead(boolean isDBRead)
```
    Set to true if this property is included in database queries.
  - isDbInsertable
```
public boolean isDbInsertable()
```
  - setDbInsertable
```
public void setDbInsertable(boolean insertable)
```
  - isDbUpdateable
```
public boolean isDbUpdateable()
```
  - setDbUpdateable
```
public void setDbUpdateable(boolean updateable)
```
  - isTransient
```
public boolean isTransient()
```
    Return true if the property is transient.
  - setTransient
```
public void setTransient(boolean isTransient)
```
    Mark the property explicitly as a transient property.
  - setReadMethod
```
public void setReadMethod(Method readMethod)
```
    Set the bean read method.
    NB: That a BeanReflectGetter is used to actually perform the getting of property values from a bean. This is due to performance considerations.
  - setWriteMethod
```
public void setWriteMethod(Method writeMethod)
```
    Set the bean write method.
    NB: That a BeanReflectSetter is used to actually perform the setting of property values to a bean. This is due to performance considerations.
  - getPropertyType
```
public Class<?> getPropertyType()
```
    Return the property type.
  - isId
```
public boolean isId()
```
    Return true if this is included in the unique id.
  - setId
```
public void setId(boolean id)
```
    Set to true if this is included in the unique id.
  - isEmbedded
```
public boolean isEmbedded()
```
    Return true if this is an Embedded property. In this case it shares the table and pk of its owner object.
  - setEmbedded
```
public void setEmbedded(boolean embedded)
```
    Set to true if this is an embedded property.
  - getExtraAttributeMap
```
public Map<String,String> getExtraAttributeMap()
```
  - getExtraAttribute
```
public String getExtraAttribute(String key)
```
    Return an extra attribute set on this property.
  - setExtraAttribute
```
public void setExtraAttribute(String key,
                     String value)
```
    Set an extra attribute set on this property.
  - getDefaultValue
```
public Object getDefaultValue()
```
    Return the default value.
  - setDefaultValue
```
public void setDefaultValue(Object defaultValue)
```
    Set the default value. Inserted if the value is null.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class DeployBeanProperty

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

EXCLUDE_FROM_UPDATE_WHERE

EXCLUDE_FROM_DELETE_WHERE

EXCLUDE_FROM_INSERT

EXCLUDE_FROM_UPDATE

Constructor Detail

DeployBeanProperty

Method Detail

getSortOverride

isScalar

getFullBeanName

isNullablePrimitive

getDbLength

isExposeSerialize

setExposeSerialize

isExposeDeserialize

setExposeDeserialize

getSortOrder

setSortOrder

isUndirectionalShadow

setUndirectionalShadow

isLocalEncrypted

setLocalEncrypted

setDbLength

getDbScale

setDbScale

getDbColumnDefn

setDbColumnDefn

getDbConstraintExpression

getScalarType

setScalarType

getGetter

getSetter

getReadMethod

getWriteMethod

setOwningType

getOwningType

isLocal

setGetter

setSetter

getName

setName

getField

setField

isNaturalKey

setNaturalKey

isGenerated

getGeneratedProperty

setGeneratedProperty

isNullable

setNullable

isUnique

setUnique

isVersionColumn

setVersionColumn

isFetchEager

setFetchType

getSqlFormulaSelect

getSqlFormulaJoin

setSqlFormula

getElPlaceHolder

getDbColumn

setDbColumn

getDbType

setDbType

isLob

isSecondaryTable

getSecondaryTable

setSecondaryTable

getSecondaryTableJoinPrefix

getSecondaryTableJoin

setSecondaryTableJoin

getDbBind

setDbBind

isDbEncrypted