Autonumerical (ontimize-core 5.6.0 API)

java.lang.Object
- com.ontimize.db.Autonumerical

```
public class Autonumerical
extends Object
```
This class implements an incremental number generator. It provides methods so that the entities can obtain those numbers. Modification 20/05/2004: It has been modified to allow the use of multiple counters. The current behavior is: The table associated to the autonumerical must have the following columns: - state - general autonumerical (numeric data type) Furthermore, it can have additional columns in which an autonumerical associated to the column name is stored

Version:

1.0

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

protected class Autonumerical.SavingThread

Nested Classes
Modifier and Type	Class and Description
`protected class`	`Autonumerical.SavingThread`

Field Summary

Fields
Modifier and Type	Field and Description
`protected int[]`	`autonumerical`
`protected int`	`autonumericalCountSinceLastSave`
`protected boolean`	`bSynchronized`
`protected String`	`column`
`static String`	`COLUMN`
`protected String[]`	`columnNames`
`protected Properties`	`databaseProperties`
`protected static int`	`DEFAULT_SAVING_CICLE`
`protected String`	`defaultSequence`
`protected String`	`driver`
`protected boolean`	`forceDisconnection`
`static String`	`ISOLATION_LEVEL`
`protected boolean`	`isolationChange`
`static boolean`	`isolationLevelChange`
`static String`	`LOG_KEYS`
`protected Vector`	`logkeys`
`protected DatabaseConnectionManager`	`manager`
`protected String`	`password`
`protected Properties`	`properties`
`static String`	`SAVING_CYCLE`
`static String`	`SAVING_INTERVAL`
`protected int`	`savingCycle`
`protected int`	`savingInterval`
`static String`	`SEQUENCE_FORMAT` HSQLDB - NEXT VALUE FOR %s ORACLE - %s.nextval POSTGRES - nextval('%s') SQLServer - NEXT VALUE FOR %s
`protected String`	`sequenceFormat`
`static String`	`SEQUENCES`
`static String`	`STATE_COLUMN`
`protected String`	`stateColumn`
`protected Connection`	`staticCon`
`static boolean`	`SYNCHRONIZE`
`static String`	`SYNCHRONIZE_VALUE`
`protected String`	`table`
`static String`	`TABLE`
`protected Hashtable`	`tableToSequence`
`protected Autonumerical.SavingThread`	`thread`
`protected String`	`uRLDatabase`
`protected String`	`user`
`protected boolean`	`useSequence`

Constructor Summary

Constructors
Constructor and Description
`Autonumerical(String propertyFile, DatabaseConnectionManager dbConMan)`
`Autonumerical(URL propertyFile, Connection connection)` Creates a new Autonumerical object instance
`Autonumerical(URL propertyFile, DatabaseConnectionManager dbConMan)`
`Autonumerical(URL propertyFile, URL urlDBProp)` Creates a new Autonumerical object instance
`Autonumerical(URL propertyFile, URL urlDBProp, boolean createFistConnection)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`activateForceDisconnection()`
`OntimizeConnection`	`connect()`
`void`	`disactivateForceDisconnection()`
`protected void`	`finalize()`
`int`	`getAutonumerical()` Gets an sequential integer value to use as unique identifier.
`int`	`getAutonumerical(String col)`
`protected int`	`getColumnNameIndex(String name)`
`protected String`	`getCurrentThreadMethods(Throwable e, int lines)`
`protected int`	`increment(String column)`
`protected int`	`increment(String column, Connection con)`
`int`	`incrementAutonumerical(int increment)`
`int`	`incrementAutonumerical(int increment, String col)`
`protected int`	`incrementSequence(String column, Connection con)` HSQLDB - NEXT VALUE FOR sequence_name ORACLE - sequence_name.nextval POSTGRES - nextval('sequence_name') SQLServer - NEXT VALUE FOR sequence_name
`protected void`	`initAutonumerical()`
`protected void`	`initConnection(URL urlDBProp, boolean createFirstConnection)`
`protected void`	`initializeTable(Connection con)`
`boolean`	`isForceDisconnectionEnabled()`
`boolean`	`isSynchronized()`
`protected void`	`logToLogKeys(String s)`
`protected void`	`logToLogKeys(String s, boolean newLine)`
`protected Connection`	`reconnection()`
`protected void`	`save()`
`protected boolean`	`saveAutonumerical()`
`protected boolean`	`setIncorrectState()`
`protected void`	`startSavingThread()`

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

- Field Detail
  - SYNCHRONIZE
```
public static boolean SYNCHRONIZE
```
  - isolationLevelChange
```
public static boolean isolationLevelChange
```
  - TABLE
```
public static final String TABLE
```
    See Also:
    Constant Field Values
  - COLUMN
```
public static final String COLUMN
```
    See Also:
    Constant Field Values
  - STATE_COLUMN
```
public static final String STATE_COLUMN
```
    See Also:
    Constant Field Values
  - LOG_KEYS
```
public static final String LOG_KEYS
```
    See Also:
    Constant Field Values
  - SAVING_CYCLE
```
public static final String SAVING_CYCLE
```
    See Also:
    Constant Field Values
  - SAVING_INTERVAL
```
public static final String SAVING_INTERVAL
```
    See Also:
    Constant Field Values
  - SYNCHRONIZE_VALUE
```
public static final String SYNCHRONIZE_VALUE
```
    See Also:
    Constant Field Values
  - ISOLATION_LEVEL
```
public static final String ISOLATION_LEVEL
```
    See Also:
    Constant Field Values
  - SEQUENCES
```
public static final String SEQUENCES
```
    See Also:
    Constant Field Values
  - SEQUENCE_FORMAT
```
public static final String SEQUENCE_FORMAT
```
    HSQLDB - NEXT VALUE FOR %s ORACLE - %s.nextval POSTGRES - nextval('%s') SQLServer - NEXT VALUE FOR %s
    
    See Also:
    Constant Field Values
  - DEFAULT_SAVING_CICLE
```
protected static final int DEFAULT_SAVING_CICLE
```
    See Also:
    Constant Field Values
  - savingInterval
```
protected int savingInterval
```
  - table
```
protected String table
```
  - column
```
protected String column
```
  - stateColumn
```
protected String stateColumn
```
  - logkeys
```
protected Vector logkeys
```
  - savingCycle
```
protected int savingCycle
```
  - staticCon
```
protected Connection staticCon
```
  - columnNames
```
protected String[] columnNames
```
  - autonumerical
```
protected int[] autonumerical
```
  - properties
```
protected Properties properties
```
  - databaseProperties
```
protected Properties databaseProperties
```
  - thread
```
protected Autonumerical.SavingThread thread
```
  - user
```
protected String user
```
  - password
```
protected String password
```
  - driver
```
protected String driver
```
  - uRLDatabase
```
protected String uRLDatabase
```
  - autonumericalCountSinceLastSave
```
protected int autonumericalCountSinceLastSave
```
  - bSynchronized
```
protected volatile boolean bSynchronized
```
  - isolationChange
```
protected boolean isolationChange
```
  - useSequence
```
protected boolean useSequence
```
  - defaultSequence
```
protected String defaultSequence
```
  - sequenceFormat
```
protected String sequenceFormat
```
  - tableToSequence
```
protected Hashtable tableToSequence
```
  - manager
```
protected DatabaseConnectionManager manager
```
  - forceDisconnection
```
protected boolean forceDisconnection
```
- Constructor Detail
  - Autonumerical
```
public Autonumerical(URL propertyFile,
             Connection connection)
              throws Exception
```
    Creates a new Autonumerical object instance
    
    Parameters:
    propertyFile - In the property file 'propertyFile' the following parameters are included::
    - Table: Table: Name of the table the last autonumerical is stored in
    - Column : Name of the column the number is stored in
    - StateColumn: Name of the column the state is stored in. Possible states: '1' correct, '0' incorrect.
    - SavingCycle: Time in milliseconds between each update of the autonumerical in the table
    connection - Database connection
    
    Throws:
    
    Exception
  - Autonumerical
```
public Autonumerical(URL propertyFile,
             URL urlDBProp)
              throws Exception
```
    Creates a new Autonumerical object instance
    
    Parameters:
    propertyFile - In the property file 'propertyFile' the following parameters are included::
    - Table: Name of the table the last autonumerical is stored in
    - Column : Name of the column the number is stored in
    - StateColumn: Name of the column the state is stored in. Possible states: '1' correct, '0' incorrect.
    - LogKeys: Name of the logs which the object operations are written in. If no log is specified, no log is made.
    - SavingCycle: Time in milliseconds between each update of the autonumerical in the table
    -SavingInterval: Number of autonumericals provided before storing the value in the table.
    urlDBProp - This parameter specifies the DB connection property file. It will have the following parameters::
    - driver: JDBC driver class
    - url: database url connection.
    - user: database user name
    - password: database password for the specified user.
    
    Throws:
    
    Exception
  - Autonumerical
```
public Autonumerical(URL propertyFile,
             URL urlDBProp,
             boolean createFistConnection)
              throws Exception
```
    Throws:
    
    Exception
  - Autonumerical
```
public Autonumerical(URL propertyFile,
             DatabaseConnectionManager dbConMan)
              throws Exception
```
    Throws:
    
    Exception
  - Autonumerical
```
public Autonumerical(String propertyFile,
             DatabaseConnectionManager dbConMan)
              throws Exception
```
    Throws:
    
    Exception
- Method Detail
  - initAutonumerical
```
protected void initAutonumerical()
```
  - getColumnNameIndex
```
protected int getColumnNameIndex(String name)
```
  - startSavingThread
```
protected void startSavingThread()
```
  - initConnection
```
protected void initConnection(URL urlDBProp,
                  boolean createFirstConnection)
                       throws Exception
```
    Throws:
    
    Exception
  - getAutonumerical
```
public int getAutonumerical()
```
    Gets an sequential integer value to use as unique identifier. To ensure that the last generated value is stored successfully in the database tablePara executes the following mechanism:
    - After 'n' requests database it updates the databse table and sets the state as correct
    - In the first request of the next 'n' autonumerical values, the states column sets as incorrect.
    - When the class is created checks if the state is correct or not. If the state column has incorrect value automatically it sum a value to the autonumerical number column
    
    Returns:
  - getAutonumerical
```
public int getAutonumerical(String col)
```
  - incrementAutonumerical
```
public int incrementAutonumerical(int increment)
```
  - incrementAutonumerical
```
public int incrementAutonumerical(int increment,
                         String col)
```
  - saveAutonumerical
```
protected boolean saveAutonumerical()
```
  - increment
```
protected int increment(String column)
                 throws Exception
```
    Throws:
    
    Exception
  - incrementSequence
```
protected int incrementSequence(String column,
                    Connection con)
                         throws Exception
```
    HSQLDB - NEXT VALUE FOR sequence_name ORACLE - sequence_name.nextval POSTGRES - nextval('sequence_name') SQLServer - NEXT VALUE FOR sequence_name
    
    Parameters:
    column -
    con -
    
    Returns:
    
    Throws:
    
    Exception
  - increment
```
protected int increment(String column,
            Connection con)
                 throws Exception
```
    Throws:
    
    Exception
  - initializeTable
```
protected void initializeTable(Connection con)
                        throws Exception
```
    Throws:
    
    Exception
  - save
```
protected void save()
             throws Exception
```
    Throws:
    
    Exception
  - setIncorrectState
```
protected boolean setIncorrectState()
```
  - reconnection
```
protected Connection reconnection()
                           throws Exception
```
    Throws:
    
    Exception
  - finalize
```
protected void finalize()
                 throws Throwable
```
    Overrides:
    
    finalize in class Object
    
    Throws:
    
    Throwable
  - logToLogKeys
```
protected void logToLogKeys(String s)
```
  - logToLogKeys
```
protected void logToLogKeys(String s,
                boolean newLine)
```
  - getCurrentThreadMethods
```
protected String getCurrentThreadMethods(Throwable e,
                             int lines)
```
  - activateForceDisconnection
```
public void activateForceDisconnection()
                                throws Exception
```
    Throws:
    
    Exception
  - disactivateForceDisconnection
```
public void disactivateForceDisconnection()
                                   throws Exception
```
    Throws:
    
    Exception
  - isForceDisconnectionEnabled
```
public boolean isForceDisconnectionEnabled()
```
  - isSynchronized
```
public boolean isSynchronized()
```
  - connect
```
public OntimizeConnection connect()
                           throws Exception
```
    Throws:
    
    Exception

Class Autonumerical

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SYNCHRONIZE

isolationLevelChange

TABLE

COLUMN

STATE_COLUMN

LOG_KEYS

SAVING_CYCLE

SAVING_INTERVAL

SYNCHRONIZE_VALUE

ISOLATION_LEVEL

SEQUENCES

SEQUENCE_FORMAT

DEFAULT_SAVING_CICLE

savingInterval

table

column

stateColumn

logkeys

savingCycle

staticCon

columnNames

autonumerical

properties

databaseProperties

thread

user

password

driver

uRLDatabase

autonumericalCountSinceLastSave

bSynchronized

isolationChange

useSequence

defaultSequence

sequenceFormat

tableToSequence

manager

forceDisconnection

Constructor Detail

Autonumerical

Autonumerical

Autonumerical

Autonumerical

Autonumerical

Method Detail

initAutonumerical

getColumnNameIndex

startSavingThread

initConnection

getAutonumerical

getAutonumerical

incrementAutonumerical

incrementAutonumerical

saveAutonumerical

increment

incrementSequence

increment

initializeTable

save

setIncorrectState

reconnection

finalize

logToLogKeys

logToLogKeys

getCurrentThreadMethods

activateForceDisconnection

disactivateForceDisconnection

isForceDisconnectionEnabled

isSynchronized

connect