| java.lang.Object
 org.deegree.ogcwebservices.wms.capabilities.Layer
| Layer | | public class Layer (Code) | | Each available map is advertised by a <Layer> element in the Capabilities XML. A single
parent Layer encloses any number of additional layers, which may be hierarchically nested as
desired. Some properties defined in a parent layer are inherited by the children it encloses.
These inherited properties may be either redefined or added to by the child.
A Map Server shall include at least one <Layer> element for each map layer offered. If
desired, layers may be repeated in different categories when relevant. No controlled vocabulary
has been defined, so at present Layer and Style Names, Titles and Keywords are arbitrary.
The <Layer> element can enclose child elements providing metadata about the Layer.
author:
Katharina Lupp
author:
Markus Schneider
author:
last edited by: $Author: apoth $
version:
2002-03-01 |
| Constructor Summary | |
| public | Layer(boolean queryable, int cascaded, boolean opaque, boolean noSubsets, int fixedWidth, int fixedHeight, String name, String title, String abstract_, Envelope latLonBoundingBox, Attribution attribution, ScaleHint scaleHint, String[] keywordList, String[] srs, LayerBoundingBox[] boundingBoxes, Dimension[] dimensions, Extent[] extents, AuthorityURL[] authorityURLs, Identifier[] identifiers, MetadataURL[] metadataURLs, DataURL[] dataURLs, FeatureListURL[] featureListURLs, Style[] styles, Layer[] layers, AbstractDataSource[] dataSource, Layer parent)
|
| Layer | | public Layer(boolean queryable, int cascaded, boolean opaque, boolean noSubsets, int fixedWidth, int fixedHeight, String name, String title, String abstract_, Envelope latLonBoundingBox, Attribution attribution, ScaleHint scaleHint, String[] keywordList, String[] srs, LayerBoundingBox[] boundingBoxes, Dimension[] dimensions, Extent[] extents, AuthorityURL[] authorityURLs, Identifier[] identifiers, MetadataURL[] metadataURLs, DataURL[] dataURLs, FeatureListURL[] featureListURLs, Style[] styles, Layer[] layers, AbstractDataSource[] dataSource, Layer parent)(Code) | | constructor initializing the class with the <Layer>
Parameters:
queryable -
Parameters:
cascaded -
Parameters:
opaque -
Parameters:
noSubsets -
Parameters:
fixedWidth -
Parameters:
fixedHeight -
Parameters:
name -
Parameters:
title -
Parameters:
abstract_ -
Parameters:
latLonBoundingBox -
Parameters:
attribution -
Parameters:
scaleHint -
Parameters:
keywordList -
Parameters:
srs -
Parameters:
boundingBoxes -
Parameters:
dimensions -
Parameters:
extents -
Parameters:
authorityURLs -
Parameters:
identifiers -
Parameters:
metadataURLs -
Parameters:
dataURLs -
Parameters:
featureListURLs -
Parameters:
styles -
Parameters:
layers -
Parameters:
dataSource -
Parameters:
parent - |
| addAuthorityURL | | public void addAuthorityURL(AuthorityURL authorityURL)(Code) | | adds the authority attribute of the Identifier element
Parameters:
authorityURL - |
| addBoundingBox | | public void addBoundingBox(Envelope boundingBox)(Code) | | adds the <BoundingBox>
Parameters:
boundingBox - |
| addDataSource | | public void addDataSource(AbstractDataSource dataSource)(Code) | | source where the WMS can find the data of a layer.
Parameters:
dataSource - |
| addDataURL | | public void addDataURL(DataURL dataURL)(Code) | | adds the dataURL
Parameters:
dataURL - |
| addDimension | | public void addDimension(Dimension dimension)(Code) | | adds the dimension
Parameters:
dimension - |
| addExtent | | public void addExtent(Extent extent)(Code) | | adds the extent declarations
Parameters:
extent - |
| addFeatureListURL | | public void addFeatureListURL(FeatureListURL featureListURL)(Code) | | adds the <FeatureListURL>
Parameters:
featureListURL - |
| addIdentifier | | public void addIdentifier(Identifier identifier)(Code) | | adds the <Identifier>
Parameters:
identifier - |
| addKeyword | | public void addKeyword(String keyword)(Code) | | adds the keywordList
Parameters:
keyword - |
| addLayer | | public void addLayer(Layer layer)(Code) | | adds a list of layers the are enclosed by this layer.
Parameters:
layer - |
| addMetadataURL | | public void addMetadataURL(MetadataURL metadataURL)(Code) | | adds the metadataURL
Parameters:
metadataURL - |
| addSrs | | public void addSrs(String srs)(Code) | | adds the spatial reference system (srs)
Parameters:
srs - |
| addStyles | | public void addStyles(Style style)(Code) | | adds a list of style that can be used form rendering the layer.
Parameters:
style - |
| getAbstract | | public String getAbstract()(Code) | | Abstract is a narrative description of the map layer. The Abstract elements are not inherited
by child Layers.
the abstract |
| getAttribution | | public Attribution getAttribution()(Code) | | The optional <Attribution> element provides a way to identify the source of the map
data used in a Layer or collection of Layers. Attribution encloses several optional elements:
states the data provider's URL; <Title> is a human-readable string
naming the data provider; <LogoURL> is the URL of a logo image. Client applications may
choose to display one or more of these items. A <Format> element in LogoURL indicates
the MIME type of the logo image, and the attributes width and height state the size of the
image in pixels.
the attribution |
| getAuthorityURL | | public AuthorityURL[] getAuthorityURL()(Code) | | The authority attribute of the Identifier element corresponds to the name attribute of a
separate <AuthorityURL> element. AuthorityURL encloses an <OnlineResource>
element which states the URL of a document defining the meaning of the Identifier values.
the authority url object |
| getBoundingBoxes | | public LayerBoundingBox[] getBoundingBoxes()(Code) | | Layers may have zero or more <BoundingBox> elements that are either stated explicitly
or inherited from a parent Layer. Each BoundingBox states the bounding rectangle of the map
data in a particular spatial reference system; the attribute SRS indicates which SRS applies.
If the data area is shaped irregularly then the BoundingBox gives the minimum enclosing
rectangle. The attributes minx, miny, maxx, maxy indicate the edges of the bounding box in
units of the specified SRS. Optional resx and resy attributes indicate the spatial resolution
of the data in those same units.
A Layer may have multiple BoundingBox element, but each one shall state a different SRS. A
Layer inherits any BoundingBox values defined by its parents. A BoundingBox inherited from
the parent Layer for a particular SRS is replaced by any declaration for the same SRS in the
child Layer. A BoundingBox in the child for a new SRS not already declared by the parent is
added to the list of bounding boxes for the child Layer. A single Layer element shall not
contain more than one BoundingBox for the same SRS.
bounding boxes |
| getCascaded | | public int getCascaded()(Code) | | '0' if the layer is provided directly form the deegree WMS. other it returns thenumber of cascaded WMS servers the is passed through |
| getDataSource | | public AbstractDataSource[] getDataSource()(Code) | | source where the WMS can find the data of a layer.
the data sources |
| getDataURL | | public DataURL[] getDataURL()(Code) | | A Map Server may use DataURL to offer more information about the data represented by a
particular layer. While the semantics are not well-defined, as long as the results of an HTTP
GET request against the DataURL are properly MIME-typed, Viewer Clients and Cascading Map
Servers can make use of this. Use 6lt;MetadataURL> instead for a precisely defined
reference to standardized metadata records.
the data URLs |
| getDimension | | public Dimension[] getDimension()(Code) | | Dimension declarations are inherited from parent Layers. Any new Dimension declarations in
the child are added to the list inherited from the parent. A child shall not redefine a
Dimension with the same name attribute as one that was inherited.
the dimensions |
| getExtent | | public Extent[] getExtent()(Code) | | Extent declarations are inherited from parent Layers. Any Extent declarations in the child
with the same name attribute as one inherited from the parent replaces the value declared by
the parent. A Layer shall not declare an Extent unless a Dimension with the same name has
been declared or inherited earlier in the Capabilities XML.
the extents |
| getFeatureListURL | | public FeatureListURL[] getFeatureListURL()(Code) | | A Map Server may use a <FeatureListURL> element to point to a list of the features
represented in a Layer.
the feature list urls |
| getFixedHeight | | public int getFixedHeight()(Code) | | '0' if the WMS can resize map to arbitrary height. nonzero: map has a fixed heightthat cannot be changed by the WMS. |
| getFixedWidth | | public int getFixedWidth()(Code) | | '0' if the WMS can resize map to arbitrary width. nonzero: map has a fixed width thatcannot be changed by the WMS. |
| getIdentifier | | public Identifier[] getIdentifier()(Code) | | A Map Server may use zero or more <Identifier> elements to list ID numbers or labels
defined by a particular Authority. The text content of the Identifier element is the ID
value.
the identifiers |
| getKeywordList | | public String[] getKeywordList()(Code) | | KeywordList contains zero or more Keywords to aid in catalog searches. The KeywordList
elements are not inherited by child Layers.
the keywords |
| getLatLonBoundingBox | | public Envelope getLatLonBoundingBox()(Code) | | Every Layer shall have exactly one <LatLonBoundingBox> element that is either stated
explicitly or inherited from a parent Layer. LatLonBoundingBox states the minimum bounding
rectangle of the map data in the EPSG:4326 geographic coordinate system. The
LatLonBoundingBox attributes minx, miny, maxx, maxy indicate the edges of an enclosing
rectangle in decimal degrees. LatLonBoundingBox shall be supplied regardless of what SRS the
map server may support, but it may be approximate if EPSG:4326 is not supported. Its purpose
is to facilitate geographic searches without requiring coordinate transformations by the
search engine.
the bbox |
| getLayer | | public Layer[] getLayer()(Code) | | returns a list of layers the are enclosed by this layer.
the layers |
| getMetadataURL | | public MetadataURL[] getMetadataURL()(Code) | | A Map Server should use one or more <MetadataURL> elements to offer detailed,
standardized metadata about the data underneath a particular layer. The type attribute
indicates the standard to which the metadata complies. Two types are defined at present: the
value 'TC211' refers to [ISO 19115]; the value 'FGDC' refers to [FGDC-STD-001-1988]. The
MetadataURL element shall not be used to reference metadata in a non-standardized metadata
format; see DataURL instead. The enclosed <Format> element indicates the file format
MIME type of the metadata record.
the metadata urls |
| getName | | public String getName()(Code) | | If, and only if, a layer has a <Name>, then it is a map layer that can be requested by
using that Name in the LAYERS parameter of a GetMap request. If the layer has a Title but no
Name, then that layer is only a category title for all the layers nested within. A Map Server
that advertises a Layer containing a Name element shall be able to accept that Name as the
value of LAYERS argument in a GetMap request and return the corresponding map. A Client shall
not attempt to request a layer that has a Title but no Name.
the name |
| getParent | | public Layer getParent()(Code) | | the parent layer of this layer. If the method returns null the currentlayer is the root layer. In addition with the getLayer method this enablesa program to traverse the layer tree in both directions. |
| getScaleHint | | public ScaleHint getScaleHint()(Code) | | Layers may include a <ScaleHint> element that suggests minimum and maximum scales for
which it is appropriate to display this layer. Because WMS output is destined for output
devices of arbitrary size and resolution, the usual definition of scale as the ratio of map
size to real-world size is not appropriate here. The following definition of Scale Hint is
recommended. Consider a hypothetical map with a given Bounding Box, width and height. The
central pixel of that map (or the pixel just to the northwest of center) will have some size,
which can be expressed as the ground distance in meters of the southwest to northeast
diagonal of that pixel. The two values in ScaleHint are the minimum and maximum recommended
values of that diagonal. It is recognized that this definition is not geodetically precise,
but at the same time the hope is that by including it conventions will develop that can be
later specified more clearly.
the scale hint |
| getSrs | | public String[] getSrs()(Code) | | Every Layer is available in one or more spatial reference systems Every Layer shall have at
least one >SRS> element that is either stated explicitly or inherited from a parent
Layer . The root <Layer> element shall include a sequence of zero or more SRS elements
listing all SRSes that are common to all subsidiary layers. Use a single SRS element with
empty content (like so: "<SRS></SRS> ") if there is no common SRS. Layers may
optionally add to the global SRS list, or to the list inherited from a parent layer. Any
duplication shall be ignored by clients. When a Layer is available in several Spatial
Reference Systems, there are two ways to encode the list of SRS values. The first of these is
new in this version of the specification, the second is deprecated but still included for
backwards compatibility.
1. Optional, recommended: Multiple single-valued <SRS> elements: a list of SRS values
is represented as a sequence of <SRS> elements, each of which contains only a single
SRS name. Example: <SRS>EPSG:1234</SRS> <SRS>EPSG:5678</SRS>.
2. Deprecated: Single list-valued <SRS> element: a list of SRS values is represented
asa whitespace-separated list of SRS names contained within a single <SRS> element.
Example: <SRS>EPSG:1234 EPSG:5678</SRS>.
the srs |
| getStyle | | public UserStyle getStyle(String name)(Code) | | returns the UserStyle (SLD) representation of the style identified by the
submitted name.
Parameters:
name - of the requested style SLD - UserStyle |
| getStyleResource | | public Style getStyleResource(String name)(Code) | | returns the Style identified by the submitted name.
Parameters:
name - of the requested style Style |
| getStyles | | public Style[] getStyles()(Code) | | a list of style that can be used form rendering the layer. |
| getTitle | | public String getTitle()(Code) | | A <Title> is required for all layers; it is a human-readable string for presentation in
a menu. The Title is not inherited by child Layers.
the title |
| hasNoSubsets | | public boolean hasNoSubsets()(Code) | | false if the WMS can map a subset of the full bounding box. |
| isOpaque | | public boolean isOpaque()(Code) | | false if map data represents vector features that probably do not completely fillspace. |
| isQueryable | | public boolean isQueryable()(Code) | | true if the layer is queryable. That means it can be targeted by a GetFeatureInforequest. |
| isSrsSupported | | public boolean isSrsSupported(String srs)(Code) | |
Parameters:
srs - s true if the submitted srs (name) is supported by the layer |
| removeLayer | | public Layer removeLayer(String name)(Code) | | removes a Layer identified by its name from the parent Layer. A reference to the removed
layer will be returned. If no Layer matching the passed name can be found nothing happens and
null will be returned.
Parameters:
name - removerd Layer |
| removeLayerByTitle | | public Layer removeLayerByTitle(String title)(Code) | | removes a Layer identified by its title from the parent Layer. A reference to the removed
layer will be returned. If no Layer matching the passed title can be found nothing happens
and null will be returned.
Parameters:
title - removerd Layer |
| setAbstract | | public void setAbstract(String abstract_)(Code) | | sets the a narrative description of the map layer
Parameters:
abstract_ - |
| setAttribution | | public void setAttribution(Attribution attribution)(Code) | | sets the optional <Attribution> element
Parameters:
attribution - |
| setAuthorityURL | | public void setAuthorityURL(AuthorityURL[] authorityURL)(Code) | | sets the authority attribute of the Identifier element
Parameters:
authorityURL - |
| setBoundingBox | | public void setBoundingBox(LayerBoundingBox[] boundingBox)(Code) | | sets the boundingBox
Parameters:
boundingBox - |
| setDataSource | | public void setDataSource(AbstractDataSource[] dataSource)(Code) | | source where the WMS can find the data of a layer.
Parameters:
dataSource - |
| setDataURL | | public void setDataURL(DataURL[] dataURL)(Code) | | sets the dataURL
Parameters:
dataURL - |
| setDimension | | public void setDimension(Dimension[] dimension)(Code) | | sets the dimension
Parameters:
dimension - |
| setExtent | | public void setExtent(Extent[] extent)(Code) | | sets the extent
Parameters:
extent - |
| setFeatureListURL | | public void setFeatureListURL(FeatureListURL[] featureListURL)(Code) | | sets the <FeatureListURL>
Parameters:
featureListURL - |
| setIdentifier | | public void setIdentifier(Identifier[] identifier)(Code) | | sets the <Identifier>
Parameters:
identifier - |
| setKeywordList | | public void setKeywordList(String[] keywordList)(Code) | | sets the keywordList
Parameters:
keywordList - |
| setLatLonBoundingBox | | public void setLatLonBoundingBox(Envelope latLonBoundingBox)(Code) | | sets the LatLonBoundingBox element that is either stated explicitly or inherited from a
parent Layer.
Parameters:
latLonBoundingBox - |
| setLayer | | public void setLayer(Layer[] layer)(Code) | | sets a list of layers the are enclosed by this layer.
Parameters:
layer - |
| setMetadataURL | | public void setMetadataURL(MetadataURL[] metadataURL)(Code) | | sets the metadataURL
Parameters:
metadataURL - |
| setName | | public void setName(String name)(Code) | | sets the name of the layer
Parameters:
name - |
| setParent | | public void setParent(Layer parent)(Code) | | sets the parent layer of this layer.
Parameters:
parent - |
| setScaleHint | | public void setScaleHint(ScaleHint scaleHint)(Code) | | sets the
Parameters:
scaleHint - |
| setSrs | | public void setSrs(String[] srs)(Code) | | sets the srs
Parameters:
srs - |
| setStyles | | public void setStyles(Style[] styles)(Code) | | sets a list of style that can be used form rendering the layer.
Parameters:
styles - |
| setTitle | | public void setTitle(String title)(Code) | | sets the title for the layer
Parameters:
title - |
|
|