LibraryDescriptor Class
Exposes methods to GET and SET Library Descriptor information as per define in LibraryDescriptor.xml file by application.
Example:
<!-- DESIGN OF LibraryDescriptor.xml -->
<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 -->
<!-- Database Mappings -->
<entity-descriptors>
<entity-descriptor>name_of_database_descriptor.full_path_of_database_mapping_descriptor_file</entity-descriptor>
</entity-descriptors>
<!-- Service Descriptors -->
<!-- Optional Field -->
<!-- Service Descriptor -->
<service-descriptors>
<service-descriptor>full_path_of_service-descriptor_file</service-descriptor>
</service-descriptors>
<!-- Sync Descriptors -->
<!-- Optional Field -->
<!-- Sync Descriptor -->
<sync-descriptors>
<sync-descriptor>full_path_of_sync_descriptor_file</sync-descriptor>
</sync-descriptors>
<!-- Adapter Descriptors -->
<!-- Optional Field -->
<!-- Adapter Descriptor -->
<adapter-descriptors>
<adapter-descriptor>full_path_of_adapter_descriptor_file</adapter-descriptor>
</adapter-descriptors>
</library-descriptor>
Item Index
Methods
addEntityDescriptorPath
-
entityDescriptorPath
Add entity 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>
Parameters:
-
entityDescriptorPath
StringEntity Descriptor Path.
addProperty
-
name
-
value
Add Property in property pool.
addServiceDescriptorPath
-
serviceDescriptorPath
Add service descriptor path
Parameters:
-
serviceDescriptorPath
StringService descriptor path
containProperty
-
name
Check whether Property exist or not.
Parameters:
-
name
StringName of Property.
Returns:
true/false, TRUE if property exist, FALSE if property does not exist.
getAdapterDescriptorPath
-
adapterDescriptorPath
Get adapter descriptor path
Parameters:
-
adapterDescriptorPath
StringAdapter Descriptor Path
getAdapterDescriptorPaths
-
Adapter
Get all adapter descriptor paths
Parameters:
-
Adapter
ArrayDescriptor Paths
getDescription
()
String
Get descriptor as per defined in LibraryDescriptor.xml
Returns:
Description of Library
getEntityDescriptorPaths
()
Array
Get all entity descriptor paths as per defined in DatabaseDescriptor.xml file.
Returns:
It contain all entity paths.
getProperties
()
Array
Get all Properties defined in descriptor.
Returns:
All Property Values.
getProperty
-
name
Get Property based on name provided.
Parameters:
-
name
StringName of Property.
Returns:
Property value.
getServiceDescriptorPaths
()
Array
Get all service descriptor paths
Returns:
Service Descriptor Paths
removeProperty
-
name
Remove Property from property pool.
Parameters:
-
name
StringName of Property.
setDescription
-
descriptor
Set description as per defined in LibraryDescritor.core.xml
Parameters:
-
descriptor
StringDescription of Library
setName
-
name
Set library name as per defined in LibraryDescriptor.xml
Parameters:
-
name
StringName of Library