oscar.Control.MetaData

Inherits from:oscar.Control

Description: This control will allow the user to view metadata from the layers in the active theme.

Summary
oscar.Control.MetaData
Properties
guiThe html document the dialog for this control uses.
type{OpenLayers.Control.TYPES}
mdContainerThe container array for the meta data containers
sourceThe callback url to obtain the layer meta data.
Functions
oscar.Control.MetaData
activateActivates the control
deactivateDeactivates the control
buildDialogAJAX callback method to build the user interface for the dialog.
createDialogEntry method to to create the dialog
_getInterfaceStarts the Ajax process to get the gui interface for the dialog.
_setUIPropertiesUsed to set any UI properties for display
_addThemeLayersCreates the container objects for meta data display
_requestMetaDataStarts the request for each container to obtain meta data.
_applyMetaDataAdds the layers to the gui and binds the meta data to the containers.
_viewMetaDataActivates the layer and displays the metadata associated with it.
_finishedLoadingKeeps track of the containers load process.
oscar.MetaDataContainerDescription: A container for metadata information and loading.
Properties
loading{Boolean} Whether the container is still loading.
connectionName{String} The name of the connection
dataLayers{Array} Contains the names of the data layers.
layerReferences the WMS layer in the theme.
parent{oscar.Control.MetaData} The parent control.
Functions
oscar.MetaDataContainerCreate a new metadata container
isLoadingReturns {Boolean} is the layer container is still loading.
makeRequestMakes an ajax request to the source
buildParameterListCreates the query string based on the data layers of the container.
successWhat to do on a successful ajax call.
failureWhat to do when the ajax request fails.
Properties
CLASS_NAME{String} The name of the class.

Properties

gui

The html document the dialog for this control uses.

type

{OpenLayers.Control.TYPES}

mdContainer

The container array for the meta data containers

source

The callback url to obtain the layer meta data.

Functions

oscar.Control.MetaData

Parameters

sourceurl to use to obtain metadata

activate

activate:function()

Activates the control

deactivate

deactivate:function()

Deactivates the control

buildDialog

buildDialog:function(userinterface)

AJAX callback method to build the user interface for the dialog.

createDialog

createDialog:function()

Entry method to to create the dialog

_getInterface

_getInterface:function()

Starts the Ajax process to get the gui interface for the dialog.

_setUIProperties

_setUIProperties:function()

Used to set any UI properties for display

_addThemeLayers

_addThemeLayers:function()

Creates the container objects for meta data display

_requestMetaData

_requestMetaData:function()

Starts the request for each container to obtain meta data.

_applyMetaData

_applyMetaDataResponse:function(metaData,
container)

Adds the layers to the gui and binds the meta data to the containers.

_viewMetaData

_viewMetaData:function(div)

Activates the layer and displays the metadata associated with it.

_finishedLoading

_finishedLoading:function()

Keeps track of the containers load process.

oscar.MetaDataContainer

Description: A container for metadata information and loading.

Summary
Properties
loading{Boolean} Whether the container is still loading.
connectionName{String} The name of the connection
dataLayers{Array} Contains the names of the data layers.
layerReferences the WMS layer in the theme.
parent{oscar.Control.MetaData} The parent control.
Functions
oscar.MetaDataContainerCreate a new metadata container
isLoadingReturns {Boolean} is the layer container is still loading.
makeRequestMakes an ajax request to the source
buildParameterListCreates the query string based on the data layers of the container.
successWhat to do on a successful ajax call.
failureWhat to do when the ajax request fails.
Properties
CLASS_NAME{String} The name of the class.

Properties

loading

{Boolean} Whether the container is still loading.

connectionName

{String} The name of the connection

dataLayers

{Array} Contains the names of the data layers.

layer

References the WMS layer in the theme.

parent

{oscar.Control.MetaData} The parent control.

Functions

oscar.MetaDataContainer

Create a new metadata container

isLoading

isLoading:function()

Returns {Boolean} is the layer container is still loading.

makeRequest

makeRequest:function(source)

Makes an ajax request to the source

Parameters

source{String}

buildParameterList

buildParameterList:function()

Creates the query string based on the data layers of the container.

success

success:function(transport)

What to do on a successful ajax call.

failure

failure:function(transport)

What to do when the ajax request fails.

Properties

CLASS_NAME

{String} The name of the class.

activate:function()
Activates the control
deactivate:function()
Deactivates the control
buildDialog:function(userinterface)
AJAX callback method to build the user interface for the dialog.
createDialog:function()
Entry method to to create the dialog
_getInterface:function()
Starts the Ajax process to get the gui interface for the dialog.
_setUIProperties:function()
Used to set any UI properties for display
_addThemeLayers:function()
Creates the container objects for meta data display
_requestMetaData:function()
Starts the request for each container to obtain meta data.
_applyMetaDataResponse:function(metaData,
container)
Adds the layers to the gui and binds the meta data to the containers.
_viewMetaData:function(div)
Activates the layer and displays the metadata associated with it.
_finishedLoading:function()
Keeps track of the containers load process.
isLoading:function()
Returns {Boolean} is the layer container is still loading.
makeRequest:function(source)
Makes an ajax request to the source
buildParameterList:function()
Creates the query string based on the data layers of the container.
success:function(transport)
What to do on a successful ajax call.
failure:function(transport)
What to do when the ajax request fails.
Description: Definition for the oscar Control name space.