TableCreatorStd (Cameleon OSP Specification)

java.lang.Object
- de.must.dataobj.TableCreatorStd

```
public abstract class TableCreatorStd
extends java.lang.Object
```
Creates tables in an empty database or modifies structure even without using the SQL statement "alter table".

Field Summary

Fields
Modifier and Type	Field and Description
`protected DbModifier`	`dbModifier`
`static int`	`STATE_FULL_HAPPY`
`static int`	`STATE_HAPPY_MINUS_UPDATE`
`static int`	`STATE_UNHAPPY`
`static int`	`TODO_ALTER`
`static int`	`TODO_CREATE`
`static int`	`TODO_UPDATE_STRUCTURE_FOR_ALL_TABLES`
`static int`	`UPDATE_NONE`

Constructor Summary

Constructors
Constructor and Description

TableCreatorStd(GlobalStd global)
Constructs a new table creator.

Constructors
Constructor and Description
`TableCreatorStd(GlobalStd global)` Constructs a new table creator.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`java.util.Vector<java.lang.String>`	`alterTables(int alterationLevel)` Performs table alteration depending on alteration level which for his part depends on the age of the database structure.
`protected void`	`createTable(DataObject dataObject)`
`boolean`	`createTables()` Creates all tables as specified by `getAllEntityInfos()`
`int`	`determineTodo()` Returns what to do with the database structure.
`protected abstract EntityInfo[]`	`getAllEntityInfos()` Returns entity info of all tables needed to execute the application.
`abstract java.lang.String`	`getDatabaseName()` Returns the database name.
`int`	`getHappyState()` Returns how happy the table creator is in detail.
`abstract int`	`getUpdateLevel()` Returns the alteration level depending on the age of the database structure.
`protected void`	`inform(java.lang.String info)` Sends progress information to the previously specified message receiver.
`abstract boolean`	`isCreationNecessary()` Returns true if table creation is necessary.
`boolean`	`isEmpty()` Returns true if database is empty (number of tables = 0).
`boolean`	`isStandardDatabase()` Returns true if the used database name is the standard name.
`void`	`setHappyState(int happyState)`
`void`	`setMessageReceiver(MessageReceiver messageReceiver)` Sets the receiver of progress information send later by `inform(String)`
`protected void`	`tablesCreated()` Event tables created for additional actions like inserting data.
`protected abstract void`	`updateDatabase(int alterationLevel)` Alter tables.
`java.util.Vector<java.lang.String>`	`updateStructureOfAllTables()` Updates all tables - special case!
`protected void`	`updateTable(DataObject dataObject)`

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

- Field Detail
  - UPDATE_NONE
```
public static final int UPDATE_NONE
```
    See Also:
    
    Constant Field Values
  - TODO_UPDATE_STRUCTURE_FOR_ALL_TABLES
```
public static final int TODO_UPDATE_STRUCTURE_FOR_ALL_TABLES
```
    See Also:
    
    Constant Field Values
  - TODO_ALTER
```
public static final int TODO_ALTER
```
    See Also:
    
    Constant Field Values
  - TODO_CREATE
```
public static final int TODO_CREATE
```
    See Also:
    
    Constant Field Values
  - STATE_UNHAPPY
```
public static final int STATE_UNHAPPY
```
    See Also:
    
    Constant Field Values
  - STATE_HAPPY_MINUS_UPDATE
```
public static final int STATE_HAPPY_MINUS_UPDATE
```
    See Also:
    
    Constant Field Values
  - STATE_FULL_HAPPY
```
public static final int STATE_FULL_HAPPY
```
    See Also:
    
    Constant Field Values
  - dbModifier
```
protected DbModifier dbModifier
```
- Constructor Detail
  - TableCreatorStd
```
public TableCreatorStd(GlobalStd global)
```
    Constructs a new table creator.
- Method Detail
  - setMessageReceiver
```
public void setMessageReceiver(MessageReceiver messageReceiver)
```
    Sets the receiver of progress information send later by inform(String)
    
    Parameters:
    
    messageReceiver - the receiver of progress information
  - determineTodo
```
public int determineTodo()
```
    Returns what to do with the database structure. If the result is neither UPDATE_NONE nor TODO_CREATE, the result represents the alteration level, as specified by sub class in getUpdateLevel().
    
    Returns:
    
    what to do with the database structure
    
    See Also:
    
    TODO_CREATE, UPDATE_NONE
  - createTables
```
public boolean createTables()
```
    Creates all tables as specified by getAllEntityInfos()
    
    Returns:
    
    true if all tables have been successfully created
  - updateStructureOfAllTables
```
public java.util.Vector<java.lang.String> updateStructureOfAllTables()
```
    Updates all tables - special case!
  - getAllEntityInfos
```
protected abstract EntityInfo[] getAllEntityInfos()
```
    Returns entity info of all tables needed to execute the application.
    
    Returns:
    
    entity info of all tables needed to execute the application
  - getDatabaseName
```
public abstract java.lang.String getDatabaseName()
```
    Returns the database name.
    
    Returns:
    
    the database name
  - isCreationNecessary
```
public abstract boolean isCreationNecessary()
```
    Returns true if table creation is necessary.
    
    Returns:
    
    true if table creation is necessary
  - isStandardDatabase
```
public boolean isStandardDatabase()
```
    Returns true if the used database name is the standard name.
    
    Returns:
    
    true if the used database name is the standard name
  - isEmpty
```
public boolean isEmpty()
```
    Returns true if database is empty (number of tables = 0).
    
    Returns:
    
    true if database is empty
  - alterTables
```
public java.util.Vector<java.lang.String> alterTables(int alterationLevel)
```
    Performs table alteration depending on alteration level which for his part depends on the age of the database structure.
    
    Parameters:
    
    alterationLevel - the alteration level
    
    Returns:
    
    a list of warnings or error messages caused by the alteration process
  - getUpdateLevel
```
public abstract int getUpdateLevel()
```
    Returns the alteration level depending on the age of the database structure.
    
    Returns:
    
    the alteration level
    
    See Also:
    
    if there is nothing to alter
  - updateDatabase
```
protected abstract void updateDatabase(int alterationLevel)
```
    Alter tables.
    
    Parameters:
    
    dbModifier - the database modifier to use
    
    alterationLevel - the alteration level
  - tablesCreated
```
protected void tablesCreated()
```
    Event tables created for additional actions like inserting data. Override it to add individual actions.
  - createTable
```
protected void createTable(DataObject dataObject)
```
  - updateTable
```
protected void updateTable(DataObject dataObject)
```
  - inform
```
protected void inform(java.lang.String info)
```
    Sends progress information to the previously specified message receiver.
    
    Parameters:
    
    info - the current progress information
  - setHappyState
```
public void setHappyState(int happyState)
```
  - getHappyState
```
public int getHappyState()
```
    Returns how happy the table creator is in detail.
    
    Returns:
    
    how happy the table creator is in detail
    
    See Also:
    
    STATE_FULL_HAPPY, STATE_HAPPY_MINUS_UPDATE, STATE_UNHAPPY

Class TableCreatorStd

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

UPDATE_NONE

TODO_UPDATE_STRUCTURE_FOR_ALL_TABLES

TODO_ALTER

TODO_CREATE

STATE_UNHAPPY

STATE_HAPPY_MINUS_UPDATE

STATE_FULL_HAPPY

dbModifier

Constructor Detail

TableCreatorStd

Method Detail

setMessageReceiver

determineTodo

createTables

updateStructureOfAllTables

getAllEntityInfos

getDatabaseName

isCreationNecessary

isStandardDatabase

isEmpty

alterTables

getUpdateLevel

updateDatabase

tablesCreated

createTable

updateTable

inform

setHappyState

getHappyState