TableGenerator (ShrinkWrap Descriptors Aggregator 2.0.0-alpha-9 API)

All Superinterfaces:

Child<T>, OrmTableGeneratorCommType<T,TableGenerator<T>,UniqueConstraint<TableGenerator<T>>>
```
public interface TableGenerator<T>
extends Child<T>, OrmTableGeneratorCommType<T,TableGenerator<T>,UniqueConstraint<TableGenerator<T>>>
```
This interface defines the contract for the table-generator xsd type

Author:

Ralf Battenfeld, Andrew Lee Rubinger

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`TableGenerator<T>`	`allocationSize(Integer allocationSize)` Sets the `allocation-size` attribute
`TableGenerator<T>`	`catalog(String catalog)` Sets the `catalog` attribute
`Index<TableGenerator<T>>`	`createIndex()` Creates a new `index` element
`UniqueConstraint<TableGenerator<T>>`	`createUniqueConstraint()` Creates a new `unique-constraint` element
`TableGenerator<T>`	`description(String description)` Sets the `description` element
`List<Index<TableGenerator<T>>>`	`getAllIndex()` Returns all `index` elements
`Integer`	`getAllocationSize()` Returns the `allocation-size` attribute
`List<UniqueConstraint<TableGenerator<T>>>`	`getAllUniqueConstraint()` Returns all `unique-constraint` elements
`String`	`getCatalog()` Returns the `catalog` attribute
`String`	`getDescription()` Returns the `description` element
`Integer`	`getInitialValue()` Returns the `initial-value` attribute
`String`	`getName()` Returns the `name` attribute
`Index<TableGenerator<T>>`	`getOrCreateIndex()` If not already created, a new `index` element will be created and returned.
`UniqueConstraint<TableGenerator<T>>`	`getOrCreateUniqueConstraint()` If not already created, a new `unique-constraint` element will be created and returned.
`String`	`getPkColumnName()` Returns the `pk-column-name` attribute
`String`	`getPkColumnValue()` Returns the `pk-column-value` attribute
`String`	`getSchema()` Returns the `schema` attribute
`String`	`getTable()` Returns the `table` attribute
`String`	`getValueColumnName()` Returns the `value-column-name` attribute
`TableGenerator<T>`	`initialValue(Integer initialValue)` Sets the `initial-value` attribute
`TableGenerator<T>`	`name(String name)` Sets the `name` attribute
`TableGenerator<T>`	`pkColumnName(String pkColumnName)` Sets the `pk-column-name` attribute
`TableGenerator<T>`	`pkColumnValue(String pkColumnValue)` Sets the `pk-column-value` attribute
`TableGenerator<T>`	`removeAllIndex()` Removes all `index` elements
`TableGenerator<T>`	`removeAllocationSize()` Removes the `allocation-size` attribute
`TableGenerator<T>`	`removeAllUniqueConstraint()` Removes all `unique-constraint` elements
`TableGenerator<T>`	`removeCatalog()` Removes the `catalog` attribute
`TableGenerator<T>`	`removeDescription()` Removes the `description` element
`TableGenerator<T>`	`removeInitialValue()` Removes the `initial-value` attribute
`TableGenerator<T>`	`removeName()` Removes the `name` attribute
`TableGenerator<T>`	`removePkColumnName()` Removes the `pk-column-name` attribute
`TableGenerator<T>`	`removePkColumnValue()` Removes the `pk-column-value` attribute
`TableGenerator<T>`	`removeSchema()` Removes the `schema` attribute
`TableGenerator<T>`	`removeTable()` Removes the `table` attribute
`TableGenerator<T>`	`removeValueColumnName()` Removes the `value-column-name` attribute
`TableGenerator<T>`	`schema(String schema)` Sets the `schema` attribute
`TableGenerator<T>`	`table(String table)` Sets the `table` attribute
`TableGenerator<T>`	`valueColumnName(String valueColumnName)` Sets the `value-column-name` attribute

Methods inherited from interface org.jboss.shrinkwrap.descriptor.api.Child
up

- Method Detail
  - description
```
TableGenerator<T> description(String description)
```
    Sets the description element
    
    Parameters:
    
    description - the value for the element description
    
    Returns:
    
    the current instance of TableGenerator
  - getDescription
```
String getDescription()
```
    Returns the description element
    
    Returns:
    
    the node defined for the element description
  - removeDescription
```
TableGenerator<T> removeDescription()
```
    Removes the description element
    
    Returns:
    
    the current instance of TableGenerator
  - getOrCreateUniqueConstraint
```
UniqueConstraint<TableGenerator<T>> getOrCreateUniqueConstraint()
```
    If not already created, a new unique-constraint element will be created and returned. Otherwise, the first existing unique-constraint element will be returned.
    
    Returns:
    
    the instance defined for the element unique-constraint
  - createUniqueConstraint
```
UniqueConstraint<TableGenerator<T>> createUniqueConstraint()
```
    Creates a new unique-constraint element
    
    Returns:
    
    the new created instance of UniqueConstraint>
  - getAllUniqueConstraint
```
List<UniqueConstraint<TableGenerator<T>>> getAllUniqueConstraint()
```
    Returns all unique-constraint elements
    
    Returns:
    
    list of unique-constraint
  - removeAllUniqueConstraint
```
TableGenerator<T> removeAllUniqueConstraint()
```
    Removes all unique-constraint elements
    
    Returns:
    
    the current instance of UniqueConstraint>
  - getOrCreateIndex
```
Index<TableGenerator<T>> getOrCreateIndex()
```
    If not already created, a new index element will be created and returned. Otherwise, the first existing index element will be returned.
    
    Returns:
    
    the instance defined for the element index
  - createIndex
```
Index<TableGenerator<T>> createIndex()
```
    Creates a new index element
    
    Returns:
    
    the new created instance of Index>
  - getAllIndex
```
List<Index<TableGenerator<T>>> getAllIndex()
```
    Returns all index elements
    
    Returns:
    
    list of index
  - removeAllIndex
```
TableGenerator<T> removeAllIndex()
```
    Removes all index elements
    
    Returns:
    
    the current instance of Index>
  - name
```
TableGenerator<T> name(String name)
```
    Sets the name attribute
    
    Parameters:
    
    name - the value for the attribute name
    
    Returns:
    
    the current instance of TableGenerator
  - getName
```
String getName()
```
    Returns the name attribute
    
    Returns:
    
    the value defined for the attribute name
  - removeName
```
TableGenerator<T> removeName()
```
    Removes the name attribute
    
    Returns:
    
    the current instance of TableGenerator
  - table
```
TableGenerator<T> table(String table)
```
    Sets the table attribute
    
    Parameters:
    
    table - the value for the attribute table
    
    Returns:
    
    the current instance of TableGenerator
  - getTable
```
String getTable()
```
    Returns the table attribute
    
    Returns:
    
    the value defined for the attribute table
  - removeTable
```
TableGenerator<T> removeTable()
```
    Removes the table attribute
    
    Returns:
    
    the current instance of TableGenerator
  - catalog
```
TableGenerator<T> catalog(String catalog)
```
    Sets the catalog attribute
    
    Parameters:
    
    catalog - the value for the attribute catalog
    
    Returns:
    
    the current instance of TableGenerator
  - getCatalog
```
String getCatalog()
```
    Returns the catalog attribute
    
    Returns:
    
    the value defined for the attribute catalog
  - removeCatalog
```
TableGenerator<T> removeCatalog()
```
    Removes the catalog attribute
    
    Returns:
    
    the current instance of TableGenerator
  - schema
```
TableGenerator<T> schema(String schema)
```
    Sets the schema attribute
    
    Parameters:
    
    schema - the value for the attribute schema
    
    Returns:
    
    the current instance of TableGenerator
  - getSchema
```
String getSchema()
```
    Returns the schema attribute
    
    Returns:
    
    the value defined for the attribute schema
  - removeSchema
```
TableGenerator<T> removeSchema()
```
    Removes the schema attribute
    
    Returns:
    
    the current instance of TableGenerator
  - pkColumnName
```
TableGenerator<T> pkColumnName(String pkColumnName)
```
    Sets the pk-column-name attribute
    
    Parameters:
    
    pkColumnName - the value for the attribute pk-column-name
    
    Returns:
    
    the current instance of TableGenerator
  - getPkColumnName
```
String getPkColumnName()
```
    Returns the pk-column-name attribute
    
    Returns:
    
    the value defined for the attribute pk-column-name
  - removePkColumnName
```
TableGenerator<T> removePkColumnName()
```
    Removes the pk-column-name attribute
    
    Returns:
    
    the current instance of TableGenerator
  - valueColumnName
```
TableGenerator<T> valueColumnName(String valueColumnName)
```
    Sets the value-column-name attribute
    
    Parameters:
    
    valueColumnName - the value for the attribute value-column-name
    
    Returns:
    
    the current instance of TableGenerator
  - getValueColumnName
```
String getValueColumnName()
```
    Returns the value-column-name attribute
    
    Returns:
    
    the value defined for the attribute value-column-name
  - removeValueColumnName
```
TableGenerator<T> removeValueColumnName()
```
    Removes the value-column-name attribute
    
    Returns:
    
    the current instance of TableGenerator
  - pkColumnValue
```
TableGenerator<T> pkColumnValue(String pkColumnValue)
```
    Sets the pk-column-value attribute
    
    Parameters:
    
    pkColumnValue - the value for the attribute pk-column-value
    
    Returns:
    
    the current instance of TableGenerator
  - getPkColumnValue
```
String getPkColumnValue()
```
    Returns the pk-column-value attribute
    
    Returns:
    
    the value defined for the attribute pk-column-value
  - removePkColumnValue
```
TableGenerator<T> removePkColumnValue()
```
    Removes the pk-column-value attribute
    
    Returns:
    
    the current instance of TableGenerator
  - initialValue
```
TableGenerator<T> initialValue(Integer initialValue)
```
    Sets the initial-value attribute
    
    Parameters:
    
    initialValue - the value for the attribute initial-value
    
    Returns:
    
    the current instance of TableGenerator
  - getInitialValue
```
Integer getInitialValue()
```
    Returns the initial-value attribute
    
    Returns:
    
    the value defined for the attribute initial-value
  - removeInitialValue
```
TableGenerator<T> removeInitialValue()
```
    Removes the initial-value attribute
    
    Returns:
    
    the current instance of TableGenerator
  - allocationSize
```
TableGenerator<T> allocationSize(Integer allocationSize)
```
    Sets the allocation-size attribute
    
    Parameters:
    
    allocationSize - the value for the attribute allocation-size
    
    Returns:
    
    the current instance of TableGenerator
  - getAllocationSize
```
Integer getAllocationSize()
```
    Returns the allocation-size attribute
    
    Returns:
    
    the value defined for the attribute allocation-size
  - removeAllocationSize
```
TableGenerator<T> removeAllocationSize()
```
    Removes the allocation-size attribute
    
    Returns:
    
    the current instance of TableGenerator

Interface TableGenerator<T>

Method Summary

Methods inherited from interface org.jboss.shrinkwrap.descriptor.api.Child

Method Detail

description

getDescription

removeDescription

getOrCreateUniqueConstraint

createUniqueConstraint

getAllUniqueConstraint

removeAllUniqueConstraint

getOrCreateIndex

createIndex

getAllIndex

removeAllIndex

name

getName

removeName

table

getTable

removeTable

catalog

getCatalog

removeCatalog

schema

getSchema

removeSchema

pkColumnName

getPkColumnName

removePkColumnName

valueColumnName

getValueColumnName

removeValueColumnName

pkColumnValue

getPkColumnValue

removePkColumnValue

initialValue

getInitialValue

removeInitialValue

allocationSize

getAllocationSize

removeAllocationSize