Class RQLStore<ItemType, IDType>

RQL Store is a RestStore which uses the RQL language as query language. RQL stands for REST Query Language and is a simple filter expression language used by backend services of map.apps. E.g. AppService, AppTemplateService, ReportingService and JSRegistryBundlesServices is using this filter language. The RQLStore transforms the ComplexQueryExpressions into RQL filter expressions.

Type Parameters

  • ItemType extends {}
  • IDType extends string | number

Hierarchy (View Summary)

Constructors

constructor

Properties

accepts filterParam headers id idProperty itemProperty metadata rangeParam sortParam supportsPostSwitching target totalProperty _metadata

Methods

add get getIdentity getMetadata put query remove _appendQueryToRequest _appendRangeToRequest _appendSortToRequest _executeRequest _filterMetadata _filterParams _getMetadata _processQueryResponse

Constructors

constructor

Properties

accepts

accepts: string = "application/javascript, application/json"

Defines the Accept header to use on HTTP requests

filterParam

filterParam: string = "filter"

The filter param transporting the query.

headers

headers: {} = {}

Additional headers to pass in all requests to the server. These can be overridden by passing additional headers to calls to the store.

id

id: string = ""

The id of this store.

idProperty

idProperty: string = "id"

Indicates the property to use as the identity property. The values of this property should be unique.

itemProperty

itemProperty: string = "items"

Identifies the item array in query responses

metadata

metadata: undefined | Partial<Metadata> = undefined

Configuration option for getMetadata method.

rangeParam

rangeParam: string = "range"

Range parameter transporting item range definitions.

sortParam

sortParam: string = "sort"

The query parameter to used for holding sort information. If this is omitted, than the sort information is included in a functional query token to avoid colliding with the set of name/value pairs.

supportsPostSwitching

supportsPostSwitching: boolean = true

Flag which indicates that an switching to POST is allowed when GET requests are to long. This is true by default for backwards compatibility.

target

target: string = ""

The target base URL to use for all requests to the server. This string will be prepended to the id to generate the URL (relative or absolute) for requests sent to the server

totalProperty

totalProperty: string = "total"

Identifies the total property in query responses

Protected_metadata

_metadata: undefined | Partial<Metadata> = undefined

Property for sub classes which provide static pre-configured metadata template.

Methods

add

  • add(
        item: Partial<ItemType>,
        options?: CreateOptions<IDType> & RequestOptions,
    ): Promise<ItemType>

  • Adds an object. This will trigger a POST request to the server if the object has no id. If it has an id a PUT request is executed. It is much the same as the put method. You can suppress the switching to put by marking the id as undefined in the options.

    Parameters

    Returns Promise<ItemType>

    Example

    const item = { id: 1, name : "hello"};
    // this will still execute a POST request
    store.add(item, {id: undefined});

get

getIdentity

  • getIdentity(item: Partial<ItemType>): undefined | IDType

  • Gets identity of given item.

    Parameters

    • item: Partial<ItemType>

      an item of this store.

    Returns undefined | IDType

    id or undefined if no id is found.

getMetadata

put

query

remove

Protected_appendQueryToRequest

  • _appendQueryToRequest(
        requestParameters: Record<string, any>,
        query: undefined | ComplexQueryExpression,
        options: QueryOptions,
    ): void

  • Hook for subclasses to convert ComplexQueryExpression into request parameters.

    Parameters

    Returns void

Protected_appendRangeToRequest

  • _appendRangeToRequest(
        requestParameters: InternalRequestOptions,
        options: QueryOptions,
    ): void

  • Converts the options.start and options.count values to request parameters. By default the headers "Range" and "X-Range" are calculated and the request parameter 'range' is added. A range is an string like '5..20' == ${start}-${start+count-1}.

    Parameters

    • requestParameters: InternalRequestOptions

      request parameters will be changed

    • options: QueryOptions

      the query options, with start + count.

    Returns void

Protected_appendSortToRequest

  • _appendSortToRequest(
        requestParameters: InternalRequestOptions,
        options: QueryOptions,
    ): void

  • Converts the options.sort to request parameters. By default the sort options are converted into 'sort' request parameter, like '-id,+name,+title'.

    Parameters

    • requestParameters: InternalRequestOptions

      request parameters to change.

    • options: QueryOptions

      the query options.

    Returns void

Protected_executeRequest

  • _executeRequest<T>(method: string, options: InternalRequestOptions): Promise<T>

  • Helper method which checks the query options and delegates to fetch.

    Type Parameters

    • T

    Parameters

    • method: string

      http method to execute.

    • options: InternalRequestOptions

      the request options.

    Returns Promise<T>

    result of the request.

Protected_filterMetadata

Protected_filterParams

  • _filterParams(
        invokedFromMethod: string,
        requestParameters: InternalRequestOptions,
        originalMethodParameters: MethodParameters<ItemType, IDType>,
    ): InternalRequestOptions

  • Hook for sub classes to add/change request parameters.

    Parameters

    Returns InternalRequestOptions

Protected_getMetadata

  • _getMetadata(): Partial<Metadata> | Promise<Partial<Metadata>>

  • Overwrite this method to provide your own metadata! The method can return Promises! Here you can implement http requests to dynamically resolve metadata.

    Returns Partial<Metadata> | Promise<Partial<Metadata>>

Protected_processQueryResponse

  • _processQueryResponse(result: Record<string, any>): ResultItems<ItemType>

  • Transforms server responses into ResultItems<T>. The default implementation expects a server response of this format:

     {
       total : <count>,
       items: [...]
     }

    Parameters

    • result: Record<string, any>

      json server response

    Returns ResultItems<ItemType>

    ResultItems.

Settings

Member Visibility

On This Page

Constructors
Properties
Methods