Siminov Hybrid Siminov Hybrid

  • API Docs for Version: 2.0

    • APIs

    Show:

    DatabaseDescriptor Class

    Defined in: /private/var/user/Documents/App/Hybrid/JavaScript/Siminov/Model/DatabaseDescriptor.js:49
    Module: Model

    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>

    Methods

    addEntityDescriptorPath

    (
    • entityPath
    )

    Defined in /private/var/user/Documents/App/Hybrid/JavaScript/Siminov/Model/DatabaseDescriptor.js:260

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

        EXAMPLE:
                                                    <database-descriptor>
                                                        <entity-descriptor>
                                                            <entity-descriptor>Entity-Descriptors/Book.xml</entity-descriptor>
                                                            <entity-descriptor>Entity-Descriptors/Lession.xml</entity-descriptor>
                                                        </entity-descriptor>
                                                    </database-descriptor>

    Parameters:

    • entityPath Object

      Entity Descriptor Path.

    addProperty

    (
    • name
    • value
    )

    Defined in /private/var/user/Documents/App/Hybrid/JavaScript/Siminov/Model/DatabaseDescriptor.js:227

    Add Property in property pool.

    Parameters:

    • name String

      Name of Property.

    • value String

      value of Property.

    containProperty

    (
    • name
    )
    Boolean

    Defined in /private/var/user/Documents/App/Hybrid/JavaScript/Siminov/Model/DatabaseDescriptor.js:215

    Check whether Property exist or not.

    Parameters:

    • name String

      Name of Property.

    Returns:

    Boolean:

    true/false, TRUE if property exist, FALSE if property does not exist.

    getDatabaseName

    () String

    Defined in /private/var/user/Documents/App/Hybrid/JavaScript/Siminov/Model/DatabaseDescriptor.js:102

    Get database descriptor name as defined in DatabaseDescriptor.xml file.

    Returns:

    String:

    Database Descriptor Name.

    getDescription

    () String

    Defined in /private/var/user/Documents/App/Hybrid/JavaScript/Siminov/Model/DatabaseDescriptor.js:122

    Get description as per defined in DatabaseDescriptor.xml file.

    Returns:

    String:

    Description defined in DatabaseDescriptor.xml file.

    getEntityDescriptorPaths

    () Array

    Defined in /private/var/user/Documents/App/Hybrid/JavaScript/Siminov/Model/DatabaseDescriptor.js:250

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

    Returns:

    Array:

    It contain all entity descriptor paths.

    getProperties

    () Array

    Defined in /private/var/user/Documents/App/Hybrid/JavaScript/Siminov/Model/DatabaseDescriptor.js:192

    Get all Properties defined in descriptor.

    Returns:

    Array:

    All Property Values.

    getProperty

    (
    • name
    )
    String

    Defined in /private/var/user/Documents/App/Hybrid/JavaScript/Siminov/Model/DatabaseDescriptor.js:203

    Get Property based on name provided.

    Parameters:

    • name String

      Name of Property.

    Returns:

    String:

    Property value.

    isExternalStorage

    () Boolean

    Defined in /private/var/user/Documents/App/Hybrid/JavaScript/Siminov/Model/DatabaseDescriptor.js:181

    Check whether database needs to be stored on SDCard or not.

    Returns:

    Boolean:

    (true/false) TRUE: If external_storage defined as true in DatabaseDescriptor.xml file, FALSE: If external_storage defined as false in DatabaseDescritor.xml file.

    isLockingRequired

    () Boolean

    Defined in /private/var/user/Documents/App/Hybrid/JavaScript/Siminov/Model/DatabaseDescriptor.js:161

    Check whether database transactions to make multi-threading safe or not.

    Returns:

    Boolean:

    (true/false) 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.

    removeProperty

    (
    • name
    )

    Defined in /private/var/user/Documents/App/Hybrid/JavaScript/Siminov/Model/DatabaseDescriptor.js:239

    Remove Property from property pool.

    Parameters:

    • name String

      Name of Property.

    setDatabaseName

    (
    • databaseName
    )

    Defined in /private/var/user/Documents/App/Hybrid/JavaScript/Siminov/Model/DatabaseDescriptor.js:112

    Set database descriptor name as per defined in DatabaseDescriptor.xml file.

    Parameters:

    • databaseName String

      Database Descriptor Name.

    setDescription

    (
    • description
    )

    Defined in /private/var/user/Documents/App/Hybrid/JavaScript/Siminov/Model/DatabaseDescriptor.js:132

    Set description as per defined in DatabaseDescritor.xml file.

    Parameters:

    • description String

      Description defined in DatabaseDescriptor.xml file.

    setExternalStorage

    (
    • isExternalStorageEnable
    )

    Defined in /private/var/user/Documents/App/Hybrid/JavaScript/Siminov/Model/DatabaseDescriptor.js:171

    Set the external storage value as per defined in DatabaseDescriptor.xml file.

    Parameters:

    • isExternalStorageEnable Boolean

      (true/false) External Storage Enable Or Not.

    setLockingRequired

    (
    • isLockingRequired
    )

    Defined in /private/var/user/Documents/App/Hybrid/JavaScript/Siminov/Model/DatabaseDescriptor.js:151

    Set database locking as per defined in DatabaseDescriptor.xml file.

    Parameters:

    • isLockingRequired Boolean

      (true/false) database locking as per defined in DatabaseDescriptor.xml file.