org.josef.jdbc

Class Column

java.lang.Object

org.josef.jdbc.Column

public class Column
extends Object

Abstraction of a column of a database table.
A column is normally created from ResultSetMetaData so check out this class for details.
Note: This class does not protect you from creating illegal columns. For example a column with a width and a scale and a precision. Or a column with a negative width for example.

Version:

1.0 $Revision: 6488 $

Author:

Kees Schotanus

Constructor Summary

Constructors

Constructor and Description
Column(String name) Constructs a Column with the supplied name.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object object) Determines whether this Column is equal to the supplied object.
String	getClassName() Gets the Java class name used for this column.
String	getName() Gets the name of this Column.
Integer	getPrecision() For a numeric Column, this method gets the precision.
Integer	getScale() For a numeric Column, this method gets the scale.
int	getType() Gets the JDBC type of this Column.
String	getTypeName() Gets the JDBC type of this Column.
Integer	getWidth() Gets the maximum width (in characters) for this Column.
int	hashCode() Computes the hash code for this Column.
boolean	isNullable() Determines if this column is nullable or not.
void	setClassName(String className) Gets the Java class name used for this column.
void	setNullable(boolean nullable) Sets this column to nullable or not nullable.
void	setPrecision(Integer precision) For a numeric Column, this method sets the precision.
void	setScale(Integer scale) For a numeric Column, this method sets the scale.
void	setType(int type) Sets the JDBC type for this Column.
void	setTypeName(String typeName) Sets the JDBC type name for this Column.
void	setWidth(Integer width) Sets the maximum width (in characters) for this Column.
String	toString() Creates a String representation of this Column.

Methods inherited from class java.lang.Object

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

Constructor Detail

Column

public Column(String name)

Constructs a Column with the supplied name.

Parameters:

name - Column's name.

Throws:

IllegalArgumentException - When the supplied name is empty.

NullPointerException - When the supplied name is null.

Method Detail

getName

public String getName()

Gets the name of this Column.

Returns:

The name of this Column.

getClassName

public String getClassName()

Gets the Java class name used for this column.

Returns:

The Java class name used for this column.

setClassName

public void setClassName(String className)

Gets the Java class name used for this column.

Parameters:

className - The Java class name used for this column.

Throws:

IllegalArgumentException - When the supplied name is empty.

NullPointerException - When the supplied name is null.

getType

public int getType()

Gets the JDBC type of this Column.

Returns:

The JDBC type of this Column.

setType

public void setType(int type)

Sets the JDBC type for this Column.
This method does not whether the supplied type is a legal type or not.

Parameters:

type - The JDBC type for this Column.

getTypeName

public String getTypeName()

Gets the JDBC type of this Column.

Returns:

The JDBC type of this Column.

setTypeName

public void setTypeName(String typeName)

Sets the JDBC type name for this Column.

Parameters:

typeName - The JDBC type name for this Column.

Throws:

IllegalArgumentException - When the supplied typeName is empty.

NullPointerException - When the supplied className is null.

getWidth

public Integer getWidth()

Gets the maximum width (in characters) for this Column.

Returns:

The maximum width (in characters) for this Column.

setWidth

public void setWidth(Integer width)

Sets the maximum width (in characters) for this Column.
This method does not check whether a valid width is supplied or not.

Parameters:

width - The maximum width this Column occupies.

getPrecision

public Integer getPrecision()

For a numeric Column, this method gets the precision.

Returns:

The precision of this Column.

setPrecision

public void setPrecision(Integer precision)

For a numeric Column, this method sets the precision.
This method does not check whether a valid precision is supplied or not.

Parameters:

precision - The precision for this Column.

getScale

public Integer getScale()

For a numeric Column, this method gets the scale.

Returns:

The scale of this Column.

setScale

public void setScale(Integer scale)

For a numeric Column, this method sets the scale.
This method does not check whether a valid scale is supplied or not.

Parameters:

scale - The scale for this Column.

isNullable

public boolean isNullable()

Determines if this column is nullable or not.

Returns:

True when nullable, otherwise false is returned.

setNullable

public void setNullable(boolean nullable)

Sets this column to nullable or not nullable.

Parameters:

nullable - True when nullable, otherwise false.

equals

public boolean equals(Object object)

Determines whether this Column is equal to the supplied object.
Both columns are equal when:

• The supplied object is of type Column
• The names in both objects are the same

Overrides:

equals in class Object

Parameters:

object - The object to compare to.
Objects not of type Column will never be equal.

Returns:

True when both objects are equal, false otherwise.

hashCode

public int hashCode()

Computes the hash code for this Column.
The hash code is equal to the hash code of the Column's name.

Overrides:

hashCode in class Object

Returns:

Hash code of this Column.

toString

public String toString()

Creates a String representation of this Column.

Overrides:

toString in class Object

Returns:

String representation of this Column.