Skip to content

API Reference

Jump to bottom
Milan P. Antonovic edited this page Aug 22, 2016 · 1 revision

Classes, properties, methods

###istsos.IstSOS class

@constructor
new istsos.IstSOS()

#####properties:

* servers {Array<istsos.Server>}

#####methods:

* addServer(server {istsos.Server})
* updateServer(
      old_name {String}, 
      new_name {String},
      new_url {String},
      new_config {istsos.Configuration},
      new_defaultDb {istsos.Database} 
     )
* removeServer(name {String})
* getServer(name {String})
      ==================================
      RETURNS:: {istsos.Server}
  ======================================
* getServerList()
      ==================================
      RETURNS:: {Array<istsos.Server>}
  ======================================

###istsos.Server class

@constructor
@params
new istsos.Server(
                serverName {String}, 
                url {String}, 
                defaultDb {istsos.Database}, 
                opt_config {istsos.Config}, 
                opt_loginConfig {JSON}
)

#####properties:

* serverName {String}
* url {String}
* defaultDb {istsos.Database}
* opt_config {istsos.Configuration} /* optional (if empty, instance of istsos.Configuration is created with
                                                                                           defualt config) */
* opt_loginConfig {JSON} // optional (if empty, empty object is created 
* services {Array<istsos.Service>}

#####methods:

* executeRequest(
    url {String}
    eventType {istsos.events.EventType}
    method {String}
    opt_data {JSON} /* optional (for POST/PUT/DELETE
                                requests required) */                            
)
* addService(service {istsos.Service})
* registerService(service {istsos.Service})
      ================================== 
      AJAX request|POST
      FIRES:: istsos.events.EventType: NEW_SERVICE
  ======================================
* deleteService(service {istsos.Service})
      ==================================
      AJAX request|DELETE
      FIRES:: istsos.events.EventType: DELETE_SERVICE
  ======================================
* getService(service {istsos.Service})
      ==================================
      AJAX request|GET
      FIRES:: istsos.events.EventType: SERVICE
  ======================================
* getServices()
      ==================================
      AJAX request|GET
      FIRES:: istsos.events.EventType: SERVICES
  ======================================
* getServicesProperty()
      ==================================
      RETURNS:: {Array<istsos.Service>}
  ======================================
* getStatus()
      ==================================
      AJAX request|GET
      FIRES:: istsos.events.EventType: STATUS
  ======================================
* getAboutInfo()
      ==================================
      AJAX request|GET
      FIRES:: istsos.events.EventType: ABOUT
  ======================================
* getConfig()
      ==================================
      AJAX request|GET
      FIRES:: istsos.events.EventType: CONFIGURATION
  ======================================
* getConfigProperty()
      ==================================
      RETURNS:: {Array<istsos.Configuration>}
  ======================================
* getDefaultDbProperty()
      ==================================
      RETURNS:: {Array<istsos.Database>}
  ======================================
* getDefaultDb()
      ==================================
      AJAX request|GET
      FIRES:: istsos.events.EventType: DATABASE
  ======================================
* getUrl()
      ==================================
      RETURNS:: {Array<istsos.Service>}
  ======================================

###istsos.Database class

@constructor
@params
new istsos.Database(
            dbname {String}
            host {String}
            user {String}
            password {String}
            port {integer}
)

#####properties:

* dbname {String}
* host {String}
* user {String}
* password {String}
* port {integer}

#####methods:

* executeRequest(
      url {String}
      eventType {istsos.events.EventType}
      method {String}
      opt_data {JSON} // optional (for POST/PUT/DELETE requests required)                          
     )
* getDb( 
      serviceName {String}
      server {istsos.Server}
     )
      ==================================
      AJAX request|GET
      FIRES:: istsos.events.EventsType: DATABASE
========================================
* setDb(
      dbname {String}
      host {String}
      user {String}
      passwrod {String}
      port {integer}
      server {istsos.Server}
      opt_service {istsos.Service} // optional (if not provided 'default' value will be set
     )
      ==================================
      AJAX request|PUT
      FIRES:: istsos.events.EventsType: UPDATE_DATABASE
========================================
* validateDb({istsos.Server})
      ==================================
      AJAX request|POST
      FIRES:: istsos.events.EventsType: VALIDATE_DB
========================================
* getDbJSON()
      ==================================
      RETURNS:: {JSON}
========================================

###istsos.Configuration class

@constructor
@params
new istsos.Configuration(
            serviceName {String}
            server {istsos.Server}

#####properties:

* sname {String}
* serverUrl {String}

#####methods:

* executeRequest(
      url {String}
      eventType {istsos.events.EventType}
      method {String}
      opt_data {JSON} /* optional (for POST/PUT/DELETE requests required) */                            
)
* getConf()
      ================================== 
      AJAX request|GET
      FIRES:: istsos.events.EventType: CONFIGURATION
  ======================================
* getProvider()
      ================================== 
      AJAX request|GET
      FIRES:: istsos.events.EventType: PROVIDER
  ======================================
* updateProvider(
      providerName {String}
      providerSite {String}
      contactName {String}
      contactPosition {String}
      contactVoice {String}
      contactFax {String}
      contactEmail {String}
      contactDeliveryPoint {String}
      contactPostalCode {String}
      contactCity {String}
      contactAdminArea {String}
      contactCountry {String}
     )
      ================================== 
      AJAX request|PUT
      FIRES:: istsos.events.EventType: UPDATE_PROVIDER
  ======================================
* getIdentification()
      ================================== 
      AJAX request|GET
      FIRES:: istsos.events.EventType: IDENTIFICATION
  ======================================
* updateIdentification( //AJAX request|PUT
      title {String}
      abstract {String}
      urnVersion {String}
      authority {String}
      fees {String}
      keywords {String}
      accessConstrains {String}   
     )
     ================================== 
      AJAX request|GET
      FIRES:: istsos.events.EventType: UPDATE_IDENTIFICATION
  ======================================
* getMqtt()
      ================================== 
      AJAX request|GET
      FIRES:: istsos.events.EventType: MQTT
  ======================================
* updateMqtt(
      brokerPassword {String}
      brokerUser {String}
      brokerTopic {String}
      brokerUrl {String}
      brokerPort {String}
     )
      ================================== 
      AJAX request|PUT
      FIRES:: istsos.events.EventType: UPDATE_MQTT
  ======================================
* getCrs()
      ================================== 
      AJAX request|GET
      FIRES:: istsos.events.EventType: CRS
  ======================================
* updateCrs(
      z_axis_name {String}
      x_axis_name {String}
      y_axis_name {String}
      allowedEpsg {String}
      istsosEpsg {String}
     )
      ================================== 
      AJAX request|PUT
      FIRES:: istsos.events.EventType: UPDATE_CRS
  ======================================
* getObservationConf()
      ================================== 
      AJAX request|GET
      FIRES:: istsos.events.EventType: OBSERVATION_CONF
  ======================================
* updateObservationConf(
      correctQi {String}
      statQi {String}
      defaultQi {String}
      aggregateNoDataQi {String}
      maxGoPeriod {String}
      transactionalLog {String}
      aggregateNoData {String}    
     )
      ================================== 
      AJAX request|PUT
      FIRES:: istsos.events.EventType: UPDATE_OBSERVATION_CONF
  ======================================
* getProxy()
      ================================== 
      AJAX request|GET
      FIRES:: istsos.events.EventType: PROXY
  ======================================
* updateProxy(
      newUrl {String}
     )
      ================================== 
      AJAX request|PUT
      FIRES:: istsos.events.EventType: UPDATE_PROXY
  ======================================
* getEpsgCodes()
      ================================== 
      AJAX request|GET
      FIRES:: istsos.events.EventType: EPSG_CODES
  ======================================

###istsos.Date class

@constructor
@params
new istsos.Date(
        year {integer}
        month {integer}
        day {integer}
        hours {integer}
        minutes {integer}
        seconds {integer}
        gmt {integer}
        opt_descr {String}
)

#####properties:

* year {String}
* month {String}
* day {String}
* hours {String}
* minutes {String}
* seconds {String}
* gmt {String}
* description {String} /* optional (if not provided, default text will be set) */

#####methods:

* getDescription()
      ================================== 
      RETURNS:: {String}
  ======================================
* getDateString()
      ================================== 
      RETURNS:: {String}
  ======================================

###istsos.Service class

@constructor
@params
new istsos.Service(
        server {istsos.Server}
        serviceName {String}
        opt_db {istsos.Database} // if not provided, default is set
        opt_config {istsos.Config} // if not provided, default is set
        opt_epsg {integer} // if not provided, default is set
)

#####properties:

* serviceName {String}
* db {istsos.Database}
* epsg {int}
* config {istsos.Configuration}
* server {istsos.Server}
* offerings {Array<istsos.Offering>}
* procedures {Array<istsos.Procedure>}
* virtualProcedures {Array<istsos.VirtaulProcedure>}
* observedProperties {Array<istsos.ObservedProperty>}
* uoms {Array<istsos.UnitOfMeasure>}
* dataQualities {Array<istsos.DataQuality>}

#####methods:

* executeRequest(
      url {String}
      eventType {istsos.events.EventType}
      method {String}
      opt_data {JSON} /* optional (for POST/PUT/DELETE requests required) */                            
)
* getServiceJSON()
      ================================== 
      RETURNS:: {JSON}
  ======================================
* getOfferingsProperty()
      ================================== 
      RETURNS:: {Array<istsos.Offering>}
  ======================================
* getProceduresProperty()
      ================================== 
      RETURNS:: {Array<istsos.Procedure>}
  ======================================
* getVirtualProcedures()
      ================================== 
      RETURNS:: {Array<istsos.VirtualProcedure>}
  ======================================
* getObservedPropertiesProperty()
      ================================== 
      RETURNS:: {Array<istsos.ObservedProperty>}
  ======================================
* getUomsProperty()
      ================================== 
      RETURNS:: {Array<istsos.UnitOfMeasure>}
  ======================================
* getDataQualitiesProperty()
      ================================== 
      RETURNS:: {Array<istsos.DataQuality>}
  ======================================
* addOffering(offering {istsos.Offering})
* registerOffering(offering {istsos.Offering})
      ================================== 
      AJAX request|POST
      FIRES:: istsos.events.EventType: NEW_OFFERING
  ======================================
* getOfferingNames()
      ================================== 
      AJAX request|GET
      FIRES:: istsos.events.EventType: OFFERING_NAMES
  ======================================
* getOfferings()
      ================================== 
      AJAX request|GET
      FIRES:: istsos.events.EventType: OFFERING_LIST
  ======================================
* addProcedure(procedure {istsos.Procedure})
* registerProcedure (procedure {istsos.Procedure})
      ================================== 
      AJAX request|POST
      FIRES:: istsos.events.EventType: NEW_PROCEDURE
  ======================================
* getProcedure(procedure {istsos.Procedure})
      ================================== 
      AJAX request|GET
      FIRES:: istsos.events.EventType: PROCEDURE
  ======================================
* getProcedures()
      ================================== 
      AJAX request|GET
      FIRES:: istsos.events.EventType: PROCEDURES
  ======================================
* addVirtualProcedure (v_procedure {istsos.VirtualProcedure})
* registerVirtualProcedure (v_procedure {istsos.VirtualProcedure})
      ================================== 
      AJAX request|POST
      FIRES:: istsos.events.EventType: NEW_VIRTUAL_PROCEDURE
  ======================================
* getVirtualProcedure(v_procedure {istsos.VirtualProcedure})
      ================================== 
      AJAX request|GET
      FIRES:: istsos.events.EventType: VIRTUAL_PROCEDURE
  ======================================
* getVirtualProcedures()
      ================================== 
      AJAX request|GET
      FIRES:: istsos.events.EventType: VIRTUAL_PROCEDURES
  ======================================
* addObservedProperty(property {istsos.ObservedProperty})
* registerObservedProperty(property {istsos.ObservedProperty})
      ================================== 
      AJAX request|POST
      FIRES:: istsos.events.EventType: NEW_OBSERVED_PROPERTY
  ======================================
* getObservedProperties()
      ================================== 
      AJAX request|GET
      FIRES:: istsos.events.EventType: OBSERVED_PROPERTIES
  ======================================
* getObservedProperty(istsos.ObservedProperty})
      ================================== 
      AJAX request|GET
      FIRES:: istsos.events.EventType: OBSERVED_PROPERTY
  ======================================
* addUom(uom {istsos.UnitOfMeasure})
* registerUom(uom {istsos.UnitOfMeasure})
      ================================== 
      AJAX request|POST
      FIRES:: istsos.events.EventType: NEW_UOM
  ======================================
* getUoms()
      ================================== 
      AJAX request|GET
      FIRES:: istsos.events.EventType: UOMS
  ======================================
* getUom(uom {istsos.UnitOfMeasure})
      ================================== 
      AJAX request|GET
      FIRES:: istsos.events.EventType: UOM
  ======================================
* addDataQuality(dataQuality {istsos.DataQuality})
* registerDataQuality(dataQuality {istsos.DataQuality})
      ================================== 
      AJAX request|POST
      FIRES:: istsos.events.EventType: NEW_DATAQUALITY
  ======================================
* getDataQualities()
      ================================== 
      AJAX request|GET
      FIRES:: istsos.events.EventType: DATAQUALITIES
  ======================================
* getDataQuality(dataQuality {istsos.DataQuality})
      ================================== 
      AJAX request|GET
      FIRES:: istsos.events.EventType: DATAQUALITY
  ======================================
* getSystemTypes()
      ================================== 
      AJAX request|GET
      FIRES:: istsos.events.EventType: SYSTEM_TYPES
  ======================================
* getDatabaseProperty()
      ================================== 
      RETURNS:: {istsos.Database}
  ======================================
* getDatabase()
      ================================== 
      AJAX request|GET
      FIRES:: istsos.events.EventType: DATABASE
  ======================================
* getObservations(
      offering {istsos.Offering}
      procedure {istsos.Procedure|istsos.VirtualProcedure}
      observed_properties {Array<istsos.ObservedProperty>}
      begin_time {istsos.Date}
      end_time {istsos.Date}
     )
      ================================== 
      AJAX request|GET
      FIRES:: istsos.events.EventType: GETOBSERVATIONS
  ======================================
* getObservationsBySingleProperty(
      offering {istsos.Offering}
      procedure {istsos.Procedure|istsos.VirtualProcedure}
      observed_property {istsos.ObservedProperty}
      begin_time {istsos.Date}
      end_time {istsos.Date}
     )
      ================================== 
      AJAX request|GET
      FIRES:: istsos.events.EventType: GETOBSERVATIONS_BY_PROPERTY GEOJSON
  ======================================
* getFeatureCollection(
      opt_epsg
      opt_offering
      opt_procedure
     )
      ================================== 
      AJAX request|GET
      FIRES:: istsos.events.EventType: GEOJSON
  ======================================

###istsos.Offering class

#####properties:

#####methods:

###istsos.BaseProcedure class

#####properties:

#####methods:

###istsos.Procedure class

#####properties:

#####methods:

###istsos.VirtualProcedure class

#####properties:

#####methods:

###istsos.ObservedProperty class

#####properties:

#####methods:

###istsos.DataQuality class

#####properties:

#####methods:

###istsos.UnitOfMeasure class

#####properties:

#####methods:

Clone this wiki locally