org.melati.poem.prepro

Class SearchabilityFieldDef

java.lang.Object

org.melati.poem.prepro.FieldDef

org.melati.poem.prepro.SearchabilityFieldDef

public class SearchabilityFieldDef
extends FieldDef

A definition of a SearchabilityPoemType from the DSD. A Searchability is a metadata field used in the ColumnInfo table. 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
SearchabilityFieldDef(int lineNo, TableDef table, String name, int displayOrder, 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.
String	poemTypeJava()

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

SearchabilityFieldDef

public SearchabilityFieldDef(int lineNo,
                             TableDef table,
                             String name,
                             int displayOrder,
                             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

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

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.