TableGenerator (hibernate-jpamodelgen JavaDocs)

java.lang.Object
- org.hibernate.jpamodelgen.xml.jaxb.TableGenerator

```
public class TableGenerator
extends Object
```
@Target({TYPE, METHOD, FIELD}) @Retention(RUNTIME) public @interface TableGenerator { String name(); String table() default ""; String catalog() default ""; String schema() default ""; String pkColumnName() default ""; String valueColumnName() default ""; String pkColumnValue() default ""; int initialValue() default 0; int allocationSize() default 50; UniqueConstraint[] uniqueConstraints() default {}; Indexes[] indexes() default {}; }

Java class for table-generator complex type.

The following schema fragment specifies the expected content contained within this class.

<pre> <complexType name="table-generator"> <complexContent> <restriction base="{http://www.w3.org/2001/XMLSchema}anyType"> <sequence> <element name="description" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/> <element name="unique-constraint" type="{http://xmlns.jcp.org/xml/ns/persistence/orm}unique-constraint" maxOccurs="unbounded" minOccurs="0"/> <element name="index" type="{http://xmlns.jcp.org/xml/ns/persistence/orm}index" maxOccurs="unbounded" minOccurs="0"/> </sequence> <attribute name="name" use="required" type="{http://www.w3.org/2001/XMLSchema}string" /> <attribute name="table" type="{http://www.w3.org/2001/XMLSchema}string" /> <attribute name="catalog" type="{http://www.w3.org/2001/XMLSchema}string" /> <attribute name="schema" type="{http://www.w3.org/2001/XMLSchema}string" /> <attribute name="pk-column-name" type="{http://www.w3.org/2001/XMLSchema}string" /> <attribute name="value-column-name" type="{http://www.w3.org/2001/XMLSchema}string" /> <attribute name="pk-column-value" type="{http://www.w3.org/2001/XMLSchema}string" /> <attribute name="initial-value" type="{http://www.w3.org/2001/XMLSchema}int" /> <attribute name="allocation-size" type="{http://www.w3.org/2001/XMLSchema}int" /> </restriction> </complexContent> </complexType> </pre>

Field Summary

Fields
Modifier and Type	Field and Description
`protected Integer`	`allocationSize`
`protected String`	`catalog`
`protected String`	`description`
`protected List<Index>`	`index`
`protected Integer`	`initialValue`
`protected String`	`name`
`protected String`	`pkColumnName`
`protected String`	`pkColumnValue`
`protected String`	`schema`
`protected String`	`table`
`protected List<UniqueConstraint>`	`uniqueConstraint`
`protected String`	`valueColumnName`

Constructor Summary

Constructors
Constructor and Description

TableGenerator()

Constructors
Constructor and Description
`TableGenerator()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Integer`	`getAllocationSize()` Gets the value of the allocationSize property.
`String`	`getCatalog()` Gets the value of the catalog property.
`String`	`getDescription()` Gets the value of the description property.
`List<Index>`	`getIndex()` Gets the value of the index property.
`Integer`	`getInitialValue()` Gets the value of the initialValue property.
`String`	`getName()` Gets the value of the name property.
`String`	`getPkColumnName()` Gets the value of the pkColumnName property.
`String`	`getPkColumnValue()` Gets the value of the pkColumnValue property.
`String`	`getSchema()` Gets the value of the schema property.
`String`	`getTable()` Gets the value of the table property.
`List<UniqueConstraint>`	`getUniqueConstraint()` Gets the value of the uniqueConstraint property.
`String`	`getValueColumnName()` Gets the value of the valueColumnName property.
`void`	`setAllocationSize(Integer value)` Sets the value of the allocationSize property.
`void`	`setCatalog(String value)` Sets the value of the catalog property.
`void`	`setDescription(String value)` Sets the value of the description property.
`void`	`setInitialValue(Integer value)` Sets the value of the initialValue property.
`void`	`setName(String value)` Sets the value of the name property.
`void`	`setPkColumnName(String value)` Sets the value of the pkColumnName property.
`void`	`setPkColumnValue(String value)` Sets the value of the pkColumnValue property.
`void`	`setSchema(String value)` Sets the value of the schema property.
`void`	`setTable(String value)` Sets the value of the table property.
`void`	`setValueColumnName(String value)` Sets the value of the valueColumnName property.

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

- Field Detail
 - description
```
protected String description
```
 - uniqueConstraint
```
protected List<UniqueConstraint> uniqueConstraint
```
 - index
```
protected List<Index> index
```
 - name
```
protected String name
```
 - table
```
protected String table
```
 - catalog
```
protected String catalog
```
 - schema
```
protected String schema
```
 - pkColumnName
```
protected String pkColumnName
```
 - valueColumnName
```
protected String valueColumnName
```
 - pkColumnValue
```
protected String pkColumnValue
```
 - initialValue
```
protected Integer initialValue
```
 - allocationSize
```
protected Integer allocationSize
```
- Constructor Detail
 - TableGenerator
```
public TableGenerator()
```
- Method Detail
 - getDescription
```
public String getDescription()
```
 Gets the value of the description property.
 
 Returns:
 
 possible object is String
 - setDescription
```
public void setDescription(String value)
```
 Sets the value of the description property.
 
 Parameters:
 
 value - allowed object is String
 - getUniqueConstraint
```
public List<UniqueConstraint> getUniqueConstraint()
```
 Gets the value of the uniqueConstraint property.
 
 This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a <CODE>set</CODE> method for the uniqueConstraint property.
 
 For example, to add a new item, do as follows: <pre> getUniqueConstraint().add(newItem); </pre>
 
 Objects of the following type(s) are allowed in the list UniqueConstraint
 - getIndex
```
public List<Index> getIndex()
```
 Gets the value of the index property.
 
 This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a <CODE>set</CODE> method for the index property.
 
 For example, to add a new item, do as follows: <pre> getIndex().add(newItem); </pre>
 
 Objects of the following type(s) are allowed in the list Index
 - getName
```
public String getName()
```
 Gets the value of the name property.
 
 Returns:
 
 possible object is String
 - setName
```
public void setName(String value)
```
 Sets the value of the name property.
 
 Parameters:
 
 value - allowed object is String
 - getTable
```
public String getTable()
```
 Gets the value of the table property.
 
 Returns:
 
 possible object is String
 - setTable
```
public void setTable(String value)
```
 Sets the value of the table property.
 
 Parameters:
 
 value - allowed object is String
 - getCatalog
```
public String getCatalog()
```
 Gets the value of the catalog property.
 
 Returns:
 
 possible object is String
 - setCatalog
```
public void setCatalog(String value)
```
 Sets the value of the catalog property.
 
 Parameters:
 
 value - allowed object is String
 - getSchema
```
public String getSchema()
```
 Gets the value of the schema property.
 
 Returns:
 
 possible object is String
 - setSchema
```
public void setSchema(String value)
```
 Sets the value of the schema property.
 
 Parameters:
 
 value - allowed object is String
 - getPkColumnName
```
public String getPkColumnName()
```
 Gets the value of the pkColumnName property.
 
 Returns:
 
 possible object is String
 - setPkColumnName
```
public void setPkColumnName(String value)
```
 Sets the value of the pkColumnName property.
 
 Parameters:
 
 value - allowed object is String
 - getValueColumnName
```
public String getValueColumnName()
```
 Gets the value of the valueColumnName property.
 
 Returns:
 
 possible object is String
 - setValueColumnName
```
public void setValueColumnName(String value)
```
 Sets the value of the valueColumnName property.
 
 Parameters:
 
 value - allowed object is String
 - getPkColumnValue
```
public String getPkColumnValue()
```
 Gets the value of the pkColumnValue property.
 
 Returns:
 
 possible object is String
 - setPkColumnValue
```
public void setPkColumnValue(String value)
```
 Sets the value of the pkColumnValue property.
 
 Parameters:
 
 value - allowed object is String
 - getInitialValue
```
public Integer getInitialValue()
```
 Gets the value of the initialValue property.
 
 Returns:
 
 possible object is Integer
 - setInitialValue
```
public void setInitialValue(Integer value)
```
 Sets the value of the initialValue property.
 
 Parameters:
 
 value - allowed object is Integer
 - getAllocationSize
```
public Integer getAllocationSize()
```
 Gets the value of the allocationSize property.
 
 Returns:
 
 possible object is Integer
 - setAllocationSize
```
public void setAllocationSize(Integer value)
```
 Sets the value of the allocationSize property.
 
 Parameters:
 
 value - allowed object is Integer

Class TableGenerator

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

description

uniqueConstraint

index

name

table

catalog

schema

pkColumnName

valueColumnName

pkColumnValue

initialValue

allocationSize

Constructor Detail

TableGenerator

Method Detail

getDescription

setDescription

getUniqueConstraint

getIndex

getName

setName

getTable

setTable

getCatalog

setCatalog

getSchema

setSchema

getPkColumnName

setPkColumnName

getValueColumnName

setValueColumnName

getPkColumnValue

setPkColumnValue

getInitialValue

setInitialValue

getAllocationSize

setAllocationSize