Produced by Siminov Software Solution LLP

siminov.orm.model
Class ApplicationDescriptor

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

public class ApplicationDescriptor
extends java.lang.Object

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


Example:
        <siminov>

                <property name="name">SIMINOV TEMPLATE</property>	
                <property name="description">Siminov Template Application</property>
                <property name="version">0.9</property>

                <property name="load_initially">true</property>

                <!-- DATABASE-DESCRIPTORS -->
                <database-descriptors>
                        <database-descriptor>DatabaseDescriptor.si.xml</database-descriptor>
                </database-descriptors>


                <!-- SIMINOV EVENTS -->
                <event-handlers>
                    <event-handler>com.core.template.events.SiminovEventHandler</event-handler>
                    <event-handler>com.core.template.events.DatabaseEventHandler</event-handler>
                </event-handlers>

        </siminov>
        

                


Constructor Summary
ApplicationDescriptor()
           
 
Method Summary
 void addDatabaseDescriptor(java.lang.String databaseDescriptorPath, DatabaseDescriptor databaseDescriptor)
          Add Database Descriptor object in respect to database descriptor path.
 void addDatabaseDescriptorPath(java.lang.String databaseDescriptorPath)
          Add Database Descriptor path as per contained in ApplicationDescriptor.si.xml file.
 void addEvent(java.lang.String event)
          Add event as per defined in ApplicationDescriptor.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 containsDatabaseDescriptor(DatabaseDescriptor databaseDescriptor)
          Check whether database descriptor exists in Resources or not.
 boolean containsDatabaseDescriptorBasedOnName(java.lang.String databaseDescriptorName)
          Check whether database descriptor exists in Resources or not, based on Database Descriptor name.
 boolean containsDatabaseDescriptorBasedOnPath(java.lang.String containDatabaseDescriptorPath)
          Check whether database descriptor exists in Resources or not, based on database descriptor path.
 DatabaseDescriptor getDatabaseDescriptorBasedOnName(java.lang.String databaseDescriptorName)
          Get Database Descriptor based on Database Descriptor Name.
 DatabaseDescriptor getDatabaseDescriptorBasedOnPath(java.lang.String databaseDescriptorPath)
          Get Database Descriptor based on Database Descriptor Path.
 java.util.Iterator<java.lang.String> getDatabaseDescriptorNames()
          Get all database descriptor names as per needed by application.
 java.util.Iterator<java.lang.String> getDatabaseDescriptorPaths()
          Get all database descriptor paths as per contained in ApplicationDescriptor.si.xml file.
 java.util.Iterator<DatabaseDescriptor> getDatabaseDescriptors()
          Get all database descriptor objects contains by Siminov.
 java.lang.String getDescription()
          Set Description of Application as per defined in ApplicationDescriptor.si.xml file.
 java.util.Iterator<java.lang.String> getEvents()
          Get all event handlers as per defined in ApplicationDescriptor.si.xml file.
 java.lang.String getName()
          Get Application Descriptor Name as per defined in ApplicationDescriptor.si.xml file.
 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.
 double getVersion()
          Get Version of Application as per defined in ApplicationDescriptor.si.xml file.
 boolean isDatabaseNeeded()
          Check whether database needed by application or not.
 boolean isLoadInitially()
          It defines the behavior of SIMINOV.
 void removeDatabaseDescriptor(DatabaseDescriptor databaseDescriptor)
          Remove DatabaseDescriptor object from Resources.
 void removeDatabaseDescriptorBasedOnName(java.lang.String databaseDescriptorName)
          Remove Database Descriptor from Resources based in database name provided, as per defined in DatabaseDescriptor.si.xml file
 void removeDatabaseDescriptorBasedOnPath(java.lang.String databaseDescriptorPath)
          Remove Database Descriptor from Resources based on database path provided, as per defined in ApplicationDescriptor.si.xml file
 void removeEvent(java.lang.String event)
           
 void removeProperty(java.lang.String name)
          Remove Property from property pool.
 void setDescription(java.lang.String description)
          Set Description of Application as per defined in ApplicationDescriptor.si.xml file.
 void setLoadInitially(boolean initialLoad)
          Set load initially to true or false.
 void setName(java.lang.String name)
          Set Application Descriptor Name as per defined in ApplicationDescriptor.si.xml file.
 void setVersion(double version)
          Set Version of Application as per defined in ApplicationDescriptor.si.xml file.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ApplicationDescriptor

public ApplicationDescriptor()
Method Detail

getName

public java.lang.String getName()
Get Application Descriptor Name as per defined in ApplicationDescriptor.si.xml file.

Returns:
Application Descriptor Name.

setName

public void setName(java.lang.String name)
Set Application Descriptor Name as per defined in ApplicationDescriptor.si.xml file.

Parameters:
name - Name of Application Descriptor.

getDescription

public java.lang.String getDescription()
Set Description of Application as per defined in ApplicationDescriptor.si.xml file.

Returns:
Description of application.

setDescription

public void setDescription(java.lang.String description)
Set Description of Application as per defined in ApplicationDescriptor.si.xml file.

Parameters:
description - Description of application.

getVersion

public double getVersion()
Get Version of Application as per defined in ApplicationDescriptor.si.xml file.

Returns:
Version of application.

setVersion

public void setVersion(double version)
Set Version of Application as per defined in ApplicationDescriptor.si.xml file.

Parameters:
version - Version of application.

isLoadInitially

public boolean isLoadInitially()
It defines the behavior of SIMINOV. (Should core load all database mapping at initialization or on demand).

Returns:
TRUE: If load initially is set to true, FALSE: If load initially is set to false.

setLoadInitially

public void setLoadInitially(boolean initialLoad)
Set load initially to true or false.

Parameters:
initialLoad - (true/false) defined by ApplicationDescriptor.si.xml file.

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.

isDatabaseNeeded

public boolean isDatabaseNeeded()
Check whether database needed by application or not.

Returns:
TRUE: If database needed by application, FALSE: If database is not needed by application.

containsDatabaseDescriptor

public boolean containsDatabaseDescriptor(DatabaseDescriptor databaseDescriptor)
Check whether database descriptor exists in Resources or not.

Parameters:
databaseDescriptor - Database Descriptor object.
Returns:
TRUE: If Database Descriptor exists in Resources, FALSE: If Database Descriptor does not exists in Resources.

containsDatabaseDescriptorBasedOnPath

public boolean containsDatabaseDescriptorBasedOnPath(java.lang.String containDatabaseDescriptorPath)
Check whether database descriptor exists in Resources or not, based on database descriptor path.

Parameters:
containDatabaseDescriptorPath - Database Descriptor path.
Returns:
TRUE: If Database Descriptor exists in Resources, FALSE: If Database Descriptor does not exists in Resources.

containsDatabaseDescriptorBasedOnName

public boolean containsDatabaseDescriptorBasedOnName(java.lang.String databaseDescriptorName)
Check whether database descriptor exists in Resources or not, based on Database Descriptor name.

Parameters:
databaseDescriptorName - Database Descriptor Name.
Returns:
TRUE: If Database Descriptor exists in Resources, FALSE: If Database Descriptor does not exists in Resources.

getDatabaseDescriptorBasedOnName

public DatabaseDescriptor getDatabaseDescriptorBasedOnName(java.lang.String databaseDescriptorName)
Get Database Descriptor based on Database Descriptor Name.

Parameters:
databaseDescriptorName - Database Desciptor Name.
Returns:
Database Descriptor Object.

getDatabaseDescriptorBasedOnPath

public DatabaseDescriptor getDatabaseDescriptorBasedOnPath(java.lang.String databaseDescriptorPath)
Get Database Descriptor based on Database Descriptor Path.

Parameters:
databaseDescriptorPath - Database Descriptor Path.
Returns:
Database Descriptor Object.

getDatabaseDescriptorPaths

public java.util.Iterator<java.lang.String> getDatabaseDescriptorPaths()
Get all database descriptor paths as per contained in ApplicationDescriptor.si.xml file.

Returns:
Iterator which contains all database descriptor paths.

getDatabaseDescriptorNames

public java.util.Iterator<java.lang.String> getDatabaseDescriptorNames()
Get all database descriptor names as per needed by application.

Returns:
Iterator which contains all database descriptor names.

addDatabaseDescriptorPath

public void addDatabaseDescriptorPath(java.lang.String databaseDescriptorPath)
Add Database Descriptor path as per contained in ApplicationDescriptor.si.xml file.

Parameters:
databaseDescriptorPath - DatabaseDescriptor path.

getDatabaseDescriptors

public java.util.Iterator<DatabaseDescriptor> getDatabaseDescriptors()
Get all database descriptor objects contains by Siminov.

Returns:
Iterator which contains all database descriptor objects.

addDatabaseDescriptor

public void addDatabaseDescriptor(java.lang.String databaseDescriptorPath,
                                  DatabaseDescriptor databaseDescriptor)
Add Database Descriptor object in respect to database descriptor path.

Parameters:
databaseDescriptorPath - Database Descriptor Path.
databaseDescriptor - Database Descriptor Object.

removeDatabaseDescriptorBasedOnPath

public void removeDatabaseDescriptorBasedOnPath(java.lang.String databaseDescriptorPath)
Remove Database Descriptor from Resources based on database path provided, as per defined in ApplicationDescriptor.si.xml file

Parameters:
databaseDescriptorPath - Database Descriptor Path.

removeDatabaseDescriptorBasedOnName

public void removeDatabaseDescriptorBasedOnName(java.lang.String databaseDescriptorName)
Remove Database Descriptor from Resources based in database name provided, as per defined in DatabaseDescriptor.si.xml file

Parameters:
databaseDescriptorName - DatabaseDescriptor Name.

removeDatabaseDescriptor

public void removeDatabaseDescriptor(DatabaseDescriptor databaseDescriptor)
Remove DatabaseDescriptor object from Resources.

Parameters:
databaseDescriptor - DatabaseDescriptor object which needs to be removed.

getEvents

public java.util.Iterator<java.lang.String> getEvents()
Get all event handlers as per defined in ApplicationDescriptor.si.xml file.

Returns:
All event handlers defined in ApplicationDescriptor.si.xml file

addEvent

public void addEvent(java.lang.String event)
Add event as per defined in ApplicationDescriptor.si.xml file.

Parameters:
event - Event Handler class name.

removeEvent

public void removeEvent(java.lang.String event)

Apache License 2.0

Copyright 2013