DbEntityDescriptor (Jodd API Documentation)

java.lang.Object
- jodd.db.oom.DbEntityDescriptor<E>

```
public class DbEntityDescriptor<E>
extends java.lang.Object
```
Holds all information about some entity type, such as table name and columns data.

Constructor Summary

Constructors
Constructor and Description
`DbEntityDescriptor(java.lang.Class<E> type, java.lang.String schemaName, TableNamingStrategy tableNamingStrategy, ColumnNamingStrategy columnNamingStrategy)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DbEntityColumnDescriptor`	`findByColumnName(java.lang.String columnName)` Finds column descriptor by column name.
`DbEntityColumnDescriptor`	`findByPropertyName(java.lang.String propertyName)` Finds column descriptor by property name.
`DbEntityColumnDescriptor[]`	`getColumnDescriptors()` Returns the array of column descriptors.
`java.lang.String`	`getColumnName(java.lang.String propertyName)` Returns column name for specified property name..
`int`	`getColumnsCount()` Returns total number of columns.
`java.lang.String`	`getEntityName()` Returns type name.
`java.lang.String`	`getIdColumnName()` Returns the identity column name of column marked as identity.
`int`	`getIdColumnsCount()` Returns total number of identity columns.
`java.lang.String`	`getIdPropertyName()` Returns the first property name of column marked as identity.
`java.lang.Object`	`getIdValue(E object)` Returns ID value for given entity instance.
`java.lang.String`	`getKeyValue(E object)` Returns unique key for this entity.
`java.lang.Class[]`	`getMappedTypes()` Returns mapped types.
`java.lang.String`	`getPropertyName(java.lang.String columnName)` Returns property name for specified column name.
`java.lang.String`	`getSchemaName()` Returns schema name or `null` if not available.
`java.lang.String`	`getTableName()` Returns table name to which the entity is mapped.
`java.lang.String`	`getTableNameForQuery()` Returns table name to be used when generating queries.
`java.lang.Class<E>`	`getType()` Returns entity type.
`boolean`	`hasIdColumn()` Returns `true` if entity has one ID column.
`protected void`	`init()` Lazy initialization of descriptor.
`boolean`	`isAnnotated()` Returns `true` if type is annotated with `DbTable`.
`void`	`setIdValue(E object, java.lang.Object value)` Sets ID value for given entity.
`java.lang.String`	`toString()`

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

- Constructor Detail
  - DbEntityDescriptor
```
public DbEntityDescriptor(java.lang.Class<E> type,
                          java.lang.String schemaName,
                          TableNamingStrategy tableNamingStrategy,
                          ColumnNamingStrategy columnNamingStrategy)
```
- Method Detail
  - getType
```
public java.lang.Class<E> getType()
```
    Returns entity type.
  - isAnnotated
```
public boolean isAnnotated()
```
    Returns true if type is annotated with DbTable.
  - getTableName
```
public java.lang.String getTableName()
```
    Returns table name to which the entity is mapped.
  - getTableNameForQuery
```
public java.lang.String getTableNameForQuery()
```
    Returns table name to be used when generating queries.
  - getEntityName
```
public java.lang.String getEntityName()
```
    Returns type name.
  - getSchemaName
```
public java.lang.String getSchemaName()
```
    Returns schema name or null if not available.
  - getMappedTypes
```
public java.lang.Class[] getMappedTypes()
```
    Returns mapped types.
  - getColumnDescriptors
```
public DbEntityColumnDescriptor[] getColumnDescriptors()
```
    Returns the array of column descriptors.
  - init
```
protected void init()
```
    Lazy initialization of descriptor.
  - findByColumnName
```
public DbEntityColumnDescriptor findByColumnName(java.lang.String columnName)
```
    Finds column descriptor by column name. Case is ignored.
  - findByPropertyName
```
public DbEntityColumnDescriptor findByPropertyName(java.lang.String propertyName)
```
    Finds column descriptor by property name.
  - getPropertyName
```
public java.lang.String getPropertyName(java.lang.String columnName)
```
    Returns property name for specified column name.
  - getColumnName
```
public java.lang.String getColumnName(java.lang.String propertyName)
```
    Returns column name for specified property name..
  - getColumnsCount
```
public int getColumnsCount()
```
    Returns total number of columns.
  - getIdColumnsCount
```
public int getIdColumnsCount()
```
    Returns total number of identity columns.
  - hasIdColumn
```
public boolean hasIdColumn()
```
    Returns true if entity has one ID column.
  - getIdColumnName
```
public java.lang.String getIdColumnName()
```
    Returns the identity column name of column marked as identity. Throws an exception if table has composite primary key.
  - getIdPropertyName
```
public java.lang.String getIdPropertyName()
```
    Returns the first property name of column marked as identity. Throws an exception if table has composite primary key.
  - getIdValue
```
public java.lang.Object getIdValue(E object)
```
    Returns ID value for given entity instance.
  - setIdValue
```
public void setIdValue(E object,
                       java.lang.Object value)
```
    Sets ID value for given entity.
  - getKeyValue
```
public java.lang.String getKeyValue(E object)
```
    Returns unique key for this entity. Returned key is built from entity class and id value.
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class DbEntityDescriptor<E>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DbEntityDescriptor

Method Detail

getType

isAnnotated

getTableName

getTableNameForQuery

getEntityName

getSchemaName

getMappedTypes

getColumnDescriptors

init

findByColumnName

findByPropertyName

getPropertyName

getColumnName

getColumnsCount

getIdColumnsCount

hasIdColumn

getIdColumnName

getIdPropertyName

getIdValue

setIdValue

getKeyValue

toString