DABSource
This kind of node represents a source brokered by a DAB instance. DAB sources can be retrieved with the sources method. Since the DAB sources are first level nodes (the DAB direct "children"), they can also be retrieved as result of the first call of the expand method.
Including or excluding a source from the discover
By default all the sources brokered by the DAB are included in the discover. If a source is included, its content (depending on the given constraints) will be added to the result set, otherwise it is ignored and its content is not added to the result set.At least one source must be included in the discover so the exclusion of all the sources is equivalent to include them all
Distributed and harvested content
The content of the sources brokered by the DAB can be "distributed" or "harvested":
- distributed: the content of the source is retrieved "on demand" during the discover process. The response time is affected by the source latency and several features (such as term frequency) are not available for distributed content. The retrieved content is always up to date
- harvested: the content of the source is permanently stored in database accessed by the DAB. The response time of a discover is much faster than for harvested sources and several features (such as term frequency) are available only for harvested content. Not all the sources content can be harvested, and (depending on the harvesting frequency) then content can be out of date
Item Index
Methods
Properties
Methods
accessLink
-
onResponse
-
[options]
If this {{#crossLink "GINode"}}node{{/crossLink}} is not accessible, this method does nothing.
The data is accessed using a set of {{#crossLink "AccessOptions"}}options{{/crossLink}} which allow to specify several output parameters such as {{#crossLink "AccessOptions/CRS:property"}}Coordinate Reference System{{/crossLink}}. Not all the possible combinations of {{#crossLink "AccessOptions"}}access options{{/crossLink}} parameters are valid for a given data; the valid set of parameters to access the data of this node can be retrieved with the {{#crossLink "GINode/accessOptions:method"}}
accessOptions
method{{/crossLink}}.If the
options
parameter is omitted,
the data link is created using the available {{#crossLink "AccessOptions"}}reducedOption{{/crossLink}} that can
be retrieved with the {{#crossLink "GINode/accessOptions:method"}}accessOptions
method{{/crossLink}}
Parameters:
-
onResponse
FunctionCallback function for receiving asynchronous query response -
[options]
AccessOptions optionalThe access {{#crossLink "AccessOptions"}}options{{/crossLink}} which allows to specify the data output parameters. If omitted, the data link is created using the available {{#crossLink "AccessOptions"}}reducedOption{{/crossLink}} (see {{#crossLink "GINode/accessOptions:method"}}accessOptions
method{{/crossLink}})
accessOptions
-
onResponse
If this {{#crossLink "GINode"}}node{{/crossLink}} is not accessible, this method does nothing.
Each returned object contains a
validOptions
array, and a defaultOption
and a reducedOption
. E.g.:
var options = {
"validOptions": [
{
"CRS": "EPSG:4326",
"format": "IMAGE_PNG",
"firstAxisSize": {
"label": "Lat",
"value": 300
},
"secondAxisSize": {
"label": "Lon",
"value": 300
},
"spatialSubset": {
"south": -60.0,
"west": -180.0,
"north": 90.000007823,
"east": 180.000018775
},
"temporalSubset": {
"from" : "2000-01-01T00:00:00Z",
"to": "2013-01-01"
}
},
{
"CRS": "EPSG:3857",
"format": "IMAGE_JPEG",
"firstAxisSize": {
"label": "X",
"value": 455
},
"secondAxisSize": {
"label": "Y",
"value": 300
},
"spatialSubset": {
"south": -60.0,
"west": -180.0,
"north": 90.000007823,
"east": 180.000018775
},
"temporalSubset": {
"from" : "2000-01-01T00:00:00Z",
"to": "2013-01-01"
}
}],
"defaultOption":
{
"CRS": "EPSG:4326",
"format": "IMAGE_PNG",
"firstAxisSize": {
"label": "Lat",
"value": 300
},
"secondAxisSize": {
"label": "Lon",
"value": 300
},
"spatialSubset": {
"south": -60.0,
"west": -180.0,
"north": 90.000007823,
"east": 180.000018775
},
"temporalSubset": {
"from" : "2000-01-01T00:00:00Z",
"to": "2013-01-01"
}
},
"reducedOption":
{
"CRS": "EPSG:4326",
"format": "IMAGE_PNG",
"firstAxisSize": {
"label": "Lat",
"value": 395
},
"secondAxisSize": {
"label": "Lon",
"value": 600
},
"spatialSubset": {
"south": -60.0,
"west": -180.0,
"north": 90.000007823,
"east": 180.000018775
},
"temporalSubset": {
"from" : "2013-01-01",
"to": "2013-01-01"
}
}
}
contentType
()
Returns the content type of this source; see here for more info
Returns:
returns the content type of this source; possible values are "distributed" and "harvested"
directAccessLinks
()
String[]
See also {{#crossLink "GINode/isDirectlyAccessible:method"}}{{/crossLink}} method
Returns:
expand
-
onResponse
-
[pageSize=10]
The {{#crossLink "ResultSet"}}result set{{/crossLink}} contains the underlying first level nodes (this node children). If this node is a {{#crossLink "DAB"}}{{/crossLink}} instance, than the first call of this method returns the correspondent {{#crossLink "DABSource"}}sources{{/crossLink}}.
If the {{#crossLink "ResultSet"}}result set{{/crossLink}} is split in more than one {{#crossLink "Page"}}page{{/crossLink}} use the {{#crossLink "GINode/expandNext:method"}}expandNext method{{/crossLink}} to retrieve the next ones. If this is a {{#crossLink "Report/type:property"}}simple node{{/crossLink}}, the {{#crossLink "ResultSet"}}result set{{/crossLink}} is empty
Parameters:
-
onResponse
FunctiononResponse Callback function for receiving asynchronous query response-
resultSet
ResultSetThe expansion result set set. In case of error, this argument contains an empty result set with the ResultSet/error:property property describing the problem occurred
-
-
[pageSize=10]
Integer optionalThe size of the {{#crossLink "ResultSet"}}result set{{/crossLink}} {{#crossLink "Page"}}pages{{/crossLink}}
expandNext
-
onResponse
-
[execute]
execute
argument is true
, retrieves the next
{{#crossLink "ResultSet"}}result set{{/crossLink}} {{#crossLink "Page"}}page{{/crossLink}}.
If this node is a {{#crossLink "Report/type:property"}}composed node{{/crossLink}} but it has never been expanded, an Exception is thrown.If this is a {{#crossLink "Report/type:property"}}simple node{{/crossLink}}, this method returns
false
Parameters:
-
onResponse
FunctiononResponse Callback function for receiving asynchronous query response. See onResponse for more info -
[execute]
Boolean optionalIf omitted or set tofalse
, this method tests if other pages in the result set are available and returns the test result. If set totrue
and the test is positive, this method retrieves the next result set page and returnstrue
. If set totrue
and the test is negative this method returnsfalse
Returns:
googleImageMapType
-
map
-
[initOptions]
All the available ImageMapTypeOptions are allowed; this method implements the
getTileUrl
function in order to build the correct WMS GetMap request.
Parameters:
-
map
google.maps.Mapinstance required for the implementation of thegetTileUrl
function -
[initOptions]
Object optionalSee ImageMapTypeOptions for more info
Returns:
has_olVector_Layer
()
String[]
String
s, each string is the name of an available vector layer.
Returns:
isAccessible
()
See also {{#crossLink "GINode/accessOptions:method"}}{{/crossLink}} and {{#crossLink "GINode/accessLink:method"}}{{/crossLink}} methods
Returns:
true
if this node is linked to one or more data and it is asynchronously accessible,
false
otherwise
isDirectlyAccessible
()
See also {{#crossLink "OnlineInfo/accessType:property"}}OnlineInfo.accessType{{/crossLink}} property
Returns:
true
if this node is linked to one or more data and it has one or more direct access links,
false
otherwise.ol3WMS_Layer
-
[opt_options]
As explained in the ol.source.TileWMS constructor documentation, the returned layers can be optionally created with additional parameters and options for the GetMap request (see
opt_options
argument). E.g.:
var opt_options = {};
opt_options.params = {LAYERS: name, TRANSPARENT: true}; //WMS request parameters. At least a LAYERS param is required.
opt_options.attributions = new ol.Attribution({
html: 'All maps © ' + 'ExampleMap'
});
var layers = giNode.ol3WMS_Layer(opt_options);
Parameters:
-
[opt_options]
Object optionalSee Tile WMS options in the ol.source.TileWMS constructor
Returns:
olTiles_Layer
-
[initOptions]
As explained in the OpenLayers.Layer.WMS constructor documentation, the returned layers can be optionally created with additional parameters and options for the GetMap request (see
initOptions
argument). E.g.:
var initOptions = {};
initOptions.params = {transparent: true}; // corresponds to the OpenLayers.Layer.WMS params
argument
initOptions.options = {opacity: 0.5}; // corresponds to the OpenLayers.Layer.WMS options
argument
var layers = giNode.olTiles_Layer(initOptions);
Parameters:
-
[initOptions]
Object optionalobject literal of options passed the OpenLayers.Layer.WMS constructor-
[params]
Object optionalthis argument corresponds to the OpenLayers.Layer.WMS
params
argument Note: thelayers
property is provided by the API -
[options]
Object optionalthis argument corresponds to the OpenLayers.Layer.WMS
options
argument
-
Returns:
olVector_Layer
-
onResponse
Besides, client applications are required (at the moment) to handle the cross-origin nature of the request which is executed (GML is an XML encoding)
Parameters:
-
onResponse
FunctionCallback function for receiving asynchronous result-
result
Object/Arraythe Array of available OpenLayers.Layer.Vector objects
-
olWMS_Layer
-
[initOptions]
As explained in the OpenLayers.Layer.WMS constructor documentation, the returned layers can be optionally created with additional parameters and options for the GetMap request (see
initOptions
argument). E.g.:
var initOptions = {};
initOptions.params = {transparent: true}; // corresponds to the OpenLayers.Layer.WMS params
argument
initOptions.options = {opacity: 0.5}; // corresponds to the OpenLayers.Layer.WMS options
argument
var layers = giNode.olWMS_Layer(initOptions);
Parameters:
-
[initOptions]
Object optionalobject literal of options passed the OpenLayers.Layer.WMS constructor-
[params]
Object optionalthis argument corresponds to the OpenLayers.Layer.WMS
params
argument Note: thelayers
property is provided by the API -
[options]
Object optionalthis argument corresponds to the OpenLayers.Layer.WMS
options
argument
-
Returns:
overview
-
id
-
onResponse
-
[options]
options.index
(0 if not specified) and
appends <img> to the element having the given id
.The {{#crossLink "Report/overview:property"}}overview{{/crossLink}} property can be available also if this {{#crossLink "GINode"}}node{{/crossLink}} is not accessible.
The method throws an Exception if
id
does not correspond to an element
or if options.index
does not respect the following statement: index
>= 0 && index
<= {{#crossLink "Report/overview:property"}}overview{{/crossLink}}.length - 1
Parameters:
-
id
Stringthe id of an element in which to append the <img> element of the selected overview -
onResponse
FunctionCallback function for receiving asynchronous request status -
[options]
Object optional-
[index=0]
Number optionalindex of this node overview array
-
[size="medium"]
String optionalThe overview size (aspect ration is preserved). Possible values are:
- "extra small": 48x48 px
- "small": 96x96 px
- "medium": 144x144 px
- "large": 288x288 px
- "original": the original size of the target overview image
-
[force=false]
Boolean optionalIf set to
true
a "no overview" image is used in case of error or in case an overview is not available -
[backgroundURL]
String optionalURL of an additional image to load as background of the overview image (use this only if the overview image is transparent)
-
Returns:
true
if this {{#crossLink "GINode"}}node{{/crossLink}} has an
{{#crossLink "Report/overview:property"}}overview{{/crossLink}}, false
otherwise
Properties
uiId
String
DOM
elements