org.melati.poem.prepro

Class StringKeyReferenceFieldDef

java.lang.Object

org.melati.poem.prepro.FieldDef

org.melati.poem.prepro.StringKeyReferenceFieldDef

public class StringKeyReferenceFieldDef
extends FieldDef

A definition of a StringKeyReferencePoemType from the DSD. Its member variables are populated from the DSD or defaults. Its methods are used to generate the java code.

Field Summary

Fields inherited from class org.melati.poem.prepro.FieldDef

capitalisedName, displayLevel, displayOrder, fieldQualifiers, lineNumber, name, rawType, searchability, table, typeShortName

Constructor Summary

Constructors

Constructor and Description
StringKeyReferenceFieldDef(int lineNo, TableDef table, String name, String targetFieldName, int displayOrder, String type, Vector<FieldQualifier> qualifiers) Constructor.

Method Summary

Modifier and Type	Method and Description
void	generateBaseMethods(Writer w) Write out this Column's base methods.
protected void	generateColRawAccessors(Writer w) Write out this Column's field accessors as part of the anonymous definition of the Column.
void	generateJavaDeclaration(Writer w) Write out this Field's java declaration string.
TableNamingInfo	getTargetTableNamingInfo() Due to possible forward references this could be null until we finish parse
String	poemTypeJava()
void	setIntegrityFix(String integrityFixIn)
void	setSize(int sizeP) Set the size property.

Methods inherited from class org.melati.poem.prepro.FieldDef

from, generateColAccessor, generateColDecl, generateColDefinition, generateFieldCreator, getHeight, getWidth, isCreateable, isDeletedColumn, isEditable, isIndexed, isNullable, isSortDescending, isTroidColumn, isUnique, setCreateable, setDeletedColumn, setEditable, setHeight, setIndexed, setNullable, setSortDescending, setTroidColumn, setUnique, setWidth, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

StringKeyReferenceFieldDef

public StringKeyReferenceFieldDef(int lineNo,
                                  TableDef table,
                                  String name,
                                  String targetFieldName,
                                  int displayOrder,
                                  String type,
                                  Vector<FieldQualifier> qualifiers)
                           throws org.melati.poem.prepro.IllegalityException

Constructor.

Parameters:

lineNo - the line number in the DSD file

table - the TableDef that this Field is part of

name - the name of this field in this table

targetFieldName - the name of the key field in target

type - the type of this field, ie the target table name

displayOrder - where to place this field in a list

qualifiers - all the qualifiers of this field

Throws:

IllegalityException - if a semantic inconsistency is detected

Method Detail

getTargetTableNamingInfo

public TableNamingInfo getTargetTableNamingInfo()

Due to possible forward references this could be null until we finish parse

Returns:

the possibly null TableNamingInfo

generateColRawAccessors

protected void generateColRawAccessors(Writer w)
                                throws IOException

Description copied from class: FieldDef

Write out this Column's field accessors as part of the anonymous definition of the Column.

Overrides:

generateColRawAccessors in class FieldDef

Parameters:

w - The base table java file.

Throws:

IOException - if something goes wrong with the file system

generateBaseMethods

public void generateBaseMethods(Writer w)
                         throws IOException

Description copied from class: FieldDef

Write out this Column's base methods.

Overrides:

generateBaseMethods in class FieldDef

Parameters:

w - The base persistent java file.

Throws:

IOException - if something goes wrong with the file system

generateJavaDeclaration

public void generateJavaDeclaration(Writer w)
                             throws IOException

Write out this Field's java declaration string.

Specified by:

generateJavaDeclaration in class FieldDef

Parameters:

w - The base persistent java file.

Throws:

IOException - if something goes wrong with the file system

poemTypeJava

public String poemTypeJava()

Specified by:

poemTypeJava in class FieldDef

Returns:

the Java string for this PoemType.

setSize

public void setSize(int sizeP)

Set the size property.

Parameters:

sizeP - the size to set

setIntegrityFix

public void setIntegrityFix(String integrityFixIn)