Package org.hibernate.id.enhanced

Class TableGenerator

    • Constructor Detail

      • TableGenerator

        public TableGenerator()

    • Method Detail

      • generatorKey

        public java.lang.Object generatorKey()
        Description copied from interface: PersistentIdentifierGenerator
        Return a key unique to the underlying database objects. Prevents us from trying to create/remove them multiple times.
        Specified by:
        generatorKey in interface PersistentIdentifierGenerator
        Returns:
        Object an identifying key for this generator

      • getIdentifierType

        public final Type getIdentifierType()
        Type mapping for the identifier.
        Returns:
        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.
        Returns:
        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.
        Returns:
        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.
        Returns:
        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'

        Returns:
        the column size.

      • getValueColumnName

        public final java.lang.String getValueColumnName()
        The name of the column in which we store our persistent generator value.
        Returns:
        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.
        Returns:
        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.
        Returns:
        The increment amount.

      • getOptimizer

        public final Optimizer getOptimizer()
        The optimizer being used by this generator.
        Returns:
        Out optimizer.

      • getTableAccessCount

        public final long getTableAccessCount()
        Getter for property 'tableAccessCount'. Only really useful for unit test assertions.
        Returns:
        Value for property 'tableAccessCount'.

      • configure

        public void configure​(Type type,
                      java.util.Properties params,
                      ServiceRegistry serviceRegistry)
               throws MappingException
        Description copied from interface: Configurable
        Configure this instance, given the value of parameters specified by the user as <param> elements. This method is called just once, following instantiation.
        Specified by:
        configure in interface Configurable
        Parameters:
        type - The id property type descriptor
        params - param values, keyed by parameter name
        serviceRegistry - Access to service that may be needed.
        Throws:
        MappingException

      • determineGeneratorTableName

        protected QualifiedName determineGeneratorTableName​(java.util.Properties params,
                                                    JdbcEnvironment jdbcEnvironment,
                                                    ServiceRegistry serviceRegistry)
        Determine the table name to use for the generator values.

        Called during configuration.

        Parameters:
        params - The params supplied in the generator config (plus some standard useful extras).
        jdbcEnvironment - The JDBC environment
        Returns:
        The table name to use.
        See Also:
        getTableName()

      • determineSegmentColumnName

        protected java.lang.String determineSegmentColumnName​(java.util.Properties params,
                                                      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.

        Parameters:
        params - The params supplied in the generator config (plus some standard useful extras).
        jdbcEnvironment - The JDBC environment
        Returns:
        The name of the segment column
        See Also:
        getSegmentColumnName()

      • determineValueColumnName

        protected java.lang.String determineValueColumnName​(java.util.Properties params,
                                                    JdbcEnvironment jdbcEnvironment)
        Determine the name of the column in which we will store the generator persistent value.

        Called during configuration.

        Parameters:
        params - The params supplied in the generator config (plus some standard useful extras).
        jdbcEnvironment - The JDBC environment
        Returns:
        The name of the value column
        See Also:
        getValueColumnName()

      • determineSegmentValue

        protected java.lang.String determineSegmentValue​(java.util.Properties params)
        Determine the segment value corresponding to this generator instance.

        Called during configuration.

        Parameters:
        params - The params supplied in the generator config (plus some standard useful extras).
        Returns:
        The name of the value column
        See Also:
        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.
        Parameters:
        params - The params supplied in the generator config (plus some standard useful extras).
        Returns:
        The default segment value to use.

      • determineSegmentColumnSize

        protected int determineSegmentColumnSize​(java.util.Properties params)
        Determine the size of the segment column

        Called during configuration.

        Parameters:
        params - The params supplied in the generator config (plus some standard useful extras).
        Returns:
        The size of the segment column
        See Also:
        getSegmentValueLength()

      • determineInitialValue

        protected int determineInitialValue​(java.util.Properties params)

      • determineIncrementSize

        protected int determineIncrementSize​(java.util.Properties params)

      • buildSelectQuery

        protected java.lang.String buildSelectQuery​(Dialect dialect)

      • buildUpdateQuery

        protected java.lang.String buildUpdateQuery()

      • buildInsertQuery

        protected java.lang.String buildInsertQuery()

      • generateInsertInitCommand

        protected InitCommand generateInsertInitCommand()

      • generate

        public java.io.Serializable generate​(SharedSessionContractImplementor session,
                                     java.lang.Object obj)
        Description copied from interface: IdentifierGenerator
        Generate a new identifier.
        Specified by:
        generate in interface IdentifierGenerator
        Parameters:
        session - The session from which the request originates
        obj - the entity or collection (idbag) for which the id is being generated
        Returns:
        a new identifier