Column

java.lang.Object
- org.kepler.util.sql.Column

```
public class Column
extends java.lang.Object
```
A generic representation of an SQL column.

Author:

Daniel Crawl

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Column.Type
Data types.

Nested Classes
Modifier and Type	Class and Description
`static class`	`Column.Type` Data types.

Field Summary

Fields
Modifier and Type	Field and Description
`static Column`	`AUTOINCID` An auto-incrementing integer column.
`static Column`	`BLOB` A BLOB column.
`static Column`	`BOOLEAN` A boolean column.
`static Column`	`INTEGER` An integer column.
`static Column`	`MD5_BINARY` An MD5 binary column.
`static Column`	`MD5_TEXT` An MD5 text column.
`static Column`	`NULLABLE_INTEGER` An integer column that can be null.
`static Column`	`NULLABLE_MD5_TEXT` An MD5 text column that can be null.
`static Column`	`NULLABLE_TEXT` A text column that can be null.
`static Column`	`PK_INTEGER` A primary key integer column.
`static Column`	`PK_MD5_BINARY`
`static Column`	`PK_MD5_TEXT` A primary key MD5 text column.
`static Column`	`PK_TEXT` A primary key text column.
`static Column`	`PK_UUID_TEXT` A column for text UUIDs that are primary keys.
`static Column`	`TEXT` A text column.
`static Column`	`TEXT_UNLIMITED` A text column with no maximum length.
`static Column`	`TIMESTAMP` A timestamp column.
`static Column`	`UUID_TEXT` A column for text UUIDs.

Constructor Summary

Constructors
Constructor and Description
`Column(Column.Type type)` Construct a Column with a type.
`Column(Column.Type type, boolean autoIncrement)` Construct a Column with a type and specify auto-increment.
`Column(Column.Type type, boolean autoIncrement, boolean primary)` Construct a Column with a type and specify auto-increment and primary key.
`Column(Column.Type type, boolean autoIncrement, boolean primary, boolean nullAllowed)` Construct a Column with a type and specify auto-increment, primary key, and if null values are allowed.
`Column(Column.Type type, int length)` Construct a Column with a type and type length.
`Column(Column.Type type, int length, boolean nullAllowed)` Construct a Column with a type and type length, and specifying if can be null.
`Column(Column.Type type, int length, boolean nullAllowed, boolean primary)` Construct a Column with a type and type length, and specifying if can be null or a primary key.
`Column(Column.Type type, java.lang.String defaultValue)` Construct a Column with a type and a default value.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`getDefaultValue()` Get the default value.
`int`	`getLength()` Get the length of the column's type.
`java.lang.String`	`getName()` Get the name.
`Table`	`getTable()` Get the containing table.
`Column.Type`	`getType()` Get the data type.
`boolean`	`isAutoIncrement()` Returns true if column value is auto-incremented.
`boolean`	`isNullAllowed()` Returns true if column can have null values.
`boolean`	`isPrimaryKey()` Returns true if column is primary key.
`void`	`setName(java.lang.String name)` Set the name.
`java.lang.String`	`toString()` Get a string representation of the column.

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

- Field Detail
  - AUTOINCID
```
public static final Column AUTOINCID
```
    An auto-incrementing integer column.
  - BOOLEAN
```
public static final Column BOOLEAN
```
    A boolean column.
  - BLOB
```
public static final Column BLOB
```
    A BLOB column.
  - INTEGER
```
public static final Column INTEGER
```
    An integer column.
  - MD5_TEXT
```
public static final Column MD5_TEXT
```
    An MD5 text column.
  - MD5_BINARY
```
public static final Column MD5_BINARY
```
    An MD5 binary column.
  - NULLABLE_INTEGER
```
public static final Column NULLABLE_INTEGER
```
    An integer column that can be null.
  - NULLABLE_MD5_TEXT
```
public static final Column NULLABLE_MD5_TEXT
```
    An MD5 text column that can be null.
  - NULLABLE_TEXT
```
public static final Column NULLABLE_TEXT
```
    A text column that can be null. Maximum length is 255 characters.
  - PK_INTEGER
```
public static final Column PK_INTEGER
```
    A primary key integer column.
  - PK_MD5_TEXT
```
public static final Column PK_MD5_TEXT
```
    A primary key MD5 text column.
  - PK_MD5_BINARY
```
public static final Column PK_MD5_BINARY
```
  - PK_TEXT
```
public static final Column PK_TEXT
```
    A primary key text column. Maximum length is 255 characters.
  - TEXT
```
public static final Column TEXT
```
    A text column. Maximum length is 255 characters.
  - TEXT_UNLIMITED
```
public static final Column TEXT_UNLIMITED
```
    A text column with no maximum length.
  - TIMESTAMP
```
public static final Column TIMESTAMP
```
    A timestamp column.
  - PK_UUID_TEXT
```
public static final Column PK_UUID_TEXT
```
    A column for text UUIDs that are primary keys.
  - UUID_TEXT
```
public static final Column UUID_TEXT
```
    A column for text UUIDs.
- Constructor Detail
  - Column
```
public Column(Column.Type type)
```
    Construct a Column with a type.
  - Column
```
public Column(Column.Type type,
              boolean autoIncrement)
```
    Construct a Column with a type and specify auto-increment.
  - Column
```
public Column(Column.Type type,
              boolean autoIncrement,
              boolean primary)
```
    Construct a Column with a type and specify auto-increment and primary key.
  - Column
```
public Column(Column.Type type,
              boolean autoIncrement,
              boolean primary,
              boolean nullAllowed)
```
    Construct a Column with a type and specify auto-increment, primary key, and if null values are allowed.
  - Column
```
public Column(Column.Type type,
              int length)
```
    Construct a Column with a type and type length.
  - Column
```
public Column(Column.Type type,
              int length,
              boolean nullAllowed)
```
    Construct a Column with a type and type length, and specifying if can be null.
  - Column
```
public Column(Column.Type type,
              int length,
              boolean nullAllowed,
              boolean primary)
```
    Construct a Column with a type and type length, and specifying if can be null or a primary key.
  - Column
```
public Column(Column.Type type,
              java.lang.String defaultValue)
```
    Construct a Column with a type and a default value.
- Method Detail
  - getDefaultValue
```
public java.lang.String getDefaultValue()
```
    Get the default value. Returns null if none exists.
  - getLength
```
public int getLength()
```
    Get the length of the column's type. Returns -1 if not specified.
  - getName
```
public java.lang.String getName()
```
    Get the name. If the column has not been added to a table, returns null.
  - getTable
```
public Table getTable()
```
    Get the containing table. If the column has not been added to a, then return null.
  - getType
```
public Column.Type getType()
```
    Get the data type.
  - isAutoIncrement
```
public boolean isAutoIncrement()
```
    Returns true if column value is auto-incremented.
  - isNullAllowed
```
public boolean isNullAllowed()
```
    Returns true if column can have null values.
  - isPrimaryKey
```
public boolean isPrimaryKey()
```
    Returns true if column is primary key.
  - setName
```
public void setName(java.lang.String name)
```
    Set the name.
  - toString
```
public java.lang.String toString()
```
    Get a string representation of the column.
    
    Overrides:
    
    toString in class java.lang.Object

Class Column

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

AUTOINCID

BOOLEAN

BLOB

INTEGER

MD5_TEXT

MD5_BINARY

NULLABLE_INTEGER

NULLABLE_MD5_TEXT

NULLABLE_TEXT

PK_INTEGER

PK_MD5_TEXT

PK_MD5_BINARY

PK_TEXT

TEXT

TEXT_UNLIMITED

TIMESTAMP

PK_UUID_TEXT

UUID_TEXT

Constructor Detail

Column

Column

Column

Column

Column

Column

Column

Column

Method Detail

getDefaultValue

getLength

getName

getTable

getType

isAutoIncrement

isNullAllowed

isPrimaryKey

setName

toString