Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

...


Page Properties
hiddentrue
idPlugin


SystemiShare Maps
Plugin

Dynamic DataSource

Available since
Status
subtletrue
colourGreen
title2018


Table of Contents
maxLevel4
printablefalse

...

DataSources are used to import non-spatial data into the dedicated iShare database in PostgreSQL and to integrate that data with iShare output in MyHouse My House and Publisher. This means that data is only ever as current as the last run of a scheduled task. As DataSources expect to retrieve the entirety of a given dataset, it also means that we have no way of retrieving data from sources that expose only a small subset of the data at any one time, e.g. a webservice which only returns data for a particular UPRN.

...

  • __init__
    • default class initiation - loads configuration file and applies override values, child classes should normally call this using super
  • _apply_overrides()
    • an 'internal' method that applies options from the Overrides section in the configuration file
    • sets 'internal' property values for the name, the display name and the identity options
  • test()
    • calls query(valuefield) using the values of the appropriate options from the Test section of the configuration file
  • id
    • loads the values of the identity options from the Settings section of the configuration file, combines with name to create a string which is used with generate_id(identify) class method to create a unique identifier for the class instance
  • name
    • returns value of __NAME or its override
  • display_name
    • returns value of __DISPLAY_NAME or its override
  • unique_field
    • returns the value of the unique_field option in the Settings section of the configuration file
NotImplemented

The following are defined as they are core to Dynamic Data Sources but raise NotImplementedError exceptions since they are always plugin specific.

...