Produced by Siminov Software Solution LLP

siminov.orm.model
Class DatabaseMappingDescriptor

java.lang.Object
  extended by siminov.orm.model.DatabaseMappingDescriptor

public class DatabaseMappingDescriptor
extends java.lang.Object

Exposes methods to GET and SET Library Descriptor information as per define in DatabaseDescriptor.si.xml or LibraryDescriptor.si.xml file by application.


Example:
        <database-mapping>

                <table table_name="LIQUOR" class_name="siminov.orm.template.model.Liquor">

                        <column variable_name="liquorType" column_name="LIQUOR_TYPE">
                                <property name="type">TEXT</property>
                                <property name="primary_key">true</property>
                                <property name="not_null">true</property>
                                <property name="unique">true</property>
                        </column>		

                        <column variable_name="description" column_name="DESCRIPTION">
                                <property name="type">TEXT</property>
                        </column>

                        <column variable_name="history" column_name="HISTORY">
                                <property name="type">TEXT</property>
                        </column>

                        <column variable_name="link" column_name="LINK">
                                <property name="type">TEXT</property>
                                <property name="default">www.wikipedia.org</property>
                        </column>

                        <column variable_name="alcholContent" column_name="ALCHOL_CONTENT">
                                <property name="type">TEXT</property>
                        </column>

                        <index name="LIQUOR_INDEX_BASED_ON_LINK" unique="true">
                                <column>HISTORY</column>
                        </index>

                </table>

        </database-mapping>		

                

                


Nested Class Summary
static class DatabaseMappingDescriptor.Column
          Exposes methods to GET and SET Column information as per define in DatabaseMappingDescriptor.si.xml file by application.
static class DatabaseMappingDescriptor.Index
          Exposes methods to GET and SET Reference Map information as per define in DatabaseMappingDescriptor.si.xml file by application.
static class DatabaseMappingDescriptor.Relationship
          Contains relationship details.
 
Constructor Summary
DatabaseMappingDescriptor()
           
 
Method Summary
 void addColumn(DatabaseMappingDescriptor.Column column)
          Add column to DatabaseMapping object.
 void addIndex(DatabaseMappingDescriptor.Index index)
          Add index to DatabaseMapping object.
 void addRelationship(DatabaseMappingDescriptor.Relationship relationship)
          Add relationship object.
 boolean containsColumnBasedOnColumnName(java.lang.String columnName)
          Check whether column exists based on column name.
 boolean containsColumnBasedOnVariableName(java.lang.String variableName)
          Check whether column exists based on variable name.
 boolean containsIndex(java.lang.String indexName)
          Check whether index exists based in index name.
 java.lang.String getClassName()
          Get POJO class name.
 DatabaseMappingDescriptor.Column getColumnBasedOnColumnName(java.lang.String columnName)
          Get column based on column name.
 DatabaseMappingDescriptor.Column getColumnBasedOnVariableName(java.lang.String variableName)
          Get column based on variable name.
 java.util.Iterator<java.lang.String> getColumnNames()
          Get all column names.
 java.util.Iterator<DatabaseMappingDescriptor.Column> getColumns()
          Get all columns.
 DatabaseMappingDescriptor.Index getIndex(java.lang.String indexName)
          Get index object based on index name.
 java.util.Iterator<DatabaseMappingDescriptor.Index> getIndexes()
          Get all indexes.
 java.util.Iterator<java.lang.String> getIndexNames()
          Get all index names.
 java.util.Iterator<DatabaseMappingDescriptor.Relationship> getManyToManyRelationships()
          Get many to many relationship object.
 java.util.Iterator<DatabaseMappingDescriptor.Relationship> getManyToOneRelationships()
          Get many to one relationship object.
 java.util.Iterator<DatabaseMappingDescriptor.Relationship> getOneToManyRelationships()
          Get one to many relationship object.
 java.util.Iterator<DatabaseMappingDescriptor.Relationship> getOneToOneRelationships()
          Get one to one relationship object.
 DatabaseMappingDescriptor.Relationship getRelationshipBasedOnRefer(java.lang.String refer)
          Get iterator of relationship objects based on refer.
 DatabaseMappingDescriptor.Relationship getRelationshipBasedOnReferTo(java.lang.String referTo)
          Get relationship object based on refer to.
 java.util.Iterator<DatabaseMappingDescriptor.Relationship> getRelationships()
          Get iterator of relationship objects.
 java.lang.String getTableName()
          Get table name.
 void removeColumn(DatabaseMappingDescriptor.Column column)
          Remove column based on column object.
 void removeColumnBasedOnColumnName(java.lang.String columnName)
          Remove column based on column name.
 void removeColumnBasedOnVariableName(java.lang.String variableName)
          Remove column based on variable name.
 void removeIndex(DatabaseMappingDescriptor.Index index)
          Remove index object.
 void removeIndex(java.lang.String indexName)
          Remove index object.
 void setClassName(java.lang.String className)
          Set POJO class name as per defined in DatabaseMappingDescriptor.si.xml file.
 void setTableName(java.lang.String tableName)
          Set table name as per defined in DatabaseMappingDescriptor.si.xml file.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DatabaseMappingDescriptor

public DatabaseMappingDescriptor()
Method Detail

getTableName

public java.lang.String getTableName()
Get table name.

Returns:
Name of table.

setTableName

public void setTableName(java.lang.String tableName)
Set table name as per defined in DatabaseMappingDescriptor.si.xml file.

Parameters:
tableName - Name of table.

getClassName

public java.lang.String getClassName()
Get POJO class name.

Returns:
POJO class name.

setClassName

public void setClassName(java.lang.String className)
Set POJO class name as per defined in DatabaseMappingDescriptor.si.xml file.

Parameters:
className - POJO class name.

containsColumnBasedOnColumnName

public boolean containsColumnBasedOnColumnName(java.lang.String columnName)
Check whether column exists based on column name.

Parameters:
columnName - Name of column.
Returns:
TRUE: If column exists, FALSE: If column do not exists.

containsColumnBasedOnVariableName

public boolean containsColumnBasedOnVariableName(java.lang.String variableName)
Check whether column exists based on variable name.

Parameters:
variableName - Name of variable.
Returns:
TRUE: If column exists, FALSE: If column do not exists.

getColumnBasedOnColumnName

public DatabaseMappingDescriptor.Column getColumnBasedOnColumnName(java.lang.String columnName)
Get column based on column name.

Parameters:
columnName - Name of column name.
Returns:
Column object.

getColumnBasedOnVariableName

public DatabaseMappingDescriptor.Column getColumnBasedOnVariableName(java.lang.String variableName)
Get column based on variable name.

Parameters:
variableName - Name of variable.
Returns:
Column object.

getColumnNames

public java.util.Iterator<java.lang.String> getColumnNames()
Get all column names.

Returns:
Iterator of all column names.

getColumns

public java.util.Iterator<DatabaseMappingDescriptor.Column> getColumns()
Get all columns.

Returns:
Iterator of all columns.

addColumn

public void addColumn(DatabaseMappingDescriptor.Column column)
Add column to DatabaseMapping object.

Parameters:
column - Column object.

removeColumnBasedOnVariableName

public void removeColumnBasedOnVariableName(java.lang.String variableName)
Remove column based on variable name.

Parameters:
variableName - Name of variable.

removeColumnBasedOnColumnName

public void removeColumnBasedOnColumnName(java.lang.String columnName)
Remove column based on column name.

Parameters:
columnName - Name of column.

removeColumn

public void removeColumn(DatabaseMappingDescriptor.Column column)
Remove column based on column object.

Parameters:
column - Column object which need to be removed.

containsIndex

public boolean containsIndex(java.lang.String indexName)
Check whether index exists based in index name.

Parameters:
indexName - Name of index.
Returns:
TRUE: If index exists, FALSE: If index do not exists.

getIndex

public DatabaseMappingDescriptor.Index getIndex(java.lang.String indexName)
Get index object based on index name.

Parameters:
indexName - Name of index.
Returns:
Index object.

getIndexNames

public java.util.Iterator<java.lang.String> getIndexNames()
Get all index names.

Returns:
Iterator which contains all index names.

getIndexes

public java.util.Iterator<DatabaseMappingDescriptor.Index> getIndexes()
Get all indexes.

Returns:
Iterator which contain all indexes.

addIndex

public void addIndex(DatabaseMappingDescriptor.Index index)
Add index to DatabaseMapping object.

Parameters:
index - Index object.

removeIndex

public void removeIndex(java.lang.String indexName)
Remove index object.

Parameters:
indexName - Name of index.

removeIndex

public void removeIndex(DatabaseMappingDescriptor.Index index)
Remove index object.

Parameters:
index - Index object.

getRelationships

public java.util.Iterator<DatabaseMappingDescriptor.Relationship> getRelationships()
Get iterator of relationship objects.

Returns:
Relationship objects.

getRelationshipBasedOnRefer

public DatabaseMappingDescriptor.Relationship getRelationshipBasedOnRefer(java.lang.String refer)
Get iterator of relationship objects based on refer.

Parameters:
refer - Name of refer.
Returns:
Relationship object based on refer.

getRelationshipBasedOnReferTo

public DatabaseMappingDescriptor.Relationship getRelationshipBasedOnReferTo(java.lang.String referTo)
Get relationship object based on refer to.

Parameters:
referTo - Name of refer to.
Returns:
Relationship object based on refer to.

getOneToOneRelationships

public java.util.Iterator<DatabaseMappingDescriptor.Relationship> getOneToOneRelationships()
Get one to one relationship object.

Returns:
Iterator of relationship objects.

getOneToManyRelationships

public java.util.Iterator<DatabaseMappingDescriptor.Relationship> getOneToManyRelationships()
Get one to many relationship object.

Returns:
Iterator of relationship objects.

getManyToOneRelationships

public java.util.Iterator<DatabaseMappingDescriptor.Relationship> getManyToOneRelationships()
Get many to one relationship object.

Returns:
Iterator of relationship objects.

getManyToManyRelationships

public java.util.Iterator<DatabaseMappingDescriptor.Relationship> getManyToManyRelationships()
Get many to many relationship object.

Returns:
Iterator of relationship objects.

addRelationship

public void addRelationship(DatabaseMappingDescriptor.Relationship relationship)
Add relationship object.

Parameters:
relationship - Relationship object.

Apache License 2.0

Copyright 2013