org.deegree.portal.context
Class LayerExtension

java.lang.Object
  org.deegree.portal.context.LayerExtension

public class LayerExtension
extends java.lang.Object

provides additional information about a layer described in a web map context document. Additional description is not requiered so an instance of org.deegree_impl.clients.context.Layer may doesn't provide an instance of this class.

Version:

$Revision: 20705 $, $Date: 2009-11-11 09:05:38 +0100 (Mi, 11 Nov 2009) $

Author:

Andreas Poth, last edited by: $Author: jmays $

Field Summary

static int	NONE No authentication type
static int	SESSIONID The session id authentication type
static int	USERPASSWORD The user password authentication type

Constructor Summary

LayerExtension()
default constructor

LayerExtension(DataService dataService, boolean masterLayer, double minScaleHint, double maxScaleHint, boolean selectedForQuery, int authentication, int parentNodeId, boolean showLegendGraphic)
Deprecated.

LayerExtension(DataService dataService, boolean masterLayer, double minScaleHint, double maxScaleHint, boolean selectedForQuery, int authentication, int parentNodeId, boolean showLegendGraphic, java.lang.String identifier)
Creates a new LayerExtension object.

Method Summary

void	addVendorspecificParameter(java.lang.String name, java.lang.String value)
int	getAuthentication() returns a code for authentication to be used for service requests
DataService	getDataService() returns a description of the service/server behind a WMS layer.
java.lang.String	getIdentifier()
double	getMaxScaleHint() returns the maximum sclae the layer is valid
double	getMinScaleHint() returns the minimum sclae the layer is valid
int	getParentNodeId() returns true the id of the node to which the layer belongs in the layertree
boolean	getShowLegendGraphic() returns true if the legendGraphic of the layer should be drawn in the layerlistview
java.lang.String	getVendorspecificParameter(java.lang.String name)
java.util.Iterator<java.lang.String>	getVendorspecificParameterNames()
boolean	isMasterLayer()
boolean	isSelectedForQuery() returns true if a layer is currently selected for being active for feature info requests
void	setAuthentication(int authentication)
void	setDataService(DataService dataService) sets a description of the service/server behind a WMS layer.
void	setIdentifier(java.lang.String identifier)
void	setMasterLayer(boolean masterLayer) set to true if a layer is one of the main layers of an application; set to false if it just provides background or additional informations.
void	setMaxScaleHint(double maxScaleHint) sets the maximum scale the layer is valid for
void	setMinScaleHint(double minScaleHint) sets the minimum scale the layer is valid for
void	setParentNodeId(int parentNodeId)
void	setSelectedForQuery(boolean selectedForFI) sets a layer to active for feature info requests
void	setShowLegendGraphic(boolean showLegendGraphic)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

NONE

public static final int NONE

No authentication type

See Also:

Constant Field Values

SESSIONID

public static final int SESSIONID

The session id authentication type

See Also:

Constant Field Values

USERPASSWORD

public static final int USERPASSWORD

The user password authentication type

See Also:

Constant Field Values

Constructor Detail

LayerExtension

public LayerExtension()

default constructor

LayerExtension

@Deprecated
public LayerExtension(DataService dataService,
                                 boolean masterLayer,
                                 double minScaleHint,
                                 double maxScaleHint,
                                 boolean selectedForQuery,
                                 int authentication,
                                 int parentNodeId,
                                 boolean showLegendGraphic)

Deprecated.

This constructor is deprecated. Please use other constructor (with identifier) instead.

Parameters:

dataService -

masterLayer -

minScaleHint -

maxScaleHint -

selectedForQuery -

authentication -

parentNodeId -

showLegendGraphic -

LayerExtension

public LayerExtension(DataService dataService,
                      boolean masterLayer,
                      double minScaleHint,
                      double maxScaleHint,
                      boolean selectedForQuery,
                      int authentication,
                      int parentNodeId,
                      boolean showLegendGraphic,
                      java.lang.String identifier)

Creates a new LayerExtension object.

Parameters:

dataService - description of the service/server behind a WMS layer

masterLayer - true if a layer is one of the main layers of an application; false if it just provides background or additional informations.

minScaleHint -

maxScaleHint -

selectedForQuery -

authentication -

parentNodeId -

showLegendGraphic -

identifier -

Method Detail

getIdentifier

public java.lang.String getIdentifier()

Returns:

the identifier

setIdentifier

public void setIdentifier(java.lang.String identifier)

Parameters:

identifier - the identifier to set

getDataService

public DataService getDataService()

returns a description of the service/server behind a WMS layer. The returned value will be null if the WMS uses an internal mechanism to access a layers data.

Returns:

instance of DataService

setDataService

public void setDataService(DataService dataService)

sets a description of the service/server behind a WMS layer. The returned value will be null if the WMS uses an internal mechanism to access a layers data.

Parameters:

dataService -

isMasterLayer

public boolean isMasterLayer()

Returns:

true if a layer is one of the main layers of an application; returns false if it just provides background or additional informations.

setMasterLayer

public void setMasterLayer(boolean masterLayer)

set to true if a layer is one of the main layers of an application; set to false if it just provides background or additional informations.

Parameters:

masterLayer -

getMaxScaleHint

public double getMaxScaleHint()

returns the maximum sclae the layer is valid

Returns:

maximum scale hint

setMaxScaleHint

public void setMaxScaleHint(double maxScaleHint)

sets the maximum scale the layer is valid for

Parameters:

maxScaleHint -

getMinScaleHint

public double getMinScaleHint()

returns the minimum sclae the layer is valid

Returns:

minimum scale hint

setMinScaleHint

public void setMinScaleHint(double minScaleHint)

sets the minimum scale the layer is valid for

Parameters:

minScaleHint -

isSelectedForQuery

public boolean isSelectedForQuery()

returns true if a layer is currently selected for being active for feature info requests

Returns:

true if a layer is currently selected for being active for feature info requests

setSelectedForQuery

public void setSelectedForQuery(boolean selectedForFI)

sets a layer to active for feature info requests

Parameters:

selectedForFI -

getAuthentication

public int getAuthentication()

returns a code for authentication to be used for service requests

Returns:

a code for authentication to be used for service requests

setAuthentication

public void setAuthentication(int authentication)

Parameters:

authentication -

See Also:

getAuthentication()

getShowLegendGraphic

public boolean getShowLegendGraphic()

returns true if the legendGraphic of the layer should be drawn in the layerlistview

Returns:

true if the legendGraphic of the layer should be drawn in the layerlistview

getParentNodeId

public int getParentNodeId()

returns true the id of the node to which the layer belongs in the layertree

Returns:

true the id of the node to which the layer belongs in the layertree

setShowLegendGraphic

public void setShowLegendGraphic(boolean showLegendGraphic)

Parameters:

showLegendGraphic -

setParentNodeId

public void setParentNodeId(int parentNodeId)

Parameters:

parentNodeId -

addVendorspecificParameter

public void addVendorspecificParameter(java.lang.String name,
                                       java.lang.String value)

Parameters:

name -

value -

getVendorspecificParameter

public java.lang.String getVendorspecificParameter(java.lang.String name)

Parameters:

name -

Returns:

the vendorspecific parameter by given name or null if no such parameter exists.

getVendorspecificParameterNames

public java.util.Iterator<java.lang.String> getVendorspecificParameterNames()

Returns:

an iterator over all vendor specific keys.