org.melati.poem

Class BasePoemType<T>

java.lang.Object

org.melati.poem.BasePoemType<T>

All Implemented Interfaces:

Cloneable, PoemType<T>, SQLPoemType<T>, SQLType<T>

Direct Known Subclasses:

AtomPoemType

public abstract class BasePoemType<T>
extends Object
implements SQLPoemType<T>, Cloneable

Base class of all fundamental types.

Method Summary

Modifier and Type	Method and Description
void	assertValidCooked(Object cooked) Check if an Object is valid, throw appropriate Exception if not.
void	assertValidRaw(Object raw) Check if value is of the right type and an allowed value, throw appropriate Exception if not.
<O> PoemType<O>	canRepresent(PoemType<O> other) Return a PoemType which can can represent another, or null.
Object	cookedOfRaw(Object raw) Converts a possibly null low-level representation of a database column value to its canonical form.
boolean	getNullable() Whether the type is nullable.
T	getRaw(ResultSet rs, int col) Return an object as delivered by the database.
Enumeration<T>	possibleRaws() Get the possible values for this field, null for rangeable types with no range set.
String	quotedRaw(Object raw) Quoting a raw value, if appropriate, for the Dbms.
T	rawOfCooked(Object cooked) Return the Object value, a no-op for all but ReferencePoemTypes, for which it returns the troid as an Integer.
T	rawOfString(String string) Converts a possibly null String to a low level representation of a valid database column value.
void	saveColumnInfo(ColumnInfo info) Set the type of the ColumnInfo.
void	setRaw(PreparedStatement ps, int col, Object raw) Set a column of a PreparedStatement to the passed in value.
void	setRawRange(Comparable<T> low, Comparable<T> limit) Set the limits, if applicable.
String	sqlDefinition(Dbms dbms) See http://dev.mysql.com/doc/refman/5.0/en/timestamp.html The MySQL default for nullability of timestamps is not null, so need to make all fields explicitly nullable.
int	sqlTypeCode()
String	sqlTypeDefinition(Dbms dbms) SQL type definition without nullability.
String	stringOfCooked(Object cooked, PoemLocale locale, int style) A localised String representation of the oject.
String	stringOfRaw(Object raw) This doesn't do an explicit assertValidRaw.
String	toString()
PoemType<T>	withNullable(boolean nullableP) Get a new type with a nullablity, presumably different.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.melati.poem.SQLType

sqlDefaultValue

Methods inherited from interface org.melati.poem.PoemType

toDsdType

Method Detail

setRawRange

public void setRawRange(Comparable<T> low,
                        Comparable<T> limit)

Set the limits, if applicable.

Parameters:

low - included lower limit

limit - excluded upper limit

assertValidRaw

public final void assertValidRaw(Object raw)
                          throws ValidationPoemException

Check if value is of the right type and an allowed value, throw appropriate Exception if not.

Specified by:

assertValidRaw in interface PoemType<T>

Parameters:

raw - the raw value to check

Throws:

ValidationPoemException - if the raw has an illegal value

See Also:

PoemType.assertValidRaw(java.lang.Object)

getRaw

public final T getRaw(ResultSet rs,
                      int col)
               throws ValidationPoemException

Return an object as delivered by the database.

Specified by:

getRaw in interface SQLType<T>

Parameters:

rs - the Resultset containing the value

col - the column withing the ResultSet to read

Returns:

the value as an Object

Throws:

ValidationPoemException

See Also:

SQLType.getRaw(java.sql.ResultSet, int)

setRaw

public final void setRaw(PreparedStatement ps,
                         int col,
                         Object raw)

Set a column of a PreparedStatement to the passed in value.

Specified by:

setRaw in interface SQLType<T>

Parameters:

ps - the Prepared Statement to modify

col - the column within the PreparedStatement

raw - the value to set

See Also:

SQLType.setRaw(java.sql.PreparedStatement, int, java.lang.Object)

possibleRaws

public Enumeration<T> possibleRaws()

Get the possible values for this field, null for rangeable types with no range set. NOTE Null is a possible value for nullable types

Specified by:

possibleRaws in interface PoemType<T>

Returns:

an Enumeration of possibilities or null

See Also:

PoemType.possibleRaws()

stringOfRaw

public final String stringOfRaw(Object raw)
                         throws ValidationPoemException

This doesn't do an explicit assertValidRaw. The String representation of the Field.

Specified by:

stringOfRaw in interface PoemType<T>

Parameters:

raw - the value

Returns:

a String representation

Throws:

ValidationPoemException - if the raw has an illegal value

See Also:

PoemType.stringOfRaw(java.lang.Object)

rawOfString

public final T rawOfString(String string)
                    throws ParsingPoemException,
                           ValidationPoemException

Converts a possibly null String to a low level representation of a valid database column value.

Null values are not changed.

This result is validated with assertValidRaw(Object) whereas stringOfRaw(Object) assumes this is not required. Get an Object from its String representation.

Specified by:

rawOfString in interface PoemType<T>

Parameters:

string - the String representation to convert

Returns:

an Object of the correct type

Throws:

ParsingPoemException - if the String representation is not well formed

ValidationPoemException - if the raw has an illegal value

See Also:

PoemType.rawOfString(java.lang.String)

assertValidCooked

public final void assertValidCooked(Object cooked)
                             throws ValidationPoemException

Check if an Object is valid, throw appropriate Exception if not.

Specified by:

assertValidCooked in interface PoemType<T>

Parameters:

cooked - the Object to check

Throws:

ValidationPoemException - if the raw has an illegal value

See Also:

PoemType.assertValidCooked(java.lang.Object)

cookedOfRaw

public final Object cookedOfRaw(Object raw)
                         throws PoemException

Converts a possibly null low-level representation of a database column value to its canonical form. Types represented as integers in the database are converted to corresponding objects .

The raw value is checked to ensure it is valid. Create an Object from a raw Object, a no-op for all but ReferencePoemTypes.

Specified by:

cookedOfRaw in interface PoemType<T>

Parameters:

raw - the object, typically a troid

Returns:

the Persistent or the raw unchanged

Throws:

TypeMismatchPoemException - if the raw is of the wrong type

PoemException - if there is another problem, such as no object with that troid

See Also:

PoemType.cookedOfRaw(java.lang.Object)

rawOfCooked

public final T rawOfCooked(Object cooked)

Return the Object value, a no-op for all but ReferencePoemTypes, for which it returns the troid as an Integer.

Specified by:

rawOfCooked in interface PoemType<T>

Parameters:

cooked - the Persistent or Object

Returns:

a Persistent's troid or the raw unchanged

See Also:

PoemType.rawOfCooked(java.lang.Object)

stringOfCooked

public final String stringOfCooked(Object cooked,
                                   PoemLocale locale,
                                   int style)
                            throws PoemException

A localised String representation of the oject.

Specified by:

stringOfCooked in interface PoemType<T>

Parameters:

cooked - the PoemType to be stringified

locale - to be used for dates

style - as in java.text.DateFormat.SHORT, ...

Returns:

a String representation of an Object

Throws:

TypeMismatchPoemException - if the raw is of the wrong type

PoemException - if there is an access violation

See Also:

PoemType.stringOfCooked(java.lang.Object, org.melati.poem.PoemLocale, int)

getNullable

public final boolean getNullable()

Whether the type is nullable.

Specified by:

getNullable in interface PoemType<T>

Returns:

the type's nullability

See Also:

PoemType.getNullable()

sqlTypeCode

public final int sqlTypeCode()

Specified by:

sqlTypeCode in interface SQLType<T>

Returns:

The SQL92 ANSI code for this type.

See Also:

SQLType.sqlTypeCode()

sqlDefinition

public String sqlDefinition(Dbms dbms)

See http://dev.mysql.com/doc/refman/5.0/en/timestamp.html The MySQL default for nullability of timestamps is not null, so need to make all fields explicitly nullable. SQL type definition with nullability. eg: STRING NOT NULL

Specified by:

sqlDefinition in interface SQLType<T>

Parameters:

dbms - the DBMS

Returns:

the DBMS specific SQL snippet

See Also:

SQLType.sqlDefinition(org.melati.poem.dbms.Dbms)

sqlTypeDefinition

public String sqlTypeDefinition(Dbms dbms)

SQL type definition without nullability. eg: STRING

Specified by:

sqlTypeDefinition in interface SQLType<T>

Parameters:

dbms - the DBMS

Returns:

the DBMS specific SQL snippet

See Also:

SQLType.sqlTypeDefinition(org.melati.poem.dbms.Dbms)

canRepresent

public <O> PoemType<O> canRepresent(PoemType<O> other)

Return a PoemType which can can represent another, or null.

Specified by:

canRepresent in interface PoemType<T>

Type Parameters:

O - the type of the PoemType

Parameters:

other - the other type to check

Returns:

other or null

See Also:

PoemType.canRepresent(org.melati.poem.PoemType)

withNullable

public final PoemType<T> withNullable(boolean nullableP)

Get a new type with a nullablity, presumably different.

Specified by:

withNullable in interface PoemType<T>

Parameters:

nullableP - the nullability we want

Returns:

this or a clone with the desired nullability

See Also:

PoemType.withNullable(boolean)

saveColumnInfo

public void saveColumnInfo(ColumnInfo info)
                    throws AccessPoemException

Set the type of the ColumnInfo.

Specified by:

saveColumnInfo in interface PoemType<T>

Parameters:

info - the ColumnInfo to set the type of

Throws:

AccessPoemException - if our AccessToken does not permit modification

See Also:

PoemType.saveColumnInfo(org.melati.poem.ColumnInfo)

quotedRaw

public String quotedRaw(Object raw)
                 throws ValidationPoemException

Quoting a raw value, if appropriate, for the Dbms.

numbers and booleans are not quoted for most dbms'.

Specified by:

quotedRaw in interface SQLType<T>

Parameters:

raw - sql value

Returns:

the raw value with quotes if appropriate for the dbms

Throws:

ValidationPoemException

See Also:

SQLType.quotedRaw(java.lang.Object)

toString

public String toString()

Overrides:

toString in class Object

See Also:

Object.toString()