SICLibraryDescriptor Class Reference

Inherits from	NSObject
Conforms to	SICIDescriptor
Declared in	SICLibraryDescriptor.h SICLibraryDescriptor.m

Overview

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

Example:

 <library-descriptor>

     <!-- General Properties Of Library -->

     <!-- Mandatory Field -->
     <property name="name">name_of_library</property>

     <!-- Optional Field -->
     <property name="description">description_of_library</property>



     <!-- Entity Descriptor Needed Under This Library Descriptor -->

     <!-- Optional Field -->
        <!-- Entity Descriptor Descriptors -->
     <entity-descriptors>
        <entity-descriptor>name_of_database_descriptor.full_path_of_entity_descriptor_file</entity-descriptor>
     </entity-descriptors>

</library-descriptor>

Other Methods

`– getName`

Get library name.

- (NSString *)getName

Discussion

Get library name.

Declared In

SICLibraryDescriptor.h

`– setName:`

Set library name as per defined in LibraryDescriptor.core.xml

- (void)setName:(NSString *const)name

Parameters

`name`	Name of Library.

Discussion

Set library name as per defined in LibraryDescriptor.core.xml

Declared In

SICLibraryDescriptor.h

`– getDescription`

Get descriptor as per defined in LibraryDescriptor.core.xml @return

- (NSString *)getDescription

Discussion

Get descriptor as per defined in LibraryDescriptor.core.xml @return

Declared In

SICLibraryDescriptor.h

`– setDescription:`

Set description as per defined in LibraryDescritor.core.xml

- (void)setDescription:(NSString *const)description

Parameters

`description`	Description of Library.

Discussion

Set description as per defined in LibraryDescritor.core.xml

Declared In

SICLibraryDescriptor.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

SICLibraryDescriptor.h

`– containsEntityDescriptorBasedOnClassName:`

Check whether entity descriptor object exists or not, based on POJO 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 POJO class name.

Declared In

SICLibraryDescriptor.h

`– getEntityDescriptorPaths`

Get all entity descriptor paths as per defined in DatabaseDescriptor.xml file.

- (NSEnumerator *)getEntityDescriptorPaths

Return Value

Iterator which contain all entity descriptor paths.

Discussion

Get all entity descriptor paths as per defined in DatabaseDescriptor.xml file.

Declared In

SICLibraryDescriptor.h

`– addEntityDescriptorPath:`

Add entity descriptor path as per defined in DatabaseDescriptor.core.xml file.

- (void)addEntityDescriptorPath:(NSString *const)entityDescriptorPath

Parameters

`entityDescriptorPath`	Entity Descriptor Path.

Discussion

Add entity descriptor path as per defined in DatabaseDescriptor.core.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

SICLibraryDescriptor.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

SICLibraryDescriptor.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

SICLibraryDescriptor.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

SICLibraryDescriptor.h

`– getEntityDescriptorBasedOnPath:`

Get entity descriptor object based on path.

- (SICEntityDescriptor *)getEntityDescriptorBasedOnPath:(NSString *const)libraryEntityDescriptorPath

Parameters

`libraryEntityDescriptorPath`	Library Database path as per defined in Database Descriptor.xml file.

Return Value

Entity Descriptor object.

Discussion

Get entity descriptor object based on path.

Declared In

SICLibraryDescriptor.h

`– addEntityDescriptor:entityDescriptor:`

Add entity descriptor object in respect to entity descriptor path.

- (void)addEntityDescriptor:(NSString *const)libraryEntityDescriptorPath entityDescriptor:(SICEntityDescriptor *const)entityDescriptor

Parameters

`libraryEntityDescriptorPath`	Library Entity Descriptor Path.
`entityDescriptor`	Entity Descriptor object.

Discussion

Add entity descriptor object in respect to entity descriptor path.

Declared In

SICLibraryDescriptor.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

SICLibraryDescriptor.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

SICLibraryDescriptor.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

SICLibraryDescriptor.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

SICLibraryDescriptor.h

`– orderedEntityDescriptors`

Get all entity descriptor objects in sorted order. The order will be as per defined in DatabaseDescriptor.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.xml file.

Declared In

SICLibraryDescriptor.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