Produced by Siminov Software Solution LLP

siminov.orm.model
Class LibraryDescriptor

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

public class LibraryDescriptor
extends java.lang.Object

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


Example:
        <library>

                <property name="name">SIMINOV LIBRARY TEMPLATE</property>
                <property name="description">Siminov Library Template</property>

                <!-- Database Mappings -->
                        <database-mappings>
                                <database-mapping path="Credential.si.xml" />
                        </database-mappings>

                                <!-- OR -->

                        <database-mappings>
                                <database-mapping path="siminov.orm.library.template.model.Credential" />
                        </database-mappings>

        </library>
        

                


Constructor Summary
LibraryDescriptor()
           
 
Method Summary
 void addDatabaseMapping(java.lang.String libraryDatabaseMappingPath, DatabaseMappingDescriptor databaseMapping)
          Add database mapping object in respect to database mapping path.
 void addDatabaseMappingPath(java.lang.String databaseMappingPath)
          Add database mapping path as per defined in DatabaseDescriptor.si.xml file.
 void addProperty(java.lang.String name, java.lang.String value)
          Add Property in property pool.
 boolean containProperty(java.lang.String name)
          Check whether Property exist or not.
 boolean containsDatabaseMappingBasedOnClassName(java.lang.String className)
          Check whether database mapping object exists or not, based on POJO class name.
 boolean containsDatabaseMappingBasedOnTableName(java.lang.String tableName)
          Check whether database mapping object exists or not, based on table name.
 java.util.Iterator<java.lang.String> getDatabaseMappingPaths()
          Get all database mapping paths as per defined in DatabaseDescriptor.si.xml file.
 DatabaseMappingDescriptor getDatabseMappingBasedOnClassName(java.lang.String className)
          Get database mapping object based on POJO class name.
 DatabaseMappingDescriptor getDatabseMappingBasedOnPath(java.lang.String libraryDatabaseMappingPath)
          Get database mapping object based on path.
 DatabaseMappingDescriptor getDatabseMappingBasedOnTableName(java.lang.String tableName)
          Get database mapping object based on table name.
 java.util.Iterator<DatabaseMappingDescriptor> getDatabseMappings()
          Get all database mapping objects contained.
 java.lang.String getDescription()
          Get descriptor as per defined in LibraryDescriptor.si.xml
 java.lang.String getName()
          Get library name.
 java.util.Iterator<java.lang.String> getProperties()
          Get all Properties defined in descriptor.
 java.lang.String getProperty(java.lang.String name)
          Get Property based on name provided.
 java.util.Iterator<DatabaseMappingDescriptor> orderedDatabaseMappings()
          Get all database mapping objects in sorted order.
 void removeDatabaseMapping(DatabaseMappingDescriptor databaseMapping)
          Remove database mapping object based on database mapping object.
 void removeDatabaseMappingBasedOnClassName(java.lang.String className)
          Remove database mappping object based on POJO class name.
 void removeDatabaseMappingBasedOnPath(java.lang.String databaseMappingPath)
          Remove database mapping object based on database mapping path.
 void removeDatabaseMappingBasedOnTableName(java.lang.String tableName)
          Remove database mapping object based on table name.
 void removeProperty(java.lang.String name)
          Remove Property from property pool.
 void setDescription(java.lang.String description)
          Set description as per defined in LibraryDescritor.core.xml
 void setName(java.lang.String name)
          Set library name as per defined in LibraryDescriptor.si.xml
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

LibraryDescriptor

public LibraryDescriptor()
Method Detail

getName

public java.lang.String getName()
Get library name.

Returns:

setName

public void setName(java.lang.String name)
Set library name as per defined in LibraryDescriptor.si.xml

Parameters:
name -

getDescription

public java.lang.String getDescription()
Get descriptor as per defined in LibraryDescriptor.si.xml

Returns:

setDescription

public void setDescription(java.lang.String description)
Set description as per defined in LibraryDescritor.core.xml

Parameters:
description -

getProperties

public java.util.Iterator<java.lang.String> getProperties()
Get all Properties defined in descriptor.

Returns:
All Property Values.

getProperty

public java.lang.String getProperty(java.lang.String name)
Get Property based on name provided.

Parameters:
name - Name of Property.
Returns:
Property value.

containProperty

public boolean containProperty(java.lang.String name)
Check whether Property exist or not.

Parameters:
name - Name of Property.
Returns:
true/false, TRUE if property exist, FALSE if property does not exist.

addProperty

public void addProperty(java.lang.String name,
                        java.lang.String value)
Add Property in property pool.

Parameters:
name - Name of Property.
value - value of Property.

removeProperty

public void removeProperty(java.lang.String name)
Remove Property from property pool.

Parameters:
name - Name of Property.

containsDatabaseMappingBasedOnTableName

public boolean containsDatabaseMappingBasedOnTableName(java.lang.String tableName)
Check whether database mapping object exists or not, based on table name.

Parameters:
tableName - Name of table.
Returns:
TRUE: If database mapping exists, FALSE: If database mapping does not exists.

containsDatabaseMappingBasedOnClassName

public boolean containsDatabaseMappingBasedOnClassName(java.lang.String className)
Check whether database mapping object exists or not, based on POJO class name.

Parameters:
className - POJO class name.
Returns:
TRUE: If database mapping exists, FALSE: If database mapping does not exists.

getDatabaseMappingPaths

public java.util.Iterator<java.lang.String> getDatabaseMappingPaths()
Get all database mapping paths as per defined in DatabaseDescriptor.si.xml file.

Returns:
Iterator which contain all database mapping paths.

addDatabaseMappingPath

public void addDatabaseMappingPath(java.lang.String databaseMappingPath)
Add database mapping path as per defined in DatabaseDescriptor.si.xml file.


EXAMPLE:
        <database-descriptor>
                <database-mappings>
                        <database-mapping path="Liquor-Mappings/Liquor.xml" />
                        <database-mapping path="Liquor-Mappings/LiquorBrand.xml" />
                </database-mappings>
        </database-descriptor>
        

                

Parameters:
databaseMappingPath - Database Mapping Path.

getDatabseMappings

public java.util.Iterator<DatabaseMappingDescriptor> getDatabseMappings()
Get all database mapping objects contained.

Returns:
All database mapping objects.

getDatabseMappingBasedOnTableName

public DatabaseMappingDescriptor getDatabseMappingBasedOnTableName(java.lang.String tableName)
Get database mapping object based on table name.

Parameters:
tableName - Name of table.
Returns:
DatabaseMapping object based on table name.

getDatabseMappingBasedOnClassName

public DatabaseMappingDescriptor getDatabseMappingBasedOnClassName(java.lang.String className)
Get database mapping object based on POJO class name.

Parameters:
className - POJO class name.
Returns:
Database Mapping object.

getDatabseMappingBasedOnPath

public DatabaseMappingDescriptor getDatabseMappingBasedOnPath(java.lang.String libraryDatabaseMappingPath)
Get database mapping object based on path.

Parameters:
databaseMappingPath - Database Mapping path as per defined in Database Descriptor.xml file.
Returns:
Database Mapping object.

addDatabaseMapping

public void addDatabaseMapping(java.lang.String libraryDatabaseMappingPath,
                               DatabaseMappingDescriptor databaseMapping)
Add database mapping object in respect to database mapping path.

Parameters:
databaseMappingPath - Database Mapping Path.
databaseMapping - Database Mapping object.

removeDatabaseMappingBasedOnPath

public void removeDatabaseMappingBasedOnPath(java.lang.String databaseMappingPath)
Remove database mapping object based on database mapping path.

Parameters:
databaseMappingPath - Database Mapping Path.

removeDatabaseMappingBasedOnClassName

public void removeDatabaseMappingBasedOnClassName(java.lang.String className)
Remove database mappping object based on POJO class name.

Parameters:
className - POJO class name.

removeDatabaseMappingBasedOnTableName

public void removeDatabaseMappingBasedOnTableName(java.lang.String tableName)
Remove database mapping object based on table name.

Parameters:
tableName - Name of table.

removeDatabaseMapping

public void removeDatabaseMapping(DatabaseMappingDescriptor databaseMapping)
Remove database mapping object based on database mapping object.

Parameters:
databaseMapping - Database Mapping object which needs to be removed.

orderedDatabaseMappings

public java.util.Iterator<DatabaseMappingDescriptor> orderedDatabaseMappings()
Get all database mapping objects in sorted order. The order will be as per defined in DatabaseDescriptor.si.xml file.

Returns:
Iterator which contains all database mapping objects.

Apache License 2.0

Copyright 2013