All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class org.paneris.util.FieldMetaData

java.lang.Object
   |
   +----org.paneris.util.FieldMetaData

public class FieldMetaData
extends Object

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


Constructor Index

 o FieldMetaData(String, Integer)
construct meta data for a field in the datadictionary

Method Index

 o getDisplayName()
returns the field's display name
 o getDisplayOrder()
returns the field's display order
 o getEnforceUnique()
returns true if this field should contain a unique value.
 o getFieldName()
returns the field's name
 o getFieldNumber()
returns the field's number
 o getListDisplay()
returns true if this field should appear on the list page
 o getMandatory()
returns true if the field is mandatory
 o getMandatoryNull()
returns null if the field is not mandatory.
 o getRelationshipField()
returns the fieldname if this field is a look-up field
 o getRelationshipTable()
returns the tablename if this field is a look-up field
 o getSelectDisplay()
returns true if this field should as a selection option on the list page
 o getSize()
returns the size of the input box
 o getSQLMetaData()
gets the type of this field as an java.sql.Type.
 o getTableName()
returns the field's tablename
 o getTableNumber()
returns the field's tablenumber
 o getType()
returns the field's type

Constructors

 o FieldMetaData
 public FieldMetaData(String db,
                      Integer fn) throws Exception
construct meta data for a field in the datadictionary

Methods

 o getFieldNumber
 public Integer getFieldNumber()
returns the field's number

 o getFieldName
 public String getFieldName()
returns the field's name

 o getDisplayName
 public String getDisplayName()
returns the field's display name

 o getType
 public String getType()
returns the field's type

 o getTableNumber
 public Integer getTableNumber()
returns the field's tablenumber

 o getTableName
 public String getTableName()
returns the field's tablename

 o getDisplayOrder
 public int getDisplayOrder()
returns the field's display order

 o getMandatory
 public boolean getMandatory()
returns true if the field is mandatory

 o getMandatoryNull
 public 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

 o getRelationshipTable
 public String getRelationshipTable()
returns the tablename if this field is a look-up field

 o getRelationshipField
 public String getRelationshipField()
returns the fieldname if this field is a look-up field

 o getListDisplay
 public boolean getListDisplay()
returns true if this field should appear on the list page

 o getSize
 public int getSize()
returns the size of the input box

 o getEnforceUnique
 public boolean getEnforceUnique()
returns true if this field should contain a unique value.

 o getSelectDisplay
 public boolean getSelectDisplay()
returns true if this field should as a selection option on the list page

 o 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


All Packages  Class Hierarchy  This Package  Previous  Next  Index