Class DataModelRepository<T>

Type Parameters

Hierarchy (View Summary)

Constructors

constructor

Properties

bind idGenerator listenTo listenToOnce objects objectType off on once stopListening unbind

Methods

_triggerChangedID changed changeObjectID clear endBatchingEvents generateUniqueID getByIds getModifiedObjects getObjectArray getObjectById getObjectType getRepositoryName hasModifiedObjects isActive mergeObjectAttributes mergeObjects put remove setActive startBatchingEvents stateDeleted synced trigger

Constructors

constructor

Properties

bind

bind: {
    (eventName: string, callback: EventHandler, context?: any): this;
    (eventMap: EventMap, context?: any): this;
} = Backbone.Events.bind

idGenerator

idGenerator: IDGenerator

listenTo

listenTo: {
    (object: any, events: string, callback: EventHandler): this;
    (object: any, eventMap: EventMap): this;
} = Backbone.Events.listenTo

listenToOnce

listenToOnce: {
    (object: any, events: string, callback: EventHandler): this;
    (object: any, eventMap: EventMap): this;
} = Backbone.Events.listenToOnce

objects

objects: { [key: string]: T }

objectType

objectType: DataModelObjectType

off

off: (eventName?: string, callback?: EventHandler, context?: any) => this = Backbone.Events.off

on

on: {
    (eventName: string, callback: EventHandler, context?: any): this;
    (eventMap: EventMap, context?: any): this;
} = Backbone.Events.on

once

once: {
    (events: string, callback: EventHandler, context?: any): this;
    (eventMap: EventMap, context?: any): this;
} = Backbone.Events.once

stopListening

stopListening: (object?: any, events?: string, callback?: EventHandler) => this = Backbone.Events.stopListening

unbind

unbind: (eventName?: string, callback?: EventHandler, context?: any) => this = Backbone.Events.unbind

Methods

_triggerChangedID

changed

  • changed(object: T | T[]): void

    Parameters

    • object: T | T[]

    Returns void

changeObjectID

  • changeObjectID(object: T, newID: ObjectId): void

    Parameters

    Returns void

clear

  • clear(editingMediator: EditingMediator, options: ClearOptions): void

    Clears all information kept in the model, optionally including unsaved changes.

    Parameters

    • editingMediator: EditingMediator
    • options: ClearOptions

      uses the following properties

      • keepSelected: boolean
      • keepUnsaved: boolean
      • Optionalsilent?: boolean

    Returns void

endBatchingEvents

generateUniqueID

  • generateUniqueID(): number

    Returns number

getByIds

getModifiedObjects

  • getModifiedObjects(): ModifiedObjects<T>

    Returns all modified objects in the repository according to their state (INSERT, UPDATE, DELETE).

    Returns ModifiedObjects<T>

    the modified objects, by their state

getObjectArray

  • getObjectArray(
        predicate?: (value: T, index: number, array: T[]) => boolean,
    ): T[]

    Retrieves an array of the objects satisfying a given predicate. If no predicate is given, all objects are returned.

    Parameters

    • Optionalpredicate: (value: T, index: number, array: T[]) => boolean

      a predicate function that receives the object and returns a boolean indicating whether or not this object should be retrieved.

    Returns T[]

    an array of all objects satisfying the predicate.

getObjectById

getObjectType

getRepositoryName

hasModifiedObjects

  • hasModifiedObjects(): boolean

    Returns boolean

    if there is at least one modified object in the model.

isActive

  • isActive(): boolean

    Returns boolean

mergeObjectAttributes

mergeObjects

  • mergeObjects(
        mergeObjects: { objects: T[] },
        options: { areObjectsInBbox: boolean },
    ): void

    Merges an array of objects into the repository. Objects that are not in the repository or with a newer version are added if there are not marked as changed in the repository. For objects changed in the repository, but received a new version, a conflict resolution policy is applied.

    Parameters

    • mergeObjects: { objects: T[] }

      the new objects to put in the repository.

    • options: { areObjectsInBbox: boolean }

      contains extra flags used to merge the objects

      • areObjectsInBbox: boolean

        true if objects came from bbox response

    Returns void

put

  • put(objectOrObjects: T | T[]): void

    Parameters

    • objectOrObjects: T | T[]

    Returns void

remove

  • remove(object: T | T[]): void

    Parameters

    • object: T | T[]

    Returns void

setActive

  • setActive(active: boolean): void

    Parameters

    • active: boolean

    Returns void

startBatchingEvents

stateDeleted

  • stateDeleted(object: T | T[]): void

    Parameters

    • object: T | T[]

    Returns void

synced

  • synced(object: T | T[]): void

    Parameters

    • object: T | T[]

    Returns void

trigger

  • trigger(eventName: string, ...args: unknown[]): this

    Parameters

    • eventName: string
    • ...args: unknown[]

    Returns this

Settings

Member Visibility

On This Page

Constructors
Properties
Methods