Column (jdialects 1.0.2 API)

java.lang.Object
- com.github.drinkjava2.jdialects.model.Column

```
public class Column
extends Object
```
The platform-independent Column model

Since:

1.0.0

Author:

Yong Zhu

Constructor Summary

Constructors
Constructor and Description

Column(String columnName)

Constructors
Constructor and Description
`Column(String columnName)`

Method Summary

Methods
Modifier and Type	Method and Description
`Column`	`autoID()` bind column to a global Auto Id generator, can be Sequence(if support) or a Table to store maximum current ID, determined by jDialects, to get next auto generated ID value, need run dialect.getNextAutoID(connection) method
`Column`	`BIGDECIMAL(Integer precision, Integer scale)`
`Column`	`BIGINT()`
`Column`	`BINARY(Integer... lengths)`
`Column`	`BIT()`
`Column`	`BLOB(Integer... lengths)`
`Column`	`BOOLEAN()`
`Column`	`CHAR(Integer... lengths)`
`Column`	`check(String check)` Add a column check DDL piece if support
`Column`	`CLOB(Integer... lengths)`
`Column`	`comment(String comment)`
`Column`	`DATE()`
`Column`	`DECIMAL(Integer... lengths)`
`Column`	`defaultValue(String value)`
`Column`	`DOUBLE()`
`Column`	`fkey(String fkeyReferenceTable, String... fkeyReferenceColumns)`
`Column`	`FLOAT(Integer... lengths)`
`Boolean`	`getAutoGenerator()`
`String`	`getCheck()`
`String`	`getColumnName()`
`Type`	`getColumnType()`
`String`	`getComment()`
`String`	`getDefaultValue()`
`String[]`	`getFkeyReferenceColumns()`
`String`	`getFkeyReferenceTable()`
`Boolean`	`getIdentity()`
`Boolean`	`getIndex()`
`String[]`	`getIndexNames()`
`Integer[]`	`getLengths()`
`Boolean`	`getNotNull()`
`Boolean`	`getPkey()`
`String`	`getPkeyName()`
`String`	`getSequence()`
`String`	`getTableGenerator()`
`String`	`getTail()`
`Boolean`	`getUnique()`
`String`	`getUniqueConstraintName()`
`Column`	`identity()`
`Column`	`index()` Add a index DDL piece for current column if support
`Column`	`index(String... indexNames)` Add index DDL piece by given indexNames if support, indexNames can be empty or multiple, if in a table has same name indexNames, will cause build compound index for columns with same name index name.
`Column`	`INTEGER()`
`Column`	`JAVA_OBJECT()`
`Column`	`LONG()`
`Column`	`LONGNVARCHAR(Integer length)`
`Column`	`LONGVARBINARY(Integer... lengths)`
`Column`	`LONGVARCHAR(Integer... lengths)`
`Column`	`NCHAR(Integer length)`
`Column`	`NCLOB()`
`Column`	`notNull()` Add a not null DDL piece if support
`Column`	`NUMERIC(Integer... lengths)`
`Column`	`NVARCHAR(Integer length)`
`Column`	`OTHER(Integer... lengths)`
`Column`	`pkey()`
`Column`	`pkey(String pkeyName)`
`Column`	`REAL()`
`Column`	`sequence(String sequence)` bind column to a sequence
`void`	`setAutoGenerator(Boolean autoGenerator)`
`void`	`setCheck(String check)`
`void`	`setColumnName(String columnName)`
`void`	`setColumnType(Type columnType)`
`void`	`setComment(String comment)`
`void`	`setDefaultValue(String defaultValue)`
`void`	`setFkeyReferenceColumns(String[] fkeyReferenceColumns)`
`void`	`setFkeyReferenceTable(String fkeyReferenceTable)`
`void`	`setIdentity(Boolean identity)`
`void`	`setIndex(Boolean index)`
`void`	`setIndexName(String[] indexNames)`
`void`	`setLengths(Integer[] lengths)`
`void`	`setNotNull(Boolean notNull)`
`void`	`setPkey(Boolean pkey)`
`void`	`setPkeyName(String pkeyName)`
`void`	`setSequence(String sequence)`
`void`	`setTableGenerator(String tableGenerator)`
`void`	`setTail(String tail)`
`void`	`setUnique(Boolean unique)`
`void`	`setUniqueConstraintName(String uniqueConstraintName)`
`Column`	`SHORT()`
`Column`	`SMALLINT()`
`Column`	`STRING(Integer length)`
`Column`	`tableGenerator(String tableGenerator)` bind column to a tableGenerator
`Column`	`tail(String tail)` Put an extra tail String manually at the end of column definition DDL
`Column`	`TIME()`
`Column`	`TIMESTAMP()`
`Column`	`TINYINT()`
`Column`	`unique()` Add a unique DDL piece if support
`Column`	`unique(String uniqueConstraintName)` Add a unique DDL piece by given uniqueConstraintName if support
`Column`	`VARBINARY(Integer... lengths)`
`Column`	`VARCHAR(Integer length)`

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

Constructor Detail
- Column
```
public Column(String columnName)
```

Method Detail

notNull
```
public Column notNull()
```
Add a not null DDL piece if support

unique
```
public Column unique()
```
Add a unique DDL piece if support

unique
```
public Column unique(String uniqueConstraintName)
```
Add a unique DDL piece by given uniqueConstraintName if support

check
```
public Column check(String check)
```
Add a column check DDL piece if support

index
```
public Column index(String... indexNames)
```
Add index DDL piece by given indexNames if support, indexNames can be empty or multiple, if in a table has same name indexNames, will cause build compound index for columns with same name index name.

Parameters:
indexNames - Optional, the index names

Returns:
current column Object

index
```
public Column index()
```
Add a index DDL piece for current column if support

identity
```
public Column identity()
```

defaultValue

public Column defaultValue(String value)

comment

public Column comment(String comment)

pkey
```
public Column pkey()
```

pkey
```
public Column pkey(String pkeyName)
```

fkey

public Column fkey(String fkeyReferenceTable,
          String... fkeyReferenceColumns)

sequence

public Column sequence(String sequence)

bind column to a sequence

tableGenerator

public Column tableGenerator(String tableGenerator)

bind column to a tableGenerator

autoID
```
public Column autoID()
```
bind column to a global Auto Id generator, can be Sequence(if support) or a Table to store maximum current ID, determined by jDialects, to get next auto generated ID value, need run dialect.getNextAutoID(connection) method

tail
```
public Column tail(String tail)
```
Put an extra tail String manually at the end of column definition DDL

LONG
```
public Column LONG()
```

BOOLEAN
```
public Column BOOLEAN()
```

DOUBLE
```
public Column DOUBLE()
```

FLOAT

public Column FLOAT(Integer... lengths)

INTEGER
```
public Column INTEGER()
```

SHORT
```
public Column SHORT()
```

BIGDECIMAL

public Column BIGDECIMAL(Integer precision,
                Integer scale)

STRING
```
public Column STRING(Integer length)
```

DATE
```
public Column DATE()
```

TIME
```
public Column TIME()
```

TIMESTAMP
```
public Column TIMESTAMP()
```

BIGINT
```
public Column BIGINT()
```

BINARY

public Column BINARY(Integer... lengths)

BIT
```
public Column BIT()
```

BLOB

public Column BLOB(Integer... lengths)

CHAR

public Column CHAR(Integer... lengths)

CLOB

public Column CLOB(Integer... lengths)

DECIMAL

public Column DECIMAL(Integer... lengths)

JAVA_OBJECT
```
public Column JAVA_OBJECT()
```

LONGNVARCHAR

public Column LONGNVARCHAR(Integer length)

LONGVARBINARY

public Column LONGVARBINARY(Integer... lengths)

LONGVARCHAR

public Column LONGVARCHAR(Integer... lengths)

NCHAR
```
public Column NCHAR(Integer length)
```

NCLOB
```
public Column NCLOB()
```

NUMERIC

public Column NUMERIC(Integer... lengths)

NVARCHAR

public Column NVARCHAR(Integer length)

OTHER

public Column OTHER(Integer... lengths)

REAL
```
public Column REAL()
```

SMALLINT
```
public Column SMALLINT()
```

TINYINT
```
public Column TINYINT()
```

VARBINARY

public Column VARBINARY(Integer... lengths)

VARCHAR

public Column VARCHAR(Integer length)

getColumnName
```
public String getColumnName()
```

setColumnName

public void setColumnName(String columnName)

getColumnType
```
public Type getColumnType()
```

setColumnType

public void setColumnType(Type columnType)

getPkey
```
public Boolean getPkey()
```

setPkey
```
public void setPkey(Boolean pkey)
```

getNotNull
```
public Boolean getNotNull()
```

setNotNull

public void setNotNull(Boolean notNull)

getUnique
```
public Boolean getUnique()
```

setUnique

public void setUnique(Boolean unique)

getUniqueConstraintName

public String getUniqueConstraintName()

setUniqueConstraintName

public void setUniqueConstraintName(String uniqueConstraintName)

getIdentity
```
public Boolean getIdentity()
```

setIdentity

public void setIdentity(Boolean identity)

getPkeyName
```
public String getPkeyName()
```

setPkeyName

public void setPkeyName(String pkeyName)

getDefaultValue
```
public String getDefaultValue()
```

setDefaultValue

public void setDefaultValue(String defaultValue)

getComment
```
public String getComment()
```

setComment

public void setComment(String comment)

getLengths
```
public Integer[] getLengths()
```

setLengths

public void setLengths(Integer[] lengths)

getCheck
```
public String getCheck()
```

setCheck
```
public void setCheck(String check)
```

getSequence
```
public String getSequence()
```

setSequence

public void setSequence(String sequence)

getTableGenerator
```
public String getTableGenerator()
```

setTableGenerator

public void setTableGenerator(String tableGenerator)

getAutoGenerator
```
public Boolean getAutoGenerator()
```

setAutoGenerator

public void setAutoGenerator(Boolean autoGenerator)

getFkeyReferenceTable
```
public String getFkeyReferenceTable()
```

setFkeyReferenceTable

public void setFkeyReferenceTable(String fkeyReferenceTable)

getFkeyReferenceColumns

public String[] getFkeyReferenceColumns()

setFkeyReferenceColumns

public void setFkeyReferenceColumns(String[] fkeyReferenceColumns)

getIndex
```
public Boolean getIndex()
```

setIndex
```
public void setIndex(Boolean index)
```

getTail
```
public String getTail()
```

setTail
```
public void setTail(String tail)
```

getIndexNames
```
public String[] getIndexNames()
```

setIndexName

public void setIndexName(String[] indexNames)

Class Column

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Column

Method Detail

notNull

unique

unique

check

index

index

identity

defaultValue

comment

pkey

pkey

fkey

sequence

tableGenerator

autoID

tail

LONG

BOOLEAN

DOUBLE

FLOAT

INTEGER

SHORT

BIGDECIMAL

STRING

DATE

TIME

TIMESTAMP

BIGINT

BINARY

BIT

BLOB

CHAR

CLOB

DECIMAL

JAVA_OBJECT

LONGNVARCHAR

LONGVARBINARY

LONGVARCHAR

NCHAR

NCLOB

NUMERIC

NVARCHAR

OTHER

REAL

SMALLINT

TINYINT

VARBINARY

VARCHAR

getColumnName

setColumnName

getColumnType

setColumnType

getPkey

setPkey

getNotNull

setNotNull

getUnique

setUnique

getUniqueConstraintName

setUniqueConstraintName

getIdentity

setIdentity

getPkeyName

setPkeyName

getDefaultValue

setDefaultValue

getComment

setComment

getLengths

setLengths

getCheck

setCheck

getSequence