ColumnMetaData (Tentackle SQL 2.0.4 API)

java.lang.Object
- org.tentackle.sql.metadata.ColumnMetaData

All Implemented Interfaces:

Cloneable

Direct Known Subclasses:

MySqlColumnMetaData, PostgresColumnMetaData
```
public class ColumnMetaData
extends Object
implements Cloneable
```
Meta data for a column

Author:

harald

Field Summary

Fields
Modifier and Type	Field and Description
`protected boolean`	`autoIncrement`
`protected String`	`columnName`
`protected String`	`comment`
`protected String`	`defaultValue`
`protected boolean`	`generated`
`protected boolean`	`nullable`
`protected int`	`scale`
`protected int`	`size`
`protected TableMetaData`	`tableMetaData`
`protected int`	`type`
`protected String`	`typeName`

Constructor Summary

Constructors
Constructor and Description

ColumnMetaData(TableMetaData tableMetaData)
Creates column meta data.

Constructors
Constructor and Description
`ColumnMetaData(TableMetaData tableMetaData)` Creates column meta data.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getColumnName()` Gets the columnName of the column.
`String`	`getComment()` Gets the comment.
`String`	`getDefaultValue()` Gets the column's default.
`int`	`getScale()` Gets the numeric scale.
`int`	`getSize()` Gets the column's size.
`TableMetaData`	`getTableMetaData()` Gets the table meta data.
`int`	`getType()` Gets the column's type.
`String`	`getTypeName()` Gets the backend-specific type columnName.
`boolean`	`isAutoIncrement()` Returns whether column is auto-incremented by the backend.
`boolean`	`isGenerated()` Returns whether column is generated by the backend.
`boolean`	`isNullable()` Returns whether column is nullable.
`boolean`	`matchesSqlType(SqlType sqlType)` Checks whether colunm's type matches given SqlType according to the backend.
`void`	`setupColumnFromMetaData(ResultSet resultSet)` Sets up the column from the database meta data result.
`String`	`toString()`
`void`	`validate()` Validates and postprocesses the column data.

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

- Field Detail
  - tableMetaData
```
protected final TableMetaData tableMetaData
```
  - columnName
```
protected String columnName
```
  - comment
```
protected String comment
```
  - type
```
protected int type
```
  - typeName
```
protected String typeName
```
  - size
```
protected int size
```
  - scale
```
protected int scale
```
  - defaultValue
```
protected String defaultValue
```
  - nullable
```
protected boolean nullable
```
  - generated
```
protected boolean generated
```
  - autoIncrement
```
protected boolean autoIncrement
```
- Constructor Detail
  - ColumnMetaData
```
public ColumnMetaData(TableMetaData tableMetaData)
```
    Creates column meta data.
    
    Parameters:
    
    tableMetaData - the table meta data this column belongs to
- Method Detail
  - getTableMetaData
```
public TableMetaData getTableMetaData()
```
    Gets the table meta data.
    
    Returns:
    
    the table this column belongs to
  - setupColumnFromMetaData
```
public void setupColumnFromMetaData(ResultSet resultSet)
                             throws SQLException
```
    Sets up the column from the database meta data result.
    
    Parameters:
    
    resultSet - the column result set
    
    Throws:
    
    SQLException - the processing the result set failed
  - getColumnName
```
public String getColumnName()
```
    Gets the columnName of the column.
    
    Returns:
    
    the columnName (always in lowercase)
  - getComment
```
public String getComment()
```
    Gets the comment.
    
    Returns:
    
    the comment, null if none
  - getType
```
public int getType()
```
    Gets the column's type.
    
    Returns:
    
    the type
    
    See Also:
    
    Types
  - getTypeName
```
public String getTypeName()
```
    Gets the backend-specific type columnName.
    
    Returns:
    
    the type columnName
  - getSize
```
public int getSize()
```
    Gets the column's size.
    
    Returns:
    
    the size
  - getScale
```
public int getScale()
```
    Gets the numeric scale.
    
    Returns:
    
    the scale
  - getDefaultValue
```
public String getDefaultValue()
```
    Gets the column's default.
    
    Returns:
    
    the defaultValue
  - isNullable
```
public boolean isNullable()
```
    Returns whether column is nullable.
    
    Returns:
    
    true if nullable
  - isGenerated
```
public boolean isGenerated()
```
    Returns whether column is generated by the backend.
    
    Returns:
    
    true if generated
  - isAutoIncrement
```
public boolean isAutoIncrement()
```
    Returns whether column is auto-incremented by the backend.
    
    Returns:
    
    true if autoincremented
  - matchesSqlType
```
public boolean matchesSqlType(SqlType sqlType)
```
    Checks whether colunm's type matches given SqlType according to the backend.
    
    Parameters:
    
    sqlType - the sqltype
    
    Returns:
    
    true if matches
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - validate
```
public void validate()
```
    Validates and postprocesses the column data.

Class ColumnMetaData

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

tableMetaData

columnName

comment

type

typeName

size

scale

defaultValue

nullable

generated

autoIncrement

Constructor Detail

ColumnMetaData

Method Detail

getTableMetaData

setupColumnFromMetaData

getColumnName

getComment

getType

getTypeName

getSize

getScale

getDefaultValue

isNullable

isGenerated

isAutoIncrement

matchesSqlType

toString

validate