org.melati.poem
Class ReferencePoemType

java.lang.Object
  org.melati.poem.BasePoemType<T>
      org.melati.poem.AtomPoemType<T>
          org.melati.poem.IntegerPoemType
              org.melati.poem.IndexPoemType
                  org.melati.poem.ReferencePoemType

All Implemented Interfaces:

Cloneable, PoemType, SQLPoemType, SQLType

Direct Known Subclasses:

RestrictedReferencePoemType

public class ReferencePoemType
extends IndexPoemType

A data type that is a reference to a Persistent object.

Field Summary

Fields inherited from class org.melati.poem.IntegerPoemType

nullableInstance

Fields inherited from class org.melati.poem.AtomPoemType

sqlTypeName

Fields inherited from class org.melati.poem.BasePoemType

nullable

Constructor Summary

ReferencePoemType(Table targetTable, boolean nullable)
Constructor.

Method Summary

protected void	_assertValidCooked(Object cooked)
protected boolean	_canRepresent(SQLPoemType other)
protected Object	_cookedOfRaw(Object raw) Returns the given value unchanged.
protected Enumeration<Integer>	_possibleRaws() Returns an Enumeration of the possible raw values.
protected Object	_rawOfCooked(Object cooked) Returns the given value unchanged.
protected void	_saveColumnInfo(ColumnInfo columnInfo)
protected String	_stringOfCooked(Object cooked, PoemLocale locale, int style)
Table	targetTable()
String	toDsdType() The field type used in the Data Structure Definition language.
String	toString()

Methods inherited from class org.melati.poem.IntegerPoemType

_assertValidRaw, _getRaw, _rawOfString, _setRaw

Methods inherited from class org.melati.poem.AtomPoemType

_quotedRaw, _sqlDefinition, _stringOfRaw, _toString, sqlDefaultValue

Methods inherited from class org.melati.poem.BasePoemType

assertValidCooked, assertValidRaw, canRepresent, clone, cookedOfRaw, getLimitRaw, getLowRaw, getNullable, getRaw, possibleRaws, quotedRaw, rawOfCooked, rawOfString, saveColumnInfo, setRaw, setRawRange, sqlDefinition, sqlTypeCode, sqlTypeDefinition, stringOfCooked, stringOfRaw, withNullable

Methods inherited from class java.lang.Object

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

Constructor Detail

ReferencePoemType

public ReferencePoemType(Table targetTable,
                         boolean nullable)

Constructor.

Parameters:

targetTable - the Table the type refers to

nullable - whether this type may contain null values

Method Detail

targetTable

public Table targetTable()

Returns:

Table this type references

_possibleRaws

protected Enumeration<Integer> _possibleRaws()

Returns an Enumeration of the possible raw values.

In this case the troids of rows in the referenced table.

Overrides:

_possibleRaws in class IntegerPoemType

_assertValidCooked

protected void _assertValidCooked(Object cooked)
                           throws ValidationPoemException

Overrides:

_assertValidCooked in class AtomPoemType

Throws:

ValidationPoemException

_cookedOfRaw

protected Object _cookedOfRaw(Object raw)
                       throws NoSuchRowPoemException

Description copied from class: AtomPoemType

Returns the given value unchanged.

Overrides:

_cookedOfRaw in class AtomPoemType

Parameters:

raw - the base object or Integer object id

Returns:

the unchanged base object or an instantiated type

Throws:

NoSuchRowPoemException

_rawOfCooked

protected Object _rawOfCooked(Object cooked)

Description copied from class: AtomPoemType

Returns the given value unchanged.

Overrides:

_rawOfCooked in class AtomPoemType

_stringOfCooked

protected String _stringOfCooked(Object cooked,
                                 PoemLocale locale,
                                 int style)
                          throws PoemException

Overrides:

_stringOfCooked in class AtomPoemType

Throws:

PoemException

_canRepresent

protected boolean _canRepresent(SQLPoemType other)

Description copied from class: IntegerPoemType

Overrides:

_canRepresent in class IntegerPoemType

See Also:

BasePoemType._canRepresent(org.melati.poem.SQLPoemType)

_saveColumnInfo

protected void _saveColumnInfo(ColumnInfo columnInfo)
                        throws AccessPoemException

Overrides:

_saveColumnInfo in class IntegerPoemType

Throws:

AccessPoemException

toString

public String toString()

Overrides:

toString in class BasePoemType

See Also:

BasePoemType.toString()

toDsdType

public String toDsdType()

The field type used in the Data Structure Definition language.

Specified by:

toDsdType in interface PoemType

Overrides:

toDsdType in class IntegerPoemType

Returns:

the Type name

See Also:

PoemType.toDsdType()