org.dbunit.dataset

Class Column

java.lang.Object

org.dbunit.dataset.Column

public class Column
extends Object

Represents a table column.

Since:

1.0 (Feb 17, 2002)

Version:

$Revision$ $Date$

Author:

Manuel Laflamme, Last changed by: $Author$

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Column.AutoIncrement Enumeration for valid auto-increment values provided by JDBC driver implementations.
static class	Column.Nullable Specifies nullable usage.

Field Summary

Fields

Modifier and Type	Field and Description
static Column.Nullable	NO_NULLS Indicates that the column might not allow NULL values.
static Column.Nullable	NULLABLE Indicates that the column definitely allows NULL values.
static Column.Nullable	NULLABLE_UNKNOWN Indicates that the nullability of columns is unknown.

Constructor Summary

Constructors

Constructor and Description
Column(String columnName, DataType dataType) Creates a Column object.
Column(String columnName, DataType dataType, Column.Nullable nullable) Creates a Column object.
Column(String columnName, DataType dataType, String sqlTypeName, Column.Nullable nullable) Creates a Column object.
Column(String columnName, DataType dataType, String sqlTypeName, Column.Nullable nullable, String defaultValue) Creates a Column object.
Column(String columnName, DataType dataType, String sqlTypeName, Column.Nullable nullable, String defaultValue, String remarks, Column.AutoIncrement autoIncrement) Creates a Column object.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object o)
Column.AutoIncrement	getAutoIncrement()
String	getColumnName() Returns this column name.
DataType	getDataType() Returns this column data type.
String	getDefaultValue()
Column.Nullable	getNullable() Returns true if this column is nullable.
String	getRemarks()
String	getSqlTypeName() Returns this column sql data type name.
boolean	hasDefaultValue()
int	hashCode()
boolean	isNotNullable()
static Column.Nullable	nullableValue(boolean nullable) Returns the appropriate Nullable constant.
static Column.Nullable	nullableValue(int nullable) Returns the appropriate Nullable constant according specified JDBC DatabaseMetaData constant.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

NO_NULLS

public static final Column.Nullable NO_NULLS

Indicates that the column might not allow NULL values.

NULLABLE

public static final Column.Nullable NULLABLE

Indicates that the column definitely allows NULL values.

NULLABLE_UNKNOWN

public static final Column.Nullable NULLABLE_UNKNOWN

Indicates that the nullability of columns is unknown.

Constructor Detail

Column

public Column(String columnName,
      DataType dataType)

Creates a Column object. This constructor set nullable to true.

Parameters:

columnName - the column name

dataType - the data type

Column

public Column(String columnName,
      DataType dataType,
      Column.Nullable nullable)

Creates a Column object.

Column

public Column(String columnName,
      DataType dataType,
      String sqlTypeName,
      Column.Nullable nullable)

Creates a Column object.

Column

public Column(String columnName,
      DataType dataType,
      String sqlTypeName,
      Column.Nullable nullable,
      String defaultValue)

Creates a Column object.

Parameters:

columnName - The name of the column

dataType - The DbUnit DataType of the column

sqlTypeName - The SQL name of the column which comes from the JDBC driver. See value 'TYPE_NAME' in DatabaseMetaData.getColumns(String, String, String, String)

nullable - whether or not the column is nullable

defaultValue - The default value on the DB for this column. Can be null.

Column

public Column(String columnName,
      DataType dataType,
      String sqlTypeName,
      Column.Nullable nullable,
      String defaultValue,
      String remarks,
      Column.AutoIncrement autoIncrement)

Creates a Column object.

Parameters:

columnName - The name of the column

dataType - The DbUnit DataType of the column

sqlTypeName - The SQL name of the column which comes from the JDBC driver. See value 'TYPE_NAME' in DatabaseMetaData.getColumns(String, String, String, String)

nullable - whether or not the column is nullable

defaultValue - The default value on the DB for this column. Can be null.

remarks - The remarks on the DB for this column. Can be null.

autoIncrement - The auto increment setting for this column. Can be null.

Method Detail

hasDefaultValue

public boolean hasDefaultValue()

isNotNullable

public boolean isNotNullable()

getColumnName

public String getColumnName()

Returns this column name.

getDataType

public DataType getDataType()

Returns this column data type.

getSqlTypeName

public String getSqlTypeName()

Returns this column sql data type name.

getNullable

public Column.Nullable getNullable()

Returns true if this column is nullable.

getDefaultValue

public String getDefaultValue()

Returns:

The default value the database uses for this column if not specified in the insert column list

getRemarks

public String getRemarks()

Returns:

The remarks set on the database for this column

Since:

2.4.3

getAutoIncrement

public Column.AutoIncrement getAutoIncrement()

Returns:

The auto-increment property for this column

Since:

2.4.3

nullableValue

public static Column.Nullable nullableValue(int nullable)

Returns the appropriate Nullable constant according specified JDBC DatabaseMetaData constant.

Parameters:

nullable - one of the following constants DatabaseMetaData.columnNoNulls, DatabaseMetaData.columnNullable, DatabaseMetaData.columnNullableUnknown

nullableValue

public static Column.Nullable nullableValue(boolean nullable)

Returns the appropriate Nullable constant.

Parameters:

nullable - true if null is allowed

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object