public class TLcdWMSLayer extends ALcdWMSLayer
ALcdWMSLayer
.
If you want the WMS layer to be advertised such that client applications can include it within their requests you need to do the following.
setName(String)
setName(layerName).setNameVisible(boolean)
setNameVisible(true).true
in all cases.
An example is when you have a layer containing sub-layers as a grouping of related layers in the hierarchy.
If you want the WMS layer to be advertised such that it can be included in GetFeatureInfo
requests you
need to call the method setQueryable(true)
.
Constructor and Description |
---|
TLcdWMSLayer() |
Modifier and Type | Method and Description |
---|---|
void |
addAuthorityURL(ALcdWMSAuthorityURL aAuthorityURL)
Adds a new
ALcdWMSAuthorityURL to this ALcdWMSLayer . |
void |
addChildWMSLayer(ALcdWMSLayer aChildWMSLayer)
Adds a child to this layer.
|
void |
addCoordinateReferenceSystem(String aCoordinateReferenceSystem)
Adds an extra coordinate reference system in which this layer can be visualized.
|
void |
addDataURL(TLcdWMSURL aDataURL)
Adds a new
TLcdWMSURL representing a DataURL to this ALcdWMSLayer . |
void |
addDimension(ALcdWMSDimension aDimension)
Adds a
ALcdWMSDimension to this ALcdWMSLayer . |
void |
addFeatureListURL(TLcdWMSURL aFeatureListURL)
Adds a new
TLcdWMSURL representing a FeatureListURL to this ALcdWMSLayer . |
void |
addIdentifier(TLcdWMSIdentifier aIdentifier)
Adds a
TLcdWMSIdentifier to this ALcdWMSLayer . |
void |
addKeyword(String aKeyword)
Adds a keyword for this layer.
|
void |
addMetadataURL(TLcdWMSURL aMetadataURL)
Adds a new
TLcdWMSURL representing a MetadataURL to this ALcdWMSLayer . |
void |
addStyle(ALcdWMSLayerStyle aWMSStyle)
Adds a style for this
ALcdWMSLayer and its children. |
ALcdWMSLayer |
findWMSLayer(String aLayerName)
Search for a layer in the hierarchy with the requested layer name.
|
String |
getAbstract()
Returns an abstract for this layer.
|
ALcdWMSAuthorityURL |
getAuthorityURL(int aIndex)
Returns the
ALcdWMSAuthorityURL at a given index. |
int |
getAuthorityURLCount()
Returns the number of
ALcdWMSAuthorityURL objects
specified within this ALcdWMSLayer . |
ALcdWMSLayer |
getChildWMSLayer(int aIndex)
Returns the sub-layer at an index.
|
int |
getChildWMSLayerCount()
Returns the number of sub-layers this layer is composed of.
|
int |
getChildWMSLayerIndex(ALcdWMSLayer aLayer)
Returns the index of a child layer in the list.
|
String |
getCoordinateReferenceSystem(int aIndex)
Returns the extra coordinate reference system in which this layer can be displayed.
|
int |
getCoordinateReferenceSystemCount()
Returns the number of extra coordinate reference systems in which this layer can be displayed.
|
TLcdWMSURL |
getDataURL(int aIndex)
Returns the
TLcdWMSURL representing a DataURL at the given index. |
int |
getDataURLCount()
Returns the number of
TLcdWMSURL objects representing DataURLs. |
ALcdWMSDimension |
getDimension(int aIndex)
Returns the dimensional parameter definition at the given index.
|
int |
getDimensionCount()
Returns the number of dimensional parameters associated with this layer (and child layers).
|
TLcdWMSURL |
getFeatureListURL(int aIndex)
Returns the
TLcdWMSURL representing a FeatureListURL at the given index. |
int |
getFeatureListURLCount()
Returns the number of
TLcdWMSURL objects representing FeatureListURLs. |
int |
getFixedHeight()
Returns the fixed height of this layer.
|
int |
getFixedWidth()
Returns the fixed width of this layer.
|
TLcdWMSIdentifier |
getIdentifier(int aIndex)
Returns the
TLcdWMSIdentifier at a given index. |
int |
getIdentifierCount()
Returns the number of
TLcdWMSIdentifier of this ALcdWMSLayer . |
String |
getKeyword(int aIndex)
Returns the keyword at the given index.
|
int |
getKeywordCount()
Returns the number of keywords.
|
double |
getMaxScaleDenominator()
Returns the max scale denominator range value.
|
TLcdWMSURL |
getMetadataURL(int aIndex)
Returns the
TLcdWMSURL representing a MetadataURL at the given index. |
int |
getMetadataURLCount()
Returns the number of
TLcdWMSURL objects representing MetadataURLs. |
double |
getMinScaleDenominator()
Returns the min scale denominator range value.
|
String |
getName()
Returns the name of this layer.
|
Object |
getProperty(String aKey)
Searches the property with the specified key.
|
Object |
getProperty(String aKey,
Object aDefaultValue)
Searches the property with the specified key.
|
String |
getSourceName()
Returns the source name of the data for this layer.
|
String |
getTitle()
Returns the title of this layer.
|
ILcdBounds |
getWGS84LonLatBounds()
Returns the bounding box of this layer in WGS84.
|
ALcdWMSLayerStyle |
getWMSLayerStyle(int aIndex)
Returns one of the new styles defined by this layer (for the specific index).
|
int |
getWMSLayerStyleCount()
Returns the number of new styles this layer defines.
|
boolean |
isNameVisible()
Each layer has a key, but this might not be visible to the
WMS user (if the implementor of the WMS service does not want the
layer to be retrievable).
|
boolean |
isNoSubsets()
Returns the value of the 'noSubsets' parameter of this layer.
|
Boolean |
isOpaque()
Returns whether the layer represents map data that is mostly or completely opaque.
|
boolean |
isQueryable()
Returns if the layer has extra (meta) information available.
|
void |
moveLayerAt(ALcdWMSLayer aChildWMSLayer,
int aIndex)
Moves a child layer to a different position in the list.
|
void |
putProperty(String aKey,
Object aObject)
Maps the specified key to the specified object.
|
void |
removeChildWMSLayer(ALcdWMSLayer aChildWMSLayer)
Removes a child from this layer.
|
void |
removeDimension(ALcdWMSDimension aDimension)
Removes the given
ALcdWMSDimension from this ALcdWMSLayer . |
void |
setAbstract(String aAbstract)
Sets the abstract for this layer.
|
void |
setFixedHeight(int aFixedHeight)
Sets the fixed height of this layer.
|
void |
setFixedWidth(int aFixedWidth)
Sets the fixed width of this layer.
|
void |
setLatLonBoundingBox(ILcdBounds aLatLonBoundingBox)
Sets the lonlatbounds (WGS 84) of the layer.
|
void |
setMaxScaleDenominator(double aMaxScaleDenominator)
Sets the maximum scale denominator value.
|
void |
setMinScaleDenominator(double aMinScaleDenominator)
Sets the minimum scale denominator value.
|
void |
setName(String aName)
Sets the name of the layer.
|
void |
setNameVisible(boolean aNameVisible)
Sets if the name is visible or not.
|
void |
setNoSubsets(boolean aNoSubsets)
Sets the value of the 'noSubsets' parameter of this layer.
|
void |
setOpaque(Boolean aOpaque)
Sets whether the layer is opaque or not.
|
void |
setQueryable(boolean aQueryable)
Sets whether the layer is queryable or not.
|
void |
setSourceName(String aSourceName)
Sets the sourcename of the layer.
|
void |
setTitle(String aTitle)
Sets the title of the layer.
|
getCascadeCount, getExpiryDate, getModificationDate, getParentWMSLayer, getUpdateSequence, setExpiryDate, setModificationDate, setParentLayer, setUpdateSequence
public String getTitle()
ALcdWMSLayer
getTitle
in class ALcdWMSLayer
public String getName()
ALcdWMSLayer
getName
in class ALcdWMSLayer
public boolean isNameVisible()
ALcdWMSLayer
isNameVisible
in class ALcdWMSLayer
public ILcdBounds getWGS84LonLatBounds()
ALcdWMSLayer
getWGS84LonLatBounds
in class ALcdWMSLayer
ILcdBounds
containing the lon lat bounding box.public boolean isQueryable()
ALcdWMSLayer
queryable
property has the value false
client applications cannot make GetFeatureInfo
requests on this WMS layer.isQueryable
in class ALcdWMSLayer
public Boolean isOpaque()
ALcdWMSLayer
null
is returned.isOpaque
in class ALcdWMSLayer
Boolean.TRUE
if the layer represents map data that is mostly or completely opaque.public int getChildWMSLayerCount()
ALcdWMSLayer
getChildWMSLayerCount
in class ALcdWMSLayer
public ALcdWMSLayer getChildWMSLayer(int aIndex) throws IndexOutOfBoundsException
ALcdWMSLayer
getChildWMSLayer
in class ALcdWMSLayer
aIndex
- the index of the sub-layer.IndexOutOfBoundsException
- in case of an invalid index.public String getSourceName()
ALcdWMSLayer
getSourceName
in class ALcdWMSLayer
public int getAuthorityURLCount()
ALcdWMSLayer
ALcdWMSAuthorityURL
objects
specified within this ALcdWMSLayer
.getAuthorityURLCount
in class ALcdWMSLayer
ALcdWMSAuthorityURL
objects
specified within this ALcdWMSLayer
.public ALcdWMSAuthorityURL getAuthorityURL(int aIndex) throws IndexOutOfBoundsException
ALcdWMSLayer
ALcdWMSAuthorityURL
at a given index.getAuthorityURL
in class ALcdWMSLayer
aIndex
- the index of the ALcdWMSAuthorityURL
.ALcdWMSAuthorityURL
at a given index.IndexOutOfBoundsException
- if the index value is invalid.public void addAuthorityURL(ALcdWMSAuthorityURL aAuthorityURL)
ALcdWMSAuthorityURL
to this ALcdWMSLayer
.
It can be referred to by this ALcdWMSLayer
and its children.aAuthorityURL
- the authority URL to add.public int getMetadataURLCount()
ALcdWMSLayer
TLcdWMSURL
objects representing MetadataURLs.
By default, 0 is returned.getMetadataURLCount
in class ALcdWMSLayer
TLcdWMSURL
objects representing MetadataURLs.public TLcdWMSURL getMetadataURL(int aIndex) throws IndexOutOfBoundsException
ALcdWMSLayer
TLcdWMSURL
representing a MetadataURL at the given index.
By default, no MetaDataURLs are available and an
IndexOutOfBoundsException
will be thrown.getMetadataURL
in class ALcdWMSLayer
aIndex
- the index of the TLcdWMSURL
representing a MetadataURL.TLcdWMSURL
representing a MetadataURL at the given index.IndexOutOfBoundsException
- if the index value is invalid.public void addMetadataURL(TLcdWMSURL aMetadataURL)
TLcdWMSURL
representing a MetadataURL to this ALcdWMSLayer
.
It can be referred to by this ALcdWMSLayer
and its children.aMetadataURL
- the TLcdWMSURL
representing a MetadataURL to add.public int getDataURLCount()
ALcdWMSLayer
TLcdWMSURL
objects representing DataURLs.
By default, 0 is returned.getDataURLCount
in class ALcdWMSLayer
TLcdWMSURL
objects representing DataURLs.public TLcdWMSURL getDataURL(int aIndex) throws IndexOutOfBoundsException
ALcdWMSLayer
TLcdWMSURL
representing a DataURL at the given index.
By default, no DataURLs are available and an
IndexOutOfBoundsException
will be thrown.getDataURL
in class ALcdWMSLayer
aIndex
- the index of the TLcdWMSURL
representing a DataURL.TLcdWMSURL
representing a DataURL at the given index.IndexOutOfBoundsException
- if the index value is invalid.public void addDataURL(TLcdWMSURL aDataURL)
TLcdWMSURL
representing a DataURL to this ALcdWMSLayer
.
It can be referred to by this ALcdWMSLayer
and its children.aDataURL
- the TLcdWMSURL
representing a DataURL to add.public int getFeatureListURLCount()
ALcdWMSLayer
TLcdWMSURL
objects representing FeatureListURLs.
By default, 0 is returned.getFeatureListURLCount
in class ALcdWMSLayer
TLcdWMSURL
objects representing FeatureListURLs.public TLcdWMSURL getFeatureListURL(int aIndex) throws IndexOutOfBoundsException
ALcdWMSLayer
TLcdWMSURL
representing a FeatureListURL at the given index.
By default, no FeatureListURLs are available and an
IndexOutOfBoundsException
will be thrown.getFeatureListURL
in class ALcdWMSLayer
aIndex
- the index of the TLcdWMSURL
representing a FeatureListURL.TLcdWMSURL
representing a FeatureListURL at the given index.IndexOutOfBoundsException
- if the index value is invalid.public void addFeatureListURL(TLcdWMSURL aFeatureListURL)
TLcdWMSURL
representing a FeatureListURL to this ALcdWMSLayer
.
It can be referred to by this ALcdWMSLayer
and its children.aFeatureListURL
- the TLcdWMSURL
representing a FeatureListURL to add.public int getIdentifierCount()
ALcdWMSLayer
TLcdWMSIdentifier
of this ALcdWMSLayer
.getIdentifierCount
in class ALcdWMSLayer
TLcdWMSIdentifier
of this ALcdWMSLayer
.public TLcdWMSIdentifier getIdentifier(int aIndex) throws IndexOutOfBoundsException
ALcdWMSLayer
TLcdWMSIdentifier
at a given index.getIdentifier
in class ALcdWMSLayer
aIndex
- the index of the TLcdWMSIdentifier
.TLcdWMSIdentifier
at a given index.IndexOutOfBoundsException
- if the index value is invalid.public void addIdentifier(TLcdWMSIdentifier aIdentifier)
TLcdWMSIdentifier
to this ALcdWMSLayer
.
It is not inherited from the parent ALcdWMSLayer
.
The authority name of the Identifier should be defined within this
ALcdWMSLayer
or one of its ancestors.aIdentifier
- the identifier object.public int getDimensionCount()
ALcdWMSLayer
getDimensionCount
in class ALcdWMSLayer
public ALcdWMSDimension getDimension(int aIndex) throws IndexOutOfBoundsException
ALcdWMSLayer
IndexOutOfBoundsException
will be thrown.getDimension
in class ALcdWMSLayer
aIndex
- The index of the dimensional parameter to be retrieved.IndexOutOfBoundsException
- if invalid index.public void addDimension(ALcdWMSDimension aDimension)
ALcdWMSDimension
to this ALcdWMSLayer
.aDimension
- the dimensional parameter to add.public void removeDimension(ALcdWMSDimension aDimension)
ALcdWMSDimension
from this ALcdWMSLayer
.aDimension
- the dimensional parameter to remove.public void setTitle(String aTitle)
aTitle
- a String
containing the title.getTitle.
public void setName(String aName)
aName
- a String
containing the name.getName.
public void setNameVisible(boolean aNameVisible)
aNameVisible
- a boolean
changing the name visibility.public String getAbstract()
ALcdWMSLayer
getAbstract
in class ALcdWMSLayer
public void setAbstract(String aAbstract)
aAbstract
- the abstract of this layer.getAbstract()
public void setLatLonBoundingBox(ILcdBounds aLatLonBoundingBox)
aLatLonBoundingBox
- a ILcdBounds
containing the lonlatbounds.getLonLatBoundingBox.
public void setQueryable(boolean aQueryable)
aQueryable
- a boolean
indicating whether the layer is queryable or not.public void setOpaque(Boolean aOpaque)
aOpaque
- a Boolean
indicating whether the layer is opaque or not.public void addChildWMSLayer(ALcdWMSLayer aChildWMSLayer)
aChildWMSLayer
- an ALcdWMSLayer
that is a child of this layer.public void removeChildWMSLayer(ALcdWMSLayer aChildWMSLayer)
aChildWMSLayer
- an ALcdWMSLayer
that is a child of this layer.public void moveLayerAt(ALcdWMSLayer aChildWMSLayer, int aIndex)
aChildWMSLayer
- an ALcdWMSLayer
that is a child of this layer.aIndex
- the new list index to which the child layer should be moved.public int getChildWMSLayerIndex(ALcdWMSLayer aLayer)
aLayer
- an ALcdWMSLayer
.public void setSourceName(String aSourceName)
aSourceName
- a String
containing the source name.getSourceName.
public int getWMSLayerStyleCount()
ALcdWMSLayer
getWMSLayerStyleCount
in class ALcdWMSLayer
public ALcdWMSLayerStyle getWMSLayerStyle(int aIndex) throws IndexOutOfBoundsException
ALcdWMSLayer
getWMSLayerStyle
in class ALcdWMSLayer
aIndex
- index of the new style to return.IndexOutOfBoundsException
- in case of an invalid index.public void addStyle(ALcdWMSLayerStyle aWMSStyle)
ALcdWMSLayer
and its children.aWMSStyle
- an additional style for this ALcdWMSLayer
and its children.public void putProperty(String aKey, Object aObject)
ALcdWMSLayer
putProperty
in class ALcdWMSLayer
aKey
- the key to use for the property list.aObject
- the value corresponding to the key.public Object getProperty(String aKey)
ALcdWMSLayer
getProperty
in class ALcdWMSLayer
aKey
- the key to search for.public Object getProperty(String aKey, Object aDefaultValue)
ALcdWMSLayer
getProperty
in class ALcdWMSLayer
aKey
- the key to search for.aDefaultValue
- the default value to return if no property is found with the specified key.public int getCoordinateReferenceSystemCount()
ALcdWMSLayer
getCoordinateReferenceSystemCount
in class ALcdWMSLayer
public String getCoordinateReferenceSystem(int aIndex) throws IndexOutOfBoundsException
ALcdWMSLayer
getCoordinateReferenceSystem
in class ALcdWMSLayer
aIndex
- the index of the extra coordinate reference system.IndexOutOfBoundsException
- if the index value is invalid.public void addCoordinateReferenceSystem(String aCoordinateReferenceSystem)
aCoordinateReferenceSystem
- the coordinate reference system to add (formatted as a string).public double getMinScaleDenominator()
ALcdWMSLayer
getMinScaleDenominator
in class ALcdWMSLayer
public void setMinScaleDenominator(double aMinScaleDenominator)
aMinScaleDenominator
- the new min scale denominator value.getMinScaleDenominator()
public double getMaxScaleDenominator()
ALcdWMSLayer
getMaxScaleDenominator
in class ALcdWMSLayer
public void setMaxScaleDenominator(double aMaxScaleDenominator)
aMaxScaleDenominator
- the new max scale denominator value.getMaxScaleDenominator()
public int getKeywordCount()
ALcdWMSLayer
getKeywordCount
in class ALcdWMSLayer
public String getKeyword(int aIndex) throws IndexOutOfBoundsException
ALcdWMSLayer
getKeyword
in class ALcdWMSLayer
aIndex
- the index of the keyword to return.IndexOutOfBoundsException
- if invalid index.public void addKeyword(String aKeyword)
aKeyword
- A keyword for this layer.public void setNoSubsets(boolean aNoSubsets)
aNoSubsets
- the new boolean value for the 'noSubsets' parameter.public void setFixedWidth(int aFixedWidth)
aFixedWidth
- A positive value for the fixed width, 0 if the layer has no fixed width.public void setFixedHeight(int aFixedHeight)
aFixedHeight
- A positive value for the fixed height, 0 if the layer has no fixed height.public boolean isNoSubsets()
ALcdWMSLayer
isNoSubsets
in class ALcdWMSLayer
public int getFixedWidth()
ALcdWMSLayer
getFixedWidth
in class ALcdWMSLayer
public int getFixedHeight()
ALcdWMSLayer
getFixedHeight
in class ALcdWMSLayer
public ALcdWMSLayer findWMSLayer(String aLayerName)
ALcdWMSLayer
findWMSLayer
in class ALcdWMSLayer
aLayerName
- the name of the layer searched for.null
otherwise.