SICDatabaseDescriptor Class Reference
Inherits from | NSObject |
---|---|
Conforms to | SICIDescriptor |
Declared in | SICDatabaseDescriptor.h SICDatabaseDescriptor.m |
Overview
Exposes methods to GET and SET Database Descriptor information as per define in DatabaseDescriptor.xml file by application.
Example:
<database-descriptor>
<!-- General Database Descriptor Properties -->
<!-- Mandatory Field -->
<property name="database_name">name_of_database_file</property>
<!-- Optional Field (Default is sqlite)-->
<property name="type">type_of_database</property>
<!-- Mandatory Field -->
<property name="version">database_version</property>
<!-- Optional Field -->
<property name="description">database_description</property>
<!-- Optional Field (Default is false) -->
<property name="transaction_safe">true/false</property>
<!-- Optional Field (Default is false) -->
<property name="external_storage">true/false</property>
<!-- Entity Descriptor Paths Needed Under This Database Descriptor -->
<!-- Optional Field -->
<entity-descriptors>
<entity-descriptor>full_path_of_entity_descriptor_file</entity-descriptor>
</entity-descriptors>
</database-descriptor>
Other Methods
– getDatabaseName
Get database descriptor name as defined in DatabaseDescriptor.core.xml file.
- (NSString *)getDatabaseName
Return Value
Database Descriptor Name.
Discussion
Get database descriptor name as defined in DatabaseDescriptor.core.xml file.
Declared In
SICDatabaseDescriptor.h
– setDatabaseName:
Set database descriptor name as per defined in DatabaseDescriptor.core.xml file.
- (void)setDatabaseName:(NSString *const)databaseName
Parameters
databaseName |
Database Descriptor Name. |
---|
Discussion
Set database descriptor name as per defined in DatabaseDescriptor.core.xml file.
Declared In
SICDatabaseDescriptor.h
– getType
Get type of database
- (NSString *)getType
Return Value
Type of database
Discussion
Get type of database
Declared In
SICDatabaseDescriptor.h
– setType:
Set type of database
- (void)setType:(NSString *)type
Parameters
type |
Type of database |
---|
Discussion
Set type of database
Declared In
SICDatabaseDescriptor.h
– getVersion
Get Version of Application as per defined in ApplicationDescriptor.core.xml file. Version of application.
- (double)getVersion
Discussion
Get Version of Application as per defined in ApplicationDescriptor.core.xml file. Version of application.
Declared In
SICDatabaseDescriptor.h
– setVersion:
Set Version of Application as per defined in ApplicationDescriptor.core.xml file.
- (void)setVersion:(double const)version
Parameters
version |
Version of application. |
---|
Discussion
Set Version of Application as per defined in ApplicationDescriptor.core.xml file.
Declared In
SICDatabaseDescriptor.h
– getDescription
Get description as per defined in DatabaseDescriptor.core.xml file.
- (NSString *)getDescription
Return Value
Description defined in DatabaseDescriptor.core.xml file.
Discussion
Get description as per defined in DatabaseDescriptor.core.xml file.
Declared In
SICDatabaseDescriptor.h
– setDescription:
Set description as per defined in DatabaseDescritor.xml file.
- (void)setDescription:(NSString *const)description
Parameters
description |
Description defined in DatabaseDescriptor.core.xml file. |
---|
Discussion
Set description as per defined in DatabaseDescritor.xml file.
Declared In
SICDatabaseDescriptor.h
– isExternalStorageEnable
Check whether database needs to be stored on SDCard or not.
- (BOOL)isExternalStorageEnable
Return Value
TRUE:If external_storage defined as true in DatabaseDescriptor.core.xml file, FALSE:If external_storage defined as false in DatabaseDescritor.xml file.
Discussion
Check whether database needs to be stored on SDCard or not.
Declared In
SICDatabaseDescriptor.h
– setExternalStorageEnable:
Set the external storage value as per defined in DatabaseDescriptor.xml file.
- (void)setExternalStorageEnable:(BOOL const)isExternalStorageEnable
Parameters
isExternalStorageEnable |
(true/false) External Storage Enable Or Not. |
---|
Discussion
Set the external storage value as per defined in DatabaseDescriptor.xml file.
Declared In
SICDatabaseDescriptor.h
– isTransactionSafe
Check whether database transactions to make multi-threading safe or not.
- (BOOL)isTransactionSafe
Return Value
TRUE: If locking is required as per defined in DatabaseDescriptor.xml file, FALSE: If locking is not required as per defined in DatabaseDescriptor.xml file.
Discussion
Check whether database transactions to make multi-threading safe or not.
Declared In
SICDatabaseDescriptor.h
– setTransactionSafe:
Set database locking as per defined in DatabaseDescriptor.xml file.
- (void)setTransactionSafe:(BOOL const)transactionSafe
Parameters
transactionSafe |
(true/false) database locking as per defined in DatabaseDescriptor.xml file. |
---|
Discussion
Set database locking as per defined in DatabaseDescriptor.xml file.
Declared In
SICDatabaseDescriptor.h
– containsEntityDescriptorBasedOnTableName:
Check whether entity descriptor object exists or not, based on table name.
- (BOOL)containsEntityDescriptorBasedOnTableName:(NSString *const)tableName
Parameters
tableName |
Name of table. |
---|
Return Value
TRUE: If entity descriptor exists, FALSE: If entity descriptor does not exists.
Discussion
Check whether entity descriptor object exists or not, based on table name.
Declared In
SICDatabaseDescriptor.h
– containsEntityDescriptorBasedOnClassName:
Check whether entity descriptor object exists or not, based on mapped class name.
- (BOOL)containsEntityDescriptorBasedOnClassName:(NSString *const)className
Parameters
className |
Mapped class name. |
---|
Return Value
TRUE: If entity descriptor exists, FALSE: If entity descriptor does not exists.
Discussion
Check whether entity descriptor object exists or not, based on mapped class name.
Declared In
SICDatabaseDescriptor.h
– getEntityDescriptorPaths
Get all entity descriptor paths as per defined in DatabaseDescriptor.core.xml file.
- (NSEnumerator *)getEntityDescriptorPaths
Return Value
Iterator which contain all entity descriptor paths.
Discussion
Get all entity descriptor paths as per defined in DatabaseDescriptor.core.xml file.
Declared In
SICDatabaseDescriptor.h
– addEntityDescriptorPath:
Add entity descriptor path as per defined in DatabaseDescriptor.xml file.
- (void)addEntityDescriptorPath:(NSString *const)entityDescriptorPath
Parameters
entityDescriptorPath |
Entity Descriptor Path. |
---|
Discussion
Add entity descriptor path as per defined in DatabaseDescriptor.xml file.
EXAMPLE:
<database-descriptor>
<entity-descriptors>
<entity-descriptor>Entity-Descriptors/Book.xml</entity-descriptor>
<entity-descriptor>Entity-Descriptors/Lession.xml</entity-descriptor>
</entity-descriptors>
</database-descriptor>
Declared In
SICDatabaseDescriptor.h
– getEntityDescriptors
Get all entity descriptor objects contained.
- (NSEnumerator *)getEntityDescriptors
Return Value
All entity descriptor objects.
Discussion
Get all entity descriptor objects contained.
Declared In
SICDatabaseDescriptor.h
– getEntityDescriptorBasedOnTableName:
Get entity descriptor object based on table name.
- (SICEntityDescriptor *)getEntityDescriptorBasedOnTableName:(NSString *const)tableName
Parameters
tableName |
Name of table. |
---|
Return Value
EntityDescriptor object based on table name.
Discussion
Get entity descriptor object based on table name.
Declared In
SICDatabaseDescriptor.h
– getEntityDescriptorBasedOnClassName:
Get entity descriptor object based on mapped class name.
- (SICEntityDescriptor *)getEntityDescriptorBasedOnClassName:(NSString *const)className
Parameters
className |
Mapped class name. |
---|
Return Value
Entity Descriptor object.
Discussion
Get entity descriptor object based on mapped class name.
Declared In
SICDatabaseDescriptor.h
– getEntityDescriptorBasedOnPath:
Get entity descriptor object based on path.
- (SICEntityDescriptor *)getEntityDescriptorBasedOnPath:(NSString *const)entityDescriptorPath
Parameters
entityDescriptorPath |
Entity Descriptor path as per defined in Database Descriptor.xml file. |
---|
Return Value
Entity Descriptor object.
Discussion
Get entity descriptor object based on path.
Declared In
SICDatabaseDescriptor.h
– addEntityDescriptor:entityDescriptor:
Add entity descriptor object in respect to entity descriptor path.
- (void)addEntityDescriptor:(NSString *const)entityDescriptorPath entityDescriptor:(SICEntityDescriptor *)entityDescriptor
Parameters
entityDescriptorPath |
Entity Descriptor Path. |
---|---|
entityDescriptor |
Entity Descriptor object. |
Discussion
Add entity descriptor object in respect to entity descriptor path.
Declared In
SICDatabaseDescriptor.h
– removeEntityDescriptorBasedOnPath:
Remove entity descriptor object based on entity descriptor path.
- (void)removeEntityDescriptorBasedOnPath:(NSString *const)entityDescriptorPath
Parameters
entityDescriptorPath |
Entity Descriptor Path. |
---|
Discussion
Remove entity descriptor object based on entity descriptor path.
Declared In
SICDatabaseDescriptor.h
– removeEntityDescriptorBasedOnClassName:
Remove entity descriptor object based on mapped class name.
- (void)removeEntityDescriptorBasedOnClassName:(NSString *const)className
Parameters
className |
Mapped class name. |
---|
Discussion
Remove entity descriptor object based on mapped class name.
Declared In
SICDatabaseDescriptor.h
– removeEntityDescriptorBasedOnTableName:
Remove entity descriptor object based on table name.
- (void)removeEntityDescriptorBasedOnTableName:(NSString *const)tableName
Parameters
tableName |
Name of table. |
---|
Discussion
Remove entity descriptor object based on table name.
Declared In
SICDatabaseDescriptor.h
– removeEntityDescriptor:
Remove entity descriptor object based on entity descriptor object.
- (void)removeEntityDescriptor:(SICEntityDescriptor *const)entityDescriptor
Parameters
entityDescriptor |
Entity Descriptor object which needs to be removed. |
---|
Discussion
Remove entity descriptor object based on entity descriptor object.
Declared In
SICDatabaseDescriptor.h
– orderedEntityDescriptors
Get all entity descriptor objects in sorted order. The order will be as per defined in DatabaseDescriptor.core.xml file.
- (NSEnumerator *)orderedEntityDescriptors
Return Value
Iterator which contains all entity descriptor objects.
Discussion
Get all entity descriptor objects in sorted order. The order will be as per defined in DatabaseDescriptor.core.xml file.
Declared In
SICDatabaseDescriptor.h
Other Methods
– getProperties
Get all the properties of descriptor
- (NSEnumerator *)getProperties
Return Value
All properties
Discussion
Get all the properties of descriptor
Declared In
SICIDescriptor.h
– getProperty:
Get the property value based on the property name
- (NSString *)getProperty:(NSString *)name
Parameters
name |
Name of the property |
---|
Return Value
Value of the property
Discussion
Get the property value based on the property name
Declared In
SICIDescriptor.h
– containProperty:
Check whether property exists or not
- (bool)containProperty:(NSString *)name
Parameters
name |
Name of the property |
---|
Return Value
(true/false) TRUE: If property exists | FALSE: If property does not exists.
Discussion
Check whether property exists or not
Declared In
SICIDescriptor.h
– addProperty:value:
Add property to the descriptor
- (void)addProperty:(NSString *)name value:(NSString *)value
Parameters
name |
Name of the property |
---|---|
value |
Value of the property |
Discussion
Add property to the descriptor
Declared In
SICIDescriptor.h
– removeProperty:
Remove property from the descriptor
- (void)removeProperty:(NSString *)name
Parameters
name |
Name of the property |
---|
Discussion
Remove property from the descriptor
Declared In
SICIDescriptor.h