org.paneris.jal.model
Class FieldMetaData

java.lang.Object
  org.paneris.jal.model.FieldMetaData

public class FieldMetaData
extends java.lang.Object

A FieldMetaData encapsulates meta data for a single field in the datadictionary.

Constructor Summary

FieldMetaData(java.lang.String db, java.lang.Integer fn)
construct meta data for a field in the datadictionary

Method Summary

java.lang.String	getDefaultValue() returns the field's default value
java.lang.String	getDisplayName() returns the field's display name
int	getDisplayOrder() returns the field's display order
boolean	getEnforceUnique() returns true if this field should contain a unique value.
java.lang.String	getFieldName() returns the field's name
java.lang.Integer	getFieldNumber() returns the field's number
int	getHeight() returns the height of a textarea input box
boolean	getListDisplay() returns true if this field should appear on the list page
boolean	getMandatory() returns true if the field is mandatory
java.lang.Object	getMandatoryNull() returns null if the field is not mandatory.
int	getMaxLength() returns the maximum length of text in an input box
java.lang.String	getRelationshipField() returns the fieldname if this field is a look-up field
java.lang.String	getRelationshipTable() returns the tablename if this field is a look-up field
boolean	getSelectDisplay() returns true if this field should as a selection option on the list page
int	getSize() returns the size of the input box
SQLMetaData	getSQLMetaData() gets the type of this field as an java.sql.Type.
java.lang.String	getTableName() returns the field's tablename
java.lang.Integer	getTableNumber() returns the field's tablenumber
java.lang.String	getType() returns the field's type

Methods inherited from class java.lang.Object

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

Constructor Detail

FieldMetaData

public FieldMetaData(java.lang.String db,
                     java.lang.Integer fn)
              throws java.lang.Exception

construct meta data for a field in the datadictionary

Throws:

java.lang.Exception

Method Detail

getFieldNumber

public java.lang.Integer getFieldNumber()

returns the field's number

getFieldName

public java.lang.String getFieldName()

returns the field's name

getDefaultValue

public java.lang.String getDefaultValue()

returns the field's default value

getDisplayName

public java.lang.String getDisplayName()

returns the field's display name

getType

public java.lang.String getType()

returns the field's type

getTableNumber

public java.lang.Integer getTableNumber()

returns the field's tablenumber

getTableName

public java.lang.String getTableName()

returns the field's tablename

getDisplayOrder

public int getDisplayOrder()

returns the field's display order

getMandatory

public boolean getMandatory()

returns true if the field is mandatory

getMandatoryNull

public java.lang.Object getMandatoryNull()

returns null if the field is not mandatory. this will not be required in webmacro 0.90 where we can properly evaluate boolean expressions in the template

getRelationshipTable

public java.lang.String getRelationshipTable()

returns the tablename if this field is a look-up field

getRelationshipField

public java.lang.String getRelationshipField()

returns the fieldname if this field is a look-up field

getListDisplay

public boolean getListDisplay()

returns true if this field should appear on the list page

getSize

public int getSize()

returns the size of the input box

getMaxLength

public int getMaxLength()

returns the maximum length of text in an input box

getHeight

public int getHeight()

returns the height of a textarea input box

getEnforceUnique

public boolean getEnforceUnique()

returns true if this field should contain a unique value.

getSelectDisplay

public boolean getSelectDisplay()

returns true if this field should as a selection option on the list page

getSQLMetaData

public SQLMetaData getSQLMetaData()

gets the type of this field as an java.sql.Type. this is useful when setting null values in a prepared statement, where the type of the object is important