oscar.ox

Namespace object for Oscar eXchange object.

Summary
oscar.oxNamespace object for Oscar eXchange object.
Constructor
oscar.ox
Constants
CLASS_NAME - oscar.ox
oscar.ox.ThemeThis class represents a Theme from Oscar eXchange Format
Properties
layers
selectionLayers
displayOrder
name
srs
projection
isActive
services
covers
Constructor
oscar.ox.Theme
Functions
addLayerAdds an {oscar.ox.Layer} to the theme object.
hasSelectionServiceReturns: {Boolean} whether a selection service is available.
getSelectionServiceReturns: {Object} serviceEntries the selection service.
getSelectionServiceReturns: {Array} oscar.ogc.CatalogueService An array of catalogue services.
hasCatalogueServiceReturns: {Boolean} whether a catalogue service is available.
hasExtractionServiceReturns: {Boolean} whether an extraction service is available.
getExtractionServiceReturns: {Object} serviceEntries the extraction service.
getDefaultCoverReturns: {Object} a default cover or null.
getMaxCoverReturns: {Object} the max extent cover.
Constants
CLASS_NAME - oscar.ox.Theme
oscar.ox.LayerThis class represents a Layer from Oscar eXchange Format.
Properties
baseLayer
displayOrder
dataLayers
layerId
layerType
name
parameters
urls
Constructor
oscar.ox.Layer
Functions
addDataLayer Adds an {<oscar.ox.DataLayer>} object to thedataLayers array.
addUrl Adds a url source to the urls object.
toMapLayerReturns: {Object} olLayer which inherits from <OpenLayers.Layer> and is able to be added to an <OpenLayers.Map> object.
Constants
CLASS_NAME - oscar.ox.Layer
oscar.ox.DataLayerThis class represents a DataLayer from Oscar eXchange Format.
Properties
id
index
layerName
Constructor
oscar.ox.DataLayer
Constants
CLASS_NAME - oscar.ox.DataLayer
oscar.ox.Services
Constructor
oscar.ox.Services
Constants
CLASS_NAME - oscar.ox.Services
oscar.ox.ServiceRepresents a type of Service containing an array of ServiceEntry objects.
Properties
serviceEntriesAn array of oscar.ox.ServiceEntry objects.
Constructor
oscar.ox.Service
Functions
getServiceEntriesReturns an array of service entry objects.
getServiceEntryReturns a specified service entry.
Constants
CLASS_NAME - oscar.ox.Service
oscar.ox.SelectionServiceRepresents the selection service from Oscar eXchange Format.
Constructor
oscar.ox.SelectionService
Constants
CLASS_NAME - oscar.ox.SelectionService
Constructor
oscar.ox.SelectionService
Constants
CLASS_NAME - oscar.ox.CatalogueService
oscar.ox.ExtractionServiceRepresents the extraction service from Oscar eXchange Format.
Constructor
oscar.ox.ExtractionService
Constants
CLASS_NAME - oscar.ox.ExtractionService
oscar.ox.ServiceEntryAn object containing connection information for a service.
Properties
url{String} The URL of the service.
version{String} The version of the service.
serviceType{String} Type of the service.
format{String}
identifiers{Array{String}}
geometryName{String} the geometry property name of the current server.
Constructor
oscar.ox.ServiceEntry
Constants
CLASS_NAME - oscar.ox.ServiceEntry

Constructor

oscar.ox

Parameters: options{Object} An optional object whose properties will be set on this instance.

Constants

CLASS_NAME - oscar.ox

oscar.ox.Theme

This class represents a Theme from Oscar eXchange Format

Summary
Properties
layers
selectionLayers
displayOrder
name
srs
projection
isActive
services
covers
Constructor
oscar.ox.Theme
Functions
addLayerAdds an {oscar.ox.Layer} to the theme object.
hasSelectionServiceReturns: {Boolean} whether a selection service is available.
getSelectionServiceReturns: {Object} serviceEntries the selection service.
getSelectionServiceReturns: {Array} oscar.ogc.CatalogueService An array of catalogue services.
hasCatalogueServiceReturns: {Boolean} whether a catalogue service is available.
hasExtractionServiceReturns: {Boolean} whether an extraction service is available.
getExtractionServiceReturns: {Object} serviceEntries the extraction service.
getDefaultCoverReturns: {Object} a default cover or null.
getMaxCoverReturns: {Object} the max extent cover.
Constants
CLASS_NAME - oscar.ox.Theme

Properties

layers

selectionLayers

displayOrder

name

srs

projection

isActive

services

covers

Constructor

oscar.ox.Theme

Parameters: options{Object} An optional object whose properties will be set on this instance.

Functions

addLayer

addLayer : function(oxLayer)

Adds an {oscar.ox.Layer} to the theme object.

Parameters: oxLayer{oscar.ox.Layer} the layer to be added.

hasSelectionService

hasSelectionService : function()

Returns: {Boolean} whether a selection service is available.

getSelectionService

getSelectionService : function()

Returns: {Object} serviceEntries the selection service.

getSelectionService

Returns: {Array} oscar.ogc.CatalogueService An array of catalogue services.

hasCatalogueService

hasCatalogueService : function()

Returns: {Boolean} whether a catalogue service is available.

hasExtractionService

hasExtractionService : function()

Returns: {Boolean} whether an extraction service is available.

getExtractionService

getExtractionService : function()

Returns: {Object} serviceEntries the extraction service.

getDefaultCover

getDefaultCover : function()

Returns: {Object} a default cover or null.

getMaxCover

getMaxCover : function()

Returns: {Object} the max extent cover.

Constants

CLASS_NAME - oscar.ox.Theme

oscar.ox.Layer

This class represents a Layer from Oscar eXchange Format.

Properties

baseLayer

displayOrder

dataLayers

layerId

layerType

name

parameters

urls

Constructor

oscar.ox.Layer

Parameters: options{Object} An optional object whose properties will be set on this instance.

Functions

addDataLayer Adds an {<oscar.ox.DataLayer>} object to the

dataLayers array.

Parameters: dataLayeran {oscar.ox.DataLayer} object.

addUrl Adds a url source to the urls object.

Parameters: url{String} a url String.

toMapLayer

toMapLayer : function(map)

Returns: {Object} olLayer which inherits from <OpenLayers.Layer> and is able to be added to an <OpenLayers.Map> object.

Constants

CLASS_NAME - oscar.ox.Layer

oscar.ox.DataLayer

This class represents a DataLayer from Oscar eXchange Format.

Properties

id

index

layerName

Constructor

oscar.ox.DataLayer

Parameters: options{Object} An optional object whose properties will be set on this instance.

Constants

CLASS_NAME - oscar.ox.DataLayer

Constructor

oscar.ox.Services

Constants

CLASS_NAME - oscar.ox.Services

oscar.ox.Service

Represents a type of Service containing an array of ServiceEntry objects.

Summary

Properties

serviceEntries

An array of oscar.ox.ServiceEntry objects.

Constructor

oscar.ox.Service

Parameters: options{Object} An optional object whose properties will be set on this instance.

Functions

getServiceEntries

getServiceEntries : function()

Returns an array of service entry objects.

Returns: {Array}An array of oscar.ox.ServiceEntry objects.

getServiceEntry

getServiceEntry : function(index)

Returns a specified service entry.

Parameters: index{Number} The index of the oscar.ox.ServiceEntry to return.
Returns: {oscar.ox.ServiceEntry}A ServiceEntry object.

Constants

CLASS_NAME - oscar.ox.Service

Constructor

oscar.ox.SelectionService

Parameters: options{Object} An optional object whose properties will be set on this instance.

Constants

CLASS_NAME - oscar.ox.SelectionService

Constructor

oscar.ox.SelectionService

Parameters: options{Object} An optional object whose properties will be set on this instance.

Constants

CLASS_NAME - oscar.ox.CatalogueService

oscar.ox.ExtractionService

Represents the extraction service from Oscar eXchange Format.

Inherits from: oscar.ox.Service

Constructor

oscar.ox.ExtractionService

Parameters: options{Object} An optional object whose properties will be set on this instance.

Constants

CLASS_NAME - oscar.ox.ExtractionService

oscar.ox.ServiceEntry

An object containing connection information for a service.

Summary
Properties
url{String} The URL of the service.
version{String} The version of the service.
serviceType{String} Type of the service.
format{String}
identifiers{Array{String}}
geometryName{String} the geometry property name of the current server.
Constructor
oscar.ox.ServiceEntry
Constants
CLASS_NAME - oscar.ox.ServiceEntry

Properties

url

{String} The URL of the service.

version

{String} The version of the service.

serviceType

{String} Type of the service.

format

{String}

identifiers

{Array{String}}

geometryName

{String} the geometry property name of the current server.

Constructor

oscar.ox.ServiceEntry

Parameters: options{Object} An optional object whose properties will be set on this instance.

Constants

CLASS_NAME - oscar.ox.ServiceEntry

addLayer : function(oxLayer)
Adds an {oscar.ox.Layer} to the theme object.
This class represents a Layer from Oscar eXchange Format.
hasSelectionService : function()
Returns: {Boolean} whether a selection service is available.
getSelectionService : function()
Returns: {Object} serviceEntries the selection service.
hasCatalogueService : function()
Returns: {Boolean} whether a catalogue service is available.
hasExtractionService : function()
Returns: {Boolean} whether an extraction service is available.
getExtractionService : function()
Returns: {Object} serviceEntries the extraction service.
getDefaultCover : function()
Returns: {Object} a default cover or null.
getMaxCover : function()
Returns: {Object} the max extent cover.
toMapLayer : function(map)
Returns: {Object} olLayer which inherits from OpenLayers.Layer and is able to be added to an OpenLayers.Map object.
An object containing connection information for a service.
getServiceEntries : function()
Returns an array of service entry objects.
getServiceEntry : function(index)
Returns a specified service entry.
This class represents a DataLayer from Oscar eXchange Format.
Represents a type of Service containing an array of ServiceEntry objects.