deegree 2.5 (2011/06/29 09:44 build-8-official)

org.deegree.portal.context
Class Layer

java.lang.Object
  extended by org.deegree.portal.context.Layer

public class Layer
extends java.lang.Object

encapsulates about a layer described/contained by a Web Map Context

Version:
$Revision: 18195 $
Author:
Andreas Poth

Constructor Summary
Layer(Server server, java.lang.String name, java.lang.String title, java.lang.String abstract_, java.lang.String[] srs, BaseURL dataURL, BaseURL metadataURL, FormatList formatList, StyleList styleList, boolean queryable, boolean hidden, LayerExtension extension)
          Creates a new ContextLayer object.
 
Method Summary
 java.lang.String getAbstract()
          The abstract of the selected layer (extracted from Capabilities by the Context document creator).
 BaseURL getDataURL()
          This element contains a link to an online resource where data corresponding to the layer can be found.
 LayerExtension getExtension()
          The Extension element is a container tag in which arbitrary vendor specific information can be included without compromising the ability of other clients to enforce schema validation.
 FormatList getFormatList()
          The parent element containing the list of available image format for this layer.
 BaseURL getMetadataURL()
          This element contains a link to an online resource where descriptive metadata corresponding to the layer can be found.
 java.lang.String getName()
          The name of the selected layer (extracted from Capabilities by the Context document creator).
 Server getServer()
          The element defining the service from which the named Layer may be requested
 java.lang.String[] getSrs()
          A list of available SRS for the enclosing layer.
 StyleList getStyleList()
          The parent element containing the list of available styles for this layer.
 java.lang.String getTitle()
          The title of the selected layer (extracted from Capabilities by the Context document creator).
 boolean isHidden()
           
 boolean isQueryable()
           
 void setAbstract(java.lang.String abstract_)
           
 void setDataURL(BaseURL dataURL)
           
 void setExtension(LayerExtension extension)
          if extension is null, a default LayerExtension object is created
 void setFormatList(FormatList formatList)
           
 void setHidden(boolean hidden)
           
 void setMetadataURL(BaseURL metadataURL)
           
 void setName(java.lang.String name)
           
 void setQueryable(boolean queryable)
           
 void setServer(Server server)
           
 void setSrs(java.lang.String[] srs)
           
 void setStyleList(StyleList styleList)
           
 void setTitle(java.lang.String title)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Layer

public Layer(Server server,
             java.lang.String name,
             java.lang.String title,
             java.lang.String abstract_,
             java.lang.String[] srs,
             BaseURL dataURL,
             BaseURL metadataURL,
             FormatList formatList,
             StyleList styleList,
             boolean queryable,
             boolean hidden,
             LayerExtension extension)
      throws ContextException
Creates a new ContextLayer object.

Parameters:
server - service from which the named Layer may be requested
name - name of the selected layer (
title - title of the selected layer (
abstract_ - abstract of the selected layer (
srs - list of available SRS for the enclosing layer.
dataURL - contains a link to an online resource where data corresponding to the layer can be found.
metadataURL - contains a link to an online resource where descriptive metadata corresponding to the layer can be found.
formatList - parent element containing the list of available image format for this layer.
styleList - parent element containing the list of available styles for this layer.
queryable -
hidden -
extension - container tag in which arbitrary vendor specific information can be included
Throws:
ContextException
Method Detail

getServer

public Server getServer()
The element defining the service from which the named Layer may be requested

Returns:
The element defining the service from which the named Layer may be requested

getName

public java.lang.String getName()
The name of the selected layer (extracted from Capabilities by the Context document creator).

Returns:
The name of the selected layer (extracted from Capabilities by the Context document creator).

getTitle

public java.lang.String getTitle()
The title of the selected layer (extracted from Capabilities by the Context document creator).

Returns:
The title of the selected layer (extracted from Capabilities by the Context document creator).

getAbstract

public java.lang.String getAbstract()
The abstract of the selected layer (extracted from Capabilities by the Context document creator).

Returns:
The abstract of the selected layer (extracted from Capabilities by the Context document creator).

getSrs

public java.lang.String[] getSrs()
A list of available SRS for the enclosing layer. One of the listed SRS's must be the SRS mentioned in the ViewerContext/General/BoundingBox@SRS element.

Returns:
A list of available SRS for the enclosing layer. One of the listed SRS's must be the SRS mentioned in the ViewerContext/General/BoundingBox@SRS element.

getDataURL

public BaseURL getDataURL()
This element contains a link to an online resource where data corresponding to the layer can be found.

Returns:
a link to an online resource where data corresponding to the layer can be found.

getMetadataURL

public BaseURL getMetadataURL()
This element contains a link to an online resource where descriptive metadata corresponding to the layer can be found.

Returns:
a link to an online resource where descriptive metadata corresponding to the layer can be found.

getFormatList

public FormatList getFormatList()
The parent element containing the list of available image format for this layer. Image formats should be expressed with MIME types as described in WMS 1.1.1 Specification.

A FormatList shall include at least one Format

Returns:
the list of available image format for this layer.

getStyleList

public StyleList getStyleList()
The parent element containing the list of available styles for this layer. A StyleList shall include at least one Style

Returns:
the list of available styles for this layer

getExtension

public LayerExtension getExtension()
The Extension element is a container tag in which arbitrary vendor specific information can be included without compromising the ability of other clients to enforce schema validation.

Returns:
a container tag in which arbitrary vendor specific information can be included

isQueryable

public boolean isQueryable()
Returns:
true if the layer can be queried with a GetFeatureInfo request

isHidden

public boolean isHidden()
Returns:
true if the layer is not visible in the current view

setServer

public void setServer(Server server)
               throws ContextException
Parameters:
server -
Throws:
ContextException

setName

public void setName(java.lang.String name)
             throws ContextException
Parameters:
name -
Throws:
ContextException

setTitle

public void setTitle(java.lang.String title)
              throws ContextException
Parameters:
title -
Throws:
ContextException

setAbstract

public void setAbstract(java.lang.String abstract_)
Parameters:
abstract_ -

setSrs

public void setSrs(java.lang.String[] srs)
Parameters:
srs -

setDataURL

public void setDataURL(BaseURL dataURL)
Parameters:
dataURL -

setMetadataURL

public void setMetadataURL(BaseURL metadataURL)
Parameters:
metadataURL -

setFormatList

public void setFormatList(FormatList formatList)
Parameters:
formatList -

setStyleList

public void setStyleList(StyleList styleList)
Parameters:
styleList -

setQueryable

public void setQueryable(boolean queryable)
Parameters:
queryable -

setHidden

public void setHidden(boolean hidden)
Parameters:
hidden -

setExtension

public void setExtension(LayerExtension extension)
if extension is null, a default LayerExtension object is created

Parameters:
extension -

deegree 2.5 (2011/06/29 09:44 build-8-official)

an open source project founded by lat/lon, Bonn, Germany.
For more information visit: http://www.deegree.org