org.josef.jpa

Class CColumn

java.lang.Object

org.josef.jpa.CColumn

@Status(stage=DEVELOPMENT,
        unitTests=COMPLETE)
 @Review(by="Kees Schotanus",at="2009-09-28") @Review(by="Kees Schotanus",at="2009-10-09",reason="After making CColumn immutable") @Review(by="Kees Schotanus",at="2010-08-31",reason="After applying the Builder pattern")
public final class CColumn
extends Object

Abstraction of a Column of a JPA Entity.
Note: A CColumn either stores a (length) or (a precision and a scale).

Version:

1.0 $Revision: 6488 $

Author:

Kees Schotanus

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CColumn.Builder Builder class to build a CColumn.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object object) Determines whether this CColumn is equal to the supplied object.
Method	getGetMethod() Gets the getter that will get this Column's value.
int	getLength() Gets the length of this CColumn.
String	getName() Gets the name of this CColumn.
int	getPrecision() Gets the precision of this CColumn.
int	getScale() Gets the scale of this CColumn.
int	hashCode() Computes the hash code of this OrderByClause.
boolean	isNullable() Determines whether this CColumn is nullable (true) or not (false).
boolean	isUnique() Determines whether this CColumn is unique (true) or not (false).
String	toString() Creates a String representation of this CColumn.

Methods inherited from class java.lang.Object

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

Method Detail

getName

public String getName()

Gets the name of this CColumn.

Returns:

The name of this CColumn.

getGetMethod

public Method getGetMethod()

Gets the getter that will get this Column's value.

Returns:

The getter that will get this Column's value.

getLength

public int getLength()

Gets the length of this CColumn.
Only valid for String type columns for which the length has been set.

Returns:

The length of this CColumn.

Throws:

UnsupportedOperationException - When the length has not been set.

getScale

public int getScale()

Gets the scale of this CColumn.
Only valid for numeric type columns for which the scale has been set.

Returns:

The scale of this CColumn.

Throws:

UnsupportedOperationException - When the scale has not been set.

getPrecision

public int getPrecision()

Gets the precision of this CColumn.
Only valid for numeric type columns for which the precision has been set.

Returns:

The precision of this CColumn.

Throws:

UnsupportedOperationException - When the precision has not been set.

isNullable

public boolean isNullable()

Determines whether this CColumn is nullable (true) or not (false).

Returns:

True when this CColumn is nullable, otherwise false is returned.

isUnique

public boolean isUnique()

Determines whether this CColumn is unique (true) or not (false).

Returns:

True when this CColumn is unique, otherwise false is returned.

equals

public boolean equals(Object object)

Determines whether this CColumn is equal to the supplied object.
Both CColumns are equal when all of the following conditions are met:

• The supplied object is of type CColumn
• All fields are equal when compared to each other.

Overrides:

equals in class Object

Parameters:

object - The object to compare to.

Returns:

True when this CColumn is equal to the supplied object.

hashCode

public int hashCode()

Computes the hash code of this OrderByClause.

Overrides:

hashCode in class Object

Returns:

Hash code of this OrderByClause.

toString

public String toString()

Creates a String representation of this CColumn.

Overrides:

toString in class Object

Returns:

A String representation of this CColumn.