TableGenerator (gw-data-jpa-essential 1.4.3 API)

java.lang.Object
- io.geewit.data.jpa.essential.id.TableGenerator

所有已实现的接口:

org.hibernate.boot.model.relational.ExportableProducer, org.hibernate.id.Configurable, org.hibernate.id.IdentifierGenerator, org.hibernate.id.PersistentIdentifierGenerator

直接已知子类:

CalendarFormatTableGenerator, FormatTableGenerator
```
public class TableGenerator
extends java.lang.Object
implements org.hibernate.id.PersistentIdentifierGenerator, org.hibernate.id.Configurable
```
TableGenerator

字段概要

字段
限定符和类型	字段和说明
`protected long`	`accessCount`
`static java.lang.String`	`CONFIG_PREFER_SEGMENT_PER_ENTITY` By default (in the absence of a `SEGMENT_VALUE_PARAM` setting) we use a single row for all generators.
`static java.lang.String`	`DEF_SEGMENT_COLUMN` The default `SEGMENT_COLUMN_PARAM` value
`static int`	`DEF_SEGMENT_LENGTH` The default `SEGMENT_LENGTH_PARAM` value
`static java.lang.String`	`DEF_SEGMENT_VALUE` The default `SEGMENT_VALUE_PARAM` value, unless `CONFIG_PREFER_SEGMENT_PER_ENTITY` is specified
`static java.lang.String`	`DEF_TABLE` The default `TABLE_PARAM` value
`static java.lang.String`	`DEF_VALUE_COLUMN` The default `VALUE_COLUMN_PARAM` value
`static int`	`DEFAULT_INCREMENT_SIZE` The default `INCREMENT_PARAM` value
`static int`	`DEFAULT_INITIAL_VALUE` The default `INITIAL_PARAM` value
`protected org.hibernate.type.Type`	`identifierType`
`static java.lang.String`	`INCREMENT_PARAM` Indicates the increment size to use.
`protected int`	`incrementSize`
`static java.lang.String`	`INITIAL_PARAM` Indicates the initial value to use.
`protected int`	`initialValue`
`protected java.lang.String`	`insertQuery`
`static java.lang.String`	`OPT_PARAM` Indicates the optimizer to use, either naming a `Optimizer` implementation class or by naming a `StandardOptimizerDescriptor` by name
`protected org.hibernate.id.enhanced.Optimizer`	`optimizer`
`protected org.hibernate.boot.model.relational.QualifiedName`	`qualifiedTableName`
`protected java.lang.String`	`renderedTableName`
`static java.lang.String`	`SEGMENT_COLUMN_PARAM` The name of the column which holds the segment key.
`static java.lang.String`	`SEGMENT_LENGTH_PARAM` Indicates the length of the column defined by `SEGMENT_COLUMN_PARAM`.
`static java.lang.String`	`SEGMENT_VALUE_PARAM` The value indicating which segment is used by this generator, as indicated by the actual value stored in the column indicated by `SEGMENT_COLUMN_PARAM`.
`protected java.lang.String`	`segmentColumnName`
`protected java.lang.String`	`segmentValue`
`protected int`	`segmentValueLength`
`protected java.lang.String`	`selectQuery`
`protected boolean`	`storeLastUsedValue`
`static java.lang.String`	`TABLE_PARAM` Configures the name of the table to use.
`protected java.lang.String`	`updateQuery`
`static java.lang.String`	`VALUE_COLUMN_PARAM` The name of column which holds the sequence value.
`protected java.lang.String`	`valueColumnName`

从接口继承的字段 org.hibernate.id.PersistentIdentifierGenerator
CATALOG, IDENTIFIER_NORMALIZER, PK, SCHEMA, TABLE, TABLES

从接口继承的字段 org.hibernate.id.IdentifierGenerator
ENTITY_NAME, GENERATOR_NAME, JPA_ENTITY_NAME

构造器概要

构造器
构造器和说明

TableGenerator()

构造器
构造器和说明
`TableGenerator()`

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`protected java.lang.String`	`buildInsertQuery()`
`protected java.lang.String`	`buildSelectQuery(org.hibernate.dialect.Dialect dialect)`
`protected java.lang.String`	`buildUpdateQuery()`
`void`	`configure(org.hibernate.type.Type type, java.util.Properties params, org.hibernate.service.ServiceRegistry serviceRegistry)`
`protected java.lang.String`	`determineDefaultSegmentValue(java.util.Properties params)` Used in the cases where `determineSegmentValue(java.util.Properties)` is unable to determine the value to use.
`protected org.hibernate.boot.model.relational.QualifiedName`	`determineGeneratorTableName(java.util.Properties params, org.hibernate.engine.jdbc.env.spi.JdbcEnvironment jdbcEnvironment, org.hibernate.service.ServiceRegistry serviceRegistry)` Determine the table name to use for the generator values.
`protected int`	`determineIncrementSize(java.util.Properties params)`
`protected int`	`determineInitialValue(java.util.Properties params)`
`protected java.lang.String`	`determineSegmentColumnName(java.util.Properties params, org.hibernate.engine.jdbc.env.spi.JdbcEnvironment jdbcEnvironment)` Determine the name of the column used to indicate the segment for each row.
`protected int`	`determineSegmentColumnSize(java.util.Properties params)` Determine the size of the `segment column` Called during `configuration`.
`protected java.lang.String`	`determineSegmentValue(java.util.Properties params)` Determine the segment value corresponding to this generator instance.
`protected java.lang.String`	`determineValueColumnName(java.util.Properties params, org.hibernate.engine.jdbc.env.spi.JdbcEnvironment jdbcEnvironment)` Determine the name of the column in which we will store the generator persistent value.
`java.io.Serializable`	`generate(org.hibernate.engine.spi.SharedSessionContractImplementor session, java.lang.Object obj)`
`protected org.hibernate.boot.model.relational.InitCommand`	`generateInsertInitCommand()`
`java.lang.Object`	`generatorKey()`
`org.hibernate.type.Type`	`getIdentifierType()` Type mapping for the identifier.
`int`	`getIncrementSize()` The amount of increment to use.
`int`	`getInitialValue()` The initial value to use when we find no previous state in the generator table corresponding to our sequence.
`org.hibernate.id.enhanced.Optimizer`	`getOptimizer()` The optimizer being used by this generator.
`java.lang.String`	`getSegmentColumnName()` The name of the column in which we store the segment to which each row belongs.
`java.lang.String`	`getSegmentValue()` The value in `segment column` which corresponding to this generator instance.
`int`	`getSegmentValueLength()` The size of the `segment column` in the underlying table.
`long`	`getTableAccessCount()` Getter for property 'tableAccessCount'.
`java.lang.String`	`getTableName()` The name of the table in which we store this generator's persistent state.
`java.lang.String`	`getValueColumnName()` The name of the column in which we store our persistent generator value.
`void`	`registerExportables(org.hibernate.boot.model.relational.Database database)`
`java.lang.String[]`	`sqlCreateStrings(org.hibernate.dialect.Dialect dialect)`
`java.lang.String[]`	`sqlDropStrings(org.hibernate.dialect.Dialect dialect)`

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

从接口继承的方法 org.hibernate.id.IdentifierGenerator
supportsJdbcBatchInserts

- 字段详细资料
  - CONFIG_PREFER_SEGMENT_PER_ENTITY
```
public static final java.lang.String CONFIG_PREFER_SEGMENT_PER_ENTITY
```
    By default (in the absence of a SEGMENT_VALUE_PARAM setting) we use a single row for all generators. This setting can be used to change that to instead default to using a row for each entity name.
    
    另请参阅:
    
    常量字段值
  - TABLE_PARAM
```
public static final java.lang.String TABLE_PARAM
```
    Configures the name of the table to use. The default value is DEF_TABLE
    
    另请参阅:
    
    常量字段值
  - DEF_TABLE
```
public static final java.lang.String DEF_TABLE
```
    The default TABLE_PARAM value
    
    另请参阅:
    
    常量字段值
  - VALUE_COLUMN_PARAM
```
public static final java.lang.String VALUE_COLUMN_PARAM
```
    The name of column which holds the sequence value. The default value is DEF_VALUE_COLUMN
    
    另请参阅:
    
    常量字段值
  - DEF_VALUE_COLUMN
```
public static final java.lang.String DEF_VALUE_COLUMN
```
    The default VALUE_COLUMN_PARAM value
    
    另请参阅:
    
    常量字段值
  - SEGMENT_COLUMN_PARAM
```
public static final java.lang.String SEGMENT_COLUMN_PARAM
```
    The name of the column which holds the segment key. The segment defines the different buckets (segments) of values currently tracked in the table. The default value is DEF_SEGMENT_COLUMN
    
    另请参阅:
    
    常量字段值
  - DEF_SEGMENT_COLUMN
```
public static final java.lang.String DEF_SEGMENT_COLUMN
```
    The default SEGMENT_COLUMN_PARAM value
    
    另请参阅:
    
    常量字段值
  - SEGMENT_VALUE_PARAM
```
public static final java.lang.String SEGMENT_VALUE_PARAM
```
    The value indicating which segment is used by this generator, as indicated by the actual value stored in the column indicated by SEGMENT_COLUMN_PARAM. The default value for setting is DEF_SEGMENT_VALUE, although CONFIG_PREFER_SEGMENT_PER_ENTITY effects the default as well.
    
    另请参阅:
    
    常量字段值
  - DEF_SEGMENT_VALUE
```
public static final java.lang.String DEF_SEGMENT_VALUE
```
    The default SEGMENT_VALUE_PARAM value, unless CONFIG_PREFER_SEGMENT_PER_ENTITY is specified
    
    另请参阅:
    
    常量字段值
  - SEGMENT_LENGTH_PARAM
```
public static final java.lang.String SEGMENT_LENGTH_PARAM
```
    Indicates the length of the column defined by SEGMENT_COLUMN_PARAM. Used in schema export. The default value is DEF_SEGMENT_LENGTH
    
    另请参阅:
    
    常量字段值
  - DEF_SEGMENT_LENGTH
```
public static final int DEF_SEGMENT_LENGTH
```
    The default SEGMENT_LENGTH_PARAM value
    
    另请参阅:
    
    常量字段值
  - INITIAL_PARAM
```
public static final java.lang.String INITIAL_PARAM
```
    Indicates the initial value to use. The default value is DEFAULT_INITIAL_VALUE
    
    另请参阅:
    
    常量字段值
  - DEFAULT_INITIAL_VALUE
```
public static final int DEFAULT_INITIAL_VALUE
```
    The default INITIAL_PARAM value
    
    另请参阅:
    
    常量字段值
  - INCREMENT_PARAM
```
public static final java.lang.String INCREMENT_PARAM
```
    Indicates the increment size to use. The default value is DEFAULT_INCREMENT_SIZE
    
    另请参阅:
    
    常量字段值
  - DEFAULT_INCREMENT_SIZE
```
public static final int DEFAULT_INCREMENT_SIZE
```
    The default INCREMENT_PARAM value
    
    另请参阅:
    
    常量字段值
  - OPT_PARAM
```
public static final java.lang.String OPT_PARAM
```
    Indicates the optimizer to use, either naming a Optimizer implementation class or by naming a StandardOptimizerDescriptor by name
    
    另请参阅:
    
    常量字段值
  - storeLastUsedValue
```
protected boolean storeLastUsedValue
```
  - identifierType
```
protected org.hibernate.type.Type identifierType
```
  - qualifiedTableName
```
protected org.hibernate.boot.model.relational.QualifiedName qualifiedTableName
```
  - renderedTableName
```
protected java.lang.String renderedTableName
```
  - segmentColumnName
```
protected java.lang.String segmentColumnName
```
  - segmentValue
```
protected java.lang.String segmentValue
```
  - segmentValueLength
```
protected int segmentValueLength
```
  - valueColumnName
```
protected java.lang.String valueColumnName
```
  - initialValue
```
protected int initialValue
```
  - incrementSize
```
protected int incrementSize
```
  - selectQuery
```
protected java.lang.String selectQuery
```
  - insertQuery
```
protected java.lang.String insertQuery
```
  - updateQuery
```
protected java.lang.String updateQuery
```
  - optimizer
```
protected org.hibernate.id.enhanced.Optimizer optimizer
```
  - accessCount
```
protected long accessCount
```
- 构造器详细资料
  - TableGenerator
```
public TableGenerator()
```
- 方法详细资料
  - generatorKey
```
public java.lang.Object generatorKey()
```
    指定者:
    
    generatorKey 在接口中 org.hibernate.id.PersistentIdentifierGenerator
  - getIdentifierType
```
public final org.hibernate.type.Type getIdentifierType()
```
    Type mapping for the identifier.
    
    返回:
    
    The identifier type mapping.
  - getTableName
```
public final java.lang.String getTableName()
```
    The name of the table in which we store this generator's persistent state.
    
    返回:
    
    The table name.
  - getSegmentColumnName
```
public final java.lang.String getSegmentColumnName()
```
    The name of the column in which we store the segment to which each row belongs. The value here acts as PK.
    
    返回:
    
    The segment column name
  - getSegmentValue
```
public final java.lang.String getSegmentValue()
```
    The value in segment column which corresponding to this generator instance. In other words this value indicates the row in which this generator instance will store values.
    
    返回:
    
    The segment value for this generator instance.
  - getSegmentValueLength
```
public final int getSegmentValueLength()
```
    The size of the segment column in the underlying table.
    NOTE : should really have been called 'segmentColumnLength' or even better 'segmentColumnSize'
    
    返回:
    
    the column size.
  - getValueColumnName
```
public final java.lang.String getValueColumnName()
```
    The name of the column in which we store our persistent generator value.
    
    返回:
    
    The name of the value column.
  - getInitialValue
```
public final int getInitialValue()
```
    The initial value to use when we find no previous state in the generator table corresponding to our sequence.
    
    返回:
    
    The initial value to use.
  - getIncrementSize
```
public final int getIncrementSize()
```
    The amount of increment to use. The exact implications of this depends on the optimizer being used.
    
    返回:
    
    The increment amount.
  - getOptimizer
```
public final org.hibernate.id.enhanced.Optimizer getOptimizer()
```
    The optimizer being used by this generator.
    
    返回:
    
    Out optimizer.
  - getTableAccessCount
```
public final long getTableAccessCount()
```
    Getter for property 'tableAccessCount'. Only really useful for unit test assertions.
    
    返回:
    
    Value for property 'tableAccessCount'.
  - configure
```
public void configure(org.hibernate.type.Type type,
                      java.util.Properties params,
                      org.hibernate.service.ServiceRegistry serviceRegistry)
               throws org.hibernate.MappingException
```
    指定者:
    
    configure 在接口中 org.hibernate.id.Configurable
    
    抛出:
    
    org.hibernate.MappingException
  - determineGeneratorTableName
```
protected org.hibernate.boot.model.relational.QualifiedName determineGeneratorTableName(java.util.Properties params,
                                                                                        org.hibernate.engine.jdbc.env.spi.JdbcEnvironment jdbcEnvironment,
                                                                                        org.hibernate.service.ServiceRegistry serviceRegistry)
```
    Determine the table name to use for the generator values.
    Called during configuration.
    
    参数:
    
    params - The params supplied in the generator config (plus some standard useful extras).
    
    jdbcEnvironment - The JDBC environment
    
    返回:
    
    The table name to use.
    
    另请参阅:
    
    getTableName()
  - determineSegmentColumnName
```
protected java.lang.String determineSegmentColumnName(java.util.Properties params,
                                                      org.hibernate.engine.jdbc.env.spi.JdbcEnvironment jdbcEnvironment)
```
    Determine the name of the column used to indicate the segment for each row. This column acts as the primary key.
    Called during configuration.
    
    参数:
    
    params - The params supplied in the generator config (plus some standard useful extras).
    
    jdbcEnvironment - The JDBC environment
    
    返回:
    
    The name of the segment column
    
    另请参阅:
    
    getSegmentColumnName()
  - determineValueColumnName
```
protected java.lang.String determineValueColumnName(java.util.Properties params,
                                                    org.hibernate.engine.jdbc.env.spi.JdbcEnvironment jdbcEnvironment)
```
    Determine the name of the column in which we will store the generator persistent value.
    Called during configuration.
    
    参数:
    
    params - The params supplied in the generator config (plus some standard useful extras).
    
    jdbcEnvironment - The JDBC environment
    
    返回:
    
    The name of the value column
    
    另请参阅:
    
    getValueColumnName()
  - determineSegmentValue
```
protected java.lang.String determineSegmentValue(java.util.Properties params)
```
    Determine the segment value corresponding to this generator instance.
    Called during configuration.
    
    参数:
    
    params - The params supplied in the generator config (plus some standard useful extras).
    
    返回:
    
    The name of the value column
    
    另请参阅:
    
    getSegmentValue()
  - determineDefaultSegmentValue
```
protected java.lang.String determineDefaultSegmentValue(java.util.Properties params)
```
    Used in the cases where determineSegmentValue(java.util.Properties) is unable to determine the value to use.
    
    参数:
    
    params - The params supplied in the generator config (plus some standard useful extras).
    
    返回:
    
    The default segment value to use.
  - determineSegmentColumnSize
```
protected int determineSegmentColumnSize(java.util.Properties params)
```
    Determine the size of the segment column
    Called during configuration.
    
    参数:
    
    params - The params supplied in the generator config (plus some standard useful extras).
    
    返回:
    
    The size of the segment column
    
    另请参阅:
    
    getSegmentValueLength()
  - determineInitialValue
```
protected int determineInitialValue(java.util.Properties params)
```
  - determineIncrementSize
```
protected int determineIncrementSize(java.util.Properties params)
```
  - buildSelectQuery
```
protected java.lang.String buildSelectQuery(org.hibernate.dialect.Dialect dialect)
```
  - buildUpdateQuery
```
protected java.lang.String buildUpdateQuery()
```
  - buildInsertQuery
```
protected java.lang.String buildInsertQuery()
```
  - generateInsertInitCommand
```
protected org.hibernate.boot.model.relational.InitCommand generateInsertInitCommand()
```
  - generate
```
public java.io.Serializable generate(org.hibernate.engine.spi.SharedSessionContractImplementor session,
                                     java.lang.Object obj)
```
    指定者:
    
    generate 在接口中 org.hibernate.id.IdentifierGenerator
  - sqlCreateStrings
```
public java.lang.String[] sqlCreateStrings(org.hibernate.dialect.Dialect dialect)
                                    throws org.hibernate.HibernateException
```
    指定者:
    
    sqlCreateStrings 在接口中 org.hibernate.id.PersistentIdentifierGenerator
    
    抛出:
    
    org.hibernate.HibernateException
  - sqlDropStrings
```
public java.lang.String[] sqlDropStrings(org.hibernate.dialect.Dialect dialect)
                                  throws org.hibernate.HibernateException
```
    指定者:
    
    sqlDropStrings 在接口中 org.hibernate.id.PersistentIdentifierGenerator
    
    抛出:
    
    org.hibernate.HibernateException
  - registerExportables
```
public void registerExportables(org.hibernate.boot.model.relational.Database database)
```
    指定者:
    
    registerExportables 在接口中 org.hibernate.boot.model.relational.ExportableProducer

类 TableGenerator

字段概要

从接口继承的字段 org.hibernate.id.PersistentIdentifierGenerator

从接口继承的字段 org.hibernate.id.IdentifierGenerator

构造器概要

方法概要

从类继承的方法 java.lang.Object

从接口继承的方法 org.hibernate.id.IdentifierGenerator

字段详细资料

CONFIG_PREFER_SEGMENT_PER_ENTITY

TABLE_PARAM

DEF_TABLE

VALUE_COLUMN_PARAM

DEF_VALUE_COLUMN

SEGMENT_COLUMN_PARAM

DEF_SEGMENT_COLUMN

SEGMENT_VALUE_PARAM

DEF_SEGMENT_VALUE

SEGMENT_LENGTH_PARAM

DEF_SEGMENT_LENGTH

INITIAL_PARAM

DEFAULT_INITIAL_VALUE

INCREMENT_PARAM

DEFAULT_INCREMENT_SIZE

OPT_PARAM

storeLastUsedValue

identifierType

qualifiedTableName

renderedTableName

segmentColumnName

segmentValue

segmentValueLength

valueColumnName

initialValue

incrementSize

selectQuery

insertQuery

updateQuery

optimizer

accessCount

构造器详细资料

TableGenerator

方法详细资料

generatorKey

getIdentifierType

getTableName

getSegmentColumnName

getSegmentValue

getSegmentValueLength

getValueColumnName

getInitialValue

getIncrementSize

getOptimizer

getTableAccessCount

configure

determineGeneratorTableName

determineSegmentColumnName

determineValueColumnName

determineSegmentValue

determineDefaultSegmentValue

determineSegmentColumnSize

determineInitialValue

determineIncrementSize

buildSelectQuery

buildUpdateQuery

buildInsertQuery

generateInsertInitCommand

generate

sqlCreateStrings

sqlDropStrings

registerExportables