org.melati.poem

Class StringKeyReferencePoemType

java.lang.Object

org.melati.poem.BasePoemType<T>

org.melati.poem.AtomPoemType<T>

org.melati.poem.SizedAtomPoemType<String>

org.melati.poem.StringPoemType

org.melati.poem.StringKeyPoemType

org.melati.poem.StringKeyReferencePoemType

All Implemented Interfaces:

Cloneable, PersistentReferencePoemType, PoemType<String>, SQLPoemType<String>, SQLType<String>

public class StringKeyReferencePoemType
extends StringKeyPoemType
implements PersistentReferencePoemType, PoemType<String>

A data type that is a reference to a Persistent object via a String key to a unique, non-nullable index. NOTE: The field may be a different size to the field in the target table.

Since:

2012-05-19

Author:

timp

Field Summary

Fields inherited from class org.melati.poem.StringPoemType

nullableInstance

Constructor Summary

Constructors

Constructor and Description
StringKeyReferencePoemType(Table<?> targetTable, String targetKeyName, boolean nullable, int size) Constructor.

Method Summary

Modifier and Type	Method and Description
String	targetKeyName()
Table<?>	targetTable()
String	toDsdType() The field type used in the Data Structure Definition language.
String	toString()

Methods inherited from class org.melati.poem.SizedAtomPoemType

getSize, sizeGreaterEqual, withSize

Methods inherited from class org.melati.poem.AtomPoemType

sqlDefaultValue

Methods inherited from class org.melati.poem.BasePoemType

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.melati.poem.PoemType

assertValidCooked, assertValidRaw, canRepresent, cookedOfRaw, getNullable, possibleRaws, rawOfCooked, rawOfString, saveColumnInfo, stringOfCooked, stringOfRaw, withNullable

Constructor Detail

StringKeyReferencePoemType

public StringKeyReferencePoemType(Table<?> targetTable,
                                  String targetKeyName,
                                  boolean nullable,
                                  int size)

Constructor.

Parameters:

targetTable - the Table the type refers to

targetKeyName - name of key both in this and target table

nullable - whether this type may contain null values

size - the size of the key string

Method Detail

targetTable

public Table<?> targetTable()

Specified by:

targetTable in interface PersistentReferencePoemType

Returns:

Table this type references

See Also:

PersistentReferencePoemType.targetTable()

targetKeyName

public String targetKeyName()

Returns:

the key name in target table, also this table

toString

public String toString()

Overrides:

toString in class StringPoemType

See Also:

BasePoemType.toString()

toDsdType

public String toDsdType()

The field type used in the Data Structure Definition language.

Specified by:

toDsdType in interface PoemType<String>

Overrides:

toDsdType in class StringPoemType

Returns:

a dsd type

See Also:

PoemType.toDsdType()