net.jot.persistance
Class JOTModelMapping

java.lang.Object
  extended by net.jot.persistance.JOTModelMapping

public class JOTModelMapping
extends java.lang.Object

Handles the mapping of a DB representaion (java object) to a DB table

Author:
tcolar

Field Summary
 boolean createMissingTables
           
static java.lang.String META_FILE_EXTENSION
           
 
Constructor Summary
JOTModelMapping()
           
 
Method Summary
 void defineFieldDBName(java.lang.String field, java.lang.String name)
           
 void defineFieldMaxlength(java.lang.String field, int value)
           
 void defineFieldMaxValue(java.lang.String field, int value)
           
 void defineFieldMinlength(java.lang.String field, int value)
           
 void defineFieldMinValue(java.lang.String field, int value)
           
 void defineFieldSize(java.lang.String field, int value)
           
 void defineFieldsToIgnore(java.lang.String[] ignore)
           
 void defineFieldType(java.lang.String field, java.lang.String type)
           
 void definePrimaryKey(java.lang.String primaryKey)
           
 void defineTableName(java.lang.String tableName)
           
static void deleteMetaFile(JOTModelMapping mapping)
           
 int getDataSize()
          Returns the size(bytes) of a "row" of data.
 java.util.Hashtable getFields()
           
 int getFieldSize(JOTDBField field)
           
 java.lang.String[] getIgnoredFields()
           
 java.util.Hashtable getMappedFields()
           
protected  java.lang.String getMeta()
          Returns the Metadata respresentation of the table columns ie: "id":int4, "name":varchar(100) ....
 java.lang.String getPrimaryKey()
           
 java.lang.String getQueryClassName()
           
 java.lang.String getStorageName()
           
 java.lang.String getTableName()
           
static JOTModelMeta readMetaFile(JOTModelMapping mapping)
           
 void setFields(java.util.Hashtable fields)
           
 void setIgnoredFields(java.lang.String[] ignoredFields)
           
 void setMappedFields(java.util.Hashtable mappedFields)
           
 void setPrimaryKey(java.lang.String primaryKey)
           
 void setQueryClassName(java.lang.String className)
           
 void setStorageName(java.lang.String storageName)
           
 void setTableName(java.lang.String tableName)
           
static void writeMetaFile(JOTModelMapping mapping)
          Writes the current mapping (table metadata) to the metadata file (.jotmeta)
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

META_FILE_EXTENSION

public static final java.lang.String META_FILE_EXTENSION
See Also:
Constant Field Values

createMissingTables

public boolean createMissingTables
Constructor Detail

JOTModelMapping

public JOTModelMapping()
Method Detail

defineFieldMaxValue

public void defineFieldMaxValue(java.lang.String field,
                                int value)

defineFieldMinValue

public void defineFieldMinValue(java.lang.String field,
                                int value)

defineFieldSize

public void defineFieldSize(java.lang.String field,
                            int value)

defineFieldMinlength

public void defineFieldMinlength(java.lang.String field,
                                 int value)

setPrimaryKey

public void setPrimaryKey(java.lang.String primaryKey)

setStorageName

public void setStorageName(java.lang.String storageName)

setTableName

public void setTableName(java.lang.String tableName)

defineFieldMaxlength

public void defineFieldMaxlength(java.lang.String field,
                                 int value)

defineFieldType

public void defineFieldType(java.lang.String field,
                            java.lang.String type)

defineFieldDBName

public void defineFieldDBName(java.lang.String field,
                              java.lang.String name)

defineFieldsToIgnore

public void defineFieldsToIgnore(java.lang.String[] ignore)

getFields

public java.util.Hashtable getFields()

setFields

public void setFields(java.util.Hashtable fields)

getIgnoredFields

public java.lang.String[] getIgnoredFields()

setIgnoredFields

public void setIgnoredFields(java.lang.String[] ignoredFields)

getMappedFields

public java.util.Hashtable getMappedFields()

setMappedFields

public void setMappedFields(java.util.Hashtable mappedFields)

getPrimaryKey

public java.lang.String getPrimaryKey()

definePrimaryKey

public void definePrimaryKey(java.lang.String primaryKey)

getStorageName

public java.lang.String getStorageName()

getTableName

public java.lang.String getTableName()

defineTableName

public void defineTableName(java.lang.String tableName)

getQueryClassName

public java.lang.String getQueryClassName()

setQueryClassName

public void setQueryClassName(java.lang.String className)

getDataSize

public int getDataSize()
Returns the size(bytes) of a "row" of data.

Returns:

getFieldSize

public int getFieldSize(JOTDBField field)

getMeta

protected java.lang.String getMeta()
Returns the Metadata respresentation of the table columns ie: "id":int4, "name":varchar(100) ....

Parameters:
mapping -
Returns:

writeMetaFile

public static void writeMetaFile(JOTModelMapping mapping)
                          throws java.lang.Exception
Writes the current mapping (table metadata) to the metadata file (.jotmeta)

Parameters:
mapping -
Throws:
java.lang.Exception

readMetaFile

public static JOTModelMeta readMetaFile(JOTModelMapping mapping)
                                 throws java.lang.Exception
Throws:
java.lang.Exception

deleteMetaFile

public static void deleteMetaFile(JOTModelMapping mapping)