FrameTrail API Docs

  • for FrameTrail Version: 0.8.1

    • Modules & Types

    Show:

    Database Module

    Defined in: frametrail/_shared/modules/Database/module.js:5
    Module: Shared

    I am the Database. I store all data coming from the server. The data model objects (like HypervideoModel) get their data from me. When they are done with manipulating the data, I can store the data back to the server.

    Note: All data objects inside me must be passed by reference, so that data can be manipulated in place, and insertions and deletions should alter immediatly the database. In this way, data is kept consistent across the app (see Annotation/FrameTrail.newObject:method).

    Methods

    getIdOfHypervideo

    (
    • data
    )

    Defined in frametrail/_shared/modules/Database/module.js:881

    I search the hypervideo database for a given data object and return its id.

    Parameters:

    Returns:

    String or null

    getIdOfResource

    (
    • resourceData
    )

    Defined in frametrail/_shared/modules/Database/module.js:863

    I search the resource database for a given data object and return its id.

    Parameters:

    Returns:

    String or null

    loadAnnotationData

    (
    • success
    • fail
    )
    private

    Defined in frametrail/_shared/modules/Database/module.js:322

    I load the annotation data (../_data/projects/ RouteNavigation/projectID /hypervideos/ RouteNavigation/hypervideoID /hypervideo.json) from the server and save the data in my attribute Database/annotations, and the respective annotationfileIDs in my attribute Database/annotationfileIDs,

    I call my success or fail callback respectively.

    Parameters:

    loadData

    (
    • success
    • fail
    )

    Defined in frametrail/_shared/modules/Database/module.js:487

    I initialise the load process of the database

    First I look for the RouteNavigation/projectID and RouteNavigation/hypervideoID.

    Then I call the nested load functions to fetch all data from the server. I call my success or fail callback respectively.

    Parameters:

    loadHypervideoData

    (
    • success
    • fail
    )
    private

    Defined in frametrail/_shared/modules/Database/module.js:183

    I load the hypervideo index data (../_data/projects/ RouteNavigation/projectID /hypervideos/_index.json) from the server and save the data in my attribute Database/hypervideos. I call my success or fail callback respectively.

    Parameters:

    loadLinksData

    (
    • success
    • fail
    )
    private

    Defined in frametrail/_shared/modules/Database/module.js:288

    I load the video link data (../_data/projects/ RouteNavigation/projectID /hypervideos/ RouteNavigation/hypervideoID /hypervideo.json) from the server and save the data in my attribute Database/links. I call my success or fail callback respectively.

    Parameters:

    loadOverlayData

    (
    • success
    • fail
    )
    private

    Defined in frametrail/_shared/modules/Database/module.js:253

    I load the overlay data (../_data/projects/ RouteNavigation/projectID /hypervideos/ RouteNavigation/hypervideoID /hypervideo.json) from the server and save the data in my attribute Database/overlays. I call my success or fail callback respectively.

    Parameters:

    loadProjectData

    (
    • success
    • fail
    )
    private

    Defined in frametrail/_shared/modules/Database/module.js:44

    I load the project index data (../_data/projects/_index.json) from the server and save the data for my projectID (from RouteNavigation/projectID) in my attribute Database/project. I call my success or fail callback respectively.

    Parameters:

    loadResourceData

    (
    • success
    • fail
    )

    Defined in frametrail/_shared/modules/Database/module.js:85

    I load the resource index data (../_data/projects/ RouteNavigation/projectID /resources/_index.json) from the server and save the data in my attribute Database/resources. I call my success or fail callback respectively.

    Parameters:

    loadSequenceData

    (
    • success
    • fail
    )
    private

    Defined in frametrail/_shared/modules/Database/module.js:218

    I load the hypervideo sequence data (../_data/projects/ RouteNavigation/projectID /hypervideos/ RouteNavigation/hypervideoID /hypervideo.json) from the server and save the data in my attribute Database/hypervideos. I call my success or fail callback respectively.

    Parameters:

    loadSubtitleData

    (
    • success
    • fail
    )
    private

    Defined in frametrail/_shared/modules/Database/module.js:390

    I load the subtitles data (../_data/projects/ RouteNavigation/projectID /hypervideos/ RouteNavigation/hypervideoID /subtitles/...) from the server and save the data in my attribute Database/subtitles:attribute

    I call my success or fail callback respectively.

    Parameters:

    loadUserData

    (
    • success
    • fail
    )

    Defined in frametrail/_shared/modules/Database/module.js:118

    I load the user.json of the current project from the server and save the data in my attribute Database/users. I call my success or fail callback respectively.

    Parameters:

    saveAnnotations

    (
    • callback
    )

    Defined in frametrail/_shared/modules/Database/module.js:771

    I save the annotation data back to the server.

    I choose by myself the appropriate server method ($_POST["action"]: "save" or "saveAs") wether the user's annotation file does already exist, or has to be created.

    My success callback gets one argument, which is either

    { success: true }

    or

    { failed: 'annotations', error: ... }

    Parameters:

    saveOverlays

    (
    • callback
    )

    Defined in frametrail/_shared/modules/Database/module.js:650

    I save the overlay data back to the server.

    My success callback gets one argument, which is either

    { success: true }

    or

    { failed: 'overlays', error: ... }

    Parameters:

    updateHypervideoData

    (
    • success
    • fail
    )

    Defined in frametrail/_shared/modules/Database/module.js:599

    I update the hypervideo data inside the database

    Parameters:

    Attributes

    annotationfileIDs

    Defined in frametrail/_shared/modules/Database/module.js:951

    I store the file IDs of the user's annotation sets.

    The server manages file names automatically without influence of the client. That is why the client has to remeber the file ID of the several sets of annotations, which belong to a single user.

    {
  "userID": "fileID"
}

    annotations

    Defined in frametrail/_shared/modules/Database/module.js:938

    I store the annotation data (from all json files from the server's ../_data/projects//hypervideos//annotationfiles/).

    I am a map of keys (userIDs) to an array of all annotations from that user.

    {
    "userID": [ annotationData, annotationData, ... ]
}

    annotations

    Defined in frametrail/_shared/modules/Database/module.js:965

    I store the subtitle data (from all .vtt files from the server's ../_data/projects//hypervideos//subtitles/).

    hypervideo

    Defined in frametrail/_shared/modules/Database/module.js:913

    I store the hypervideo index data for the current hypervideo

    hypervideos

    Defined in frametrail/_shared/modules/Database/module.js:908

    I store the hypervideo index data (from the server's ../_data/projects//hypervideos/_index.json)

    overlays

    Defined in frametrail/_shared/modules/Database/module.js:927

    I store the overlays data (from the server's ../_data/projects//hypervideos//overlays.json)

    project

    Defined in frametrail/_shared/modules/Database/module.js:902

    I store the project index data (from the server's ../_data/projects/_index.json)

    resources

    Defined in frametrail/_shared/modules/Database/module.js:979

    I store the resource index data (from the server's ../_data/projects//resources/_index.json)

    sequence

    Defined in frametrail/_shared/modules/Database/module.js:922

    I store the hypervideo sequence data (from the server's ../_data/projects//hypervideos//hypervideo.json)

    subtitlesLangMapping

    Defined in frametrail/_shared/modules/Database/module.js:972

    I store a map of subtitle language codes and labels.

    users

    Defined in frametrail/_shared/modules/Database/module.js:985

    I store the user data (from the projects user.json). The keys are the userIDs, and the values are maps of the user's attributes.