|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
ObjectLayer
public class Layer
Nested list of zero or more map Layers offered by this server. It contains only fields for information that we currently find interesting. Feel free to add your own.
Constructor Summary | |
---|---|
Layer()
Crate a layer with no human readable title. |
|
Layer(String title)
Create a layer with an optional title |
Method Summary | |
---|---|
void |
addChildren(Layer child)
|
void |
clearCache()
Called to clear the internal cache of this layer; and any children. |
int |
compareTo(Layer layer)
|
String |
get_abstract()
The abstract contains human-readable information about this layer |
Map<String,CRSEnvelope> |
getBoundingBoxes()
Returns every BoundingBox associated with this layer. |
Layer[] |
getChildren()
|
Dimension |
getDimension(String name)
Look up a Dimension; note this looks up any parent supplied definitions as well |
Map<String,Dimension> |
getDimensions()
The dimensions valid for this layer. |
GeneralEnvelope |
getEnvelope(CoordinateReferenceSystem crs)
Look up an envelope for the provided CoordianteReferenceSystem. |
Extent |
getExtent(String name)
Look up an extent by name; search includes all parent extent definitions. |
Map<String,Extent> |
getExtents()
The Extents valid for this layer; this includes both extents defined by this layer and all extents contributed by parent layers. |
String[] |
getKeywords()
Keywords are Strings to be used in searches |
CRSEnvelope |
getLatLonBoundingBox()
Returns the LatLonBoundingBox for this layer. |
List<CRSEnvelope> |
getLayerBoundingBoxes()
Get the BoundingBoxes associated with this layer. |
List<Layer> |
getLayerChildren()
List of children. |
List<Dimension> |
getLayerDimensions()
Direct access to the dimensions contributed by this Layer. |
List<Extent> |
getLayerExtents()
The Extents contributed by this Layer. |
String |
getName()
Gets the name of the Layer . |
Layer |
getParent()
DOCUMENT ME! |
double |
getScaleDenominatorMax()
Max scale denominator for which it is appropriate to draw this layer. |
double |
getScaleDenominatorMin()
Min scale denominator for which it is appropriate to draw this layer. |
double |
getScaleHintMax()
Deprecated. Use getScaleDenomiatorMax() as there is less confusion over meaning |
double |
getScaleHintMin()
Deprecated. Use getScaleDenomiatorMin() as there is less confusion over meaning |
Set<String> |
getSrs()
Accumulates all of the srs/crs specified for this layer and all srs/crs inherited from its ancestors. |
List<StyleImpl> |
getStyles()
Accumulates all of the styles specified for this layer and all styles inherited from its ancestors. |
String |
getTitle()
|
boolean |
isQueryable()
Determines if this layer is queryable. |
void |
set_abstract(String _abstract)
|
void |
setBoundingBoxes(CRSEnvelope boundingBox)
|
void |
setBoundingBoxes(Map<String,CRSEnvelope> boundingBoxes)
Sets this layer's bounding boxes. |
void |
setChildren(Layer[] childrenArray)
|
void |
setDimensions(Collection<Dimension> dimensionList)
|
void |
setDimensions(Dimension dimension)
|
void |
setDimensions(Map<String,Dimension> dimensionMap)
|
void |
setExtents(Collection<Extent> extentList)
|
void |
setExtents(Extent extent)
|
void |
setExtents(Map<String,Extent> extentMap)
|
void |
setKeywords(String[] keywords)
|
void |
setLatLonBoundingBox(CRSEnvelope latLonBoundingBox)
|
void |
setName(String name)
Sets the name of this layer. |
void |
setParent(Layer parentLayer)
Set the parent; child will be added to the parents list of children (if it is not already). |
void |
setQueryable(boolean queryable)
|
void |
setScaleDenominatorMax(double scaleDenominatorMax)
Max scale denominator for which it is appropriate to draw this layer. |
void |
setScaleDenominatorMin(double scaleDenominatorMin)
Min scale denominator for which it is appropriate to draw this layer. |
void |
setScaleHintMax(double scaleHintMax)
Deprecated. Use setScaleDenomiatorMax() as there is less confusion over meaning |
void |
setScaleHintMin(double scaleHintMin)
Deprecated. Use setScaleDenomiatorMin() as there is less confusion over meaning |
void |
setSrs(Set<String> srs)
|
void |
setStyles(List<StyleImpl> styles)
|
void |
setTitle(String title)
|
String |
toString()
|
Methods inherited from class Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public Layer()
These layers are simply for organization and storage of common settings (like SRS or style settings). These settings will be valid for all children.
public Layer(String title)
title
- Method Detail |
---|
public void clearCache()
public List<CRSEnvelope> getLayerBoundingBoxes()
If you modify the contents of this List please call clearCache() so that the getBoundingBoxes() method can return the correct combination of this list and the parent bounding boxes.
public Map<String,CRSEnvelope> getBoundingBoxes()
HashMap
returned has
each bounding box's SRS Name (usually an EPSG code) value as the key, and the value is the
BoundingBox
object itself.
Implements inheritance: if this layer's bounding box is null, query ancestors until the first
bounding box is found or no more ancestors
public void setBoundingBoxes(CRSEnvelope boundingBox)
public void setBoundingBoxes(Map<String,CRSEnvelope> boundingBoxes)
BoundingBox
object as its value.
boundingBoxes
- a HashMap containing bounding boxespublic List<Dimension> getLayerDimensions()
getDimensions()
public Map<String,Dimension> getDimensions()
public void setDimensions(Map<String,Dimension> dimensionMap)
public void setDimensions(Collection<Dimension> dimensionList)
public void setDimensions(Dimension dimension)
public Dimension getDimension(String name)
public List<Extent> getLayerExtents()
Please note that for the complete list of Extents valid for this layer you should use the getExtents() mehtod which will consider extents defined as part of a Dimension and all those contributed by Parent layers.
This is an accessor; if you modify the provided list please call clearCache().
public Map<String,Extent> getExtents()
In keeping with the WMS 1.3.0 specification some extents may be defined as part of a Dimension definition.
public Extent getExtent(String name)
name
-
public void setExtents(Map<String,Extent> extentMap)
public void setExtents(Collection<Extent> extentList)
public void setExtents(Extent extent)
public String getName()
Layer
. It is designed to be machine readable, and if it is
present, this layer is determined to be drawable and is a valid candidate for use in a GetMap
or GetFeatureInfo request.
public void setName(String name)
name
- the layer's new namepublic Set<String> getSrs()
public void setSrs(Set<String> srs)
public List<StyleImpl> getStyles()
public void setStyles(List<StyleImpl> styles)
public String getTitle()
public void setTitle(String title)
public boolean isQueryable()
public void setQueryable(boolean queryable)
public int compareTo(Layer layer)
compareTo
in interface Comparable<Layer>
public Layer getParent()
public void setParent(Layer parentLayer)
parent
- The parent to set.public CRSEnvelope getLatLonBoundingBox()
public void setLatLonBoundingBox(CRSEnvelope latLonBoundingBox)
public List<Layer> getLayerChildren()
public Layer[] getChildren()
public void setChildren(Layer[] childrenArray)
public void addChildren(Layer child)
public String get_abstract()
public void set_abstract(String _abstract)
_abstract
- The _abstract to set.public String[] getKeywords()
public void setKeywords(String[] keywords)
keywords
- The keywords to set.public void setScaleDenominatorMax(double scaleDenominatorMax)
Scale denominator is calculated based on the bounding box of the central pixel in a request (ie not a scale based on real world size of the entire layer).
Max
- scale denominator for which it is approprirate to draw this layerpublic double getScaleDenominatorMax()
Scale denominator is calculated based on the bounding box of the central pixel in a request (ie not a scale based on real world size of the entire layer).
Some web map servers will refuse to render images at a scale greater than the value provided here.
return Max scale denominator for which it is appropriate to draw this layer.
public void setScaleDenominatorMin(double scaleDenominatorMin)
Scale denominator is calculated based on the bounding box of the central pixel in a request (ie not a scale based on real world size of the entire layer).
Min
- scale denominator for which it is appropriate to draw this layerpublic double getScaleDenominatorMin()
Scale denominator is calculated based on the bounding box of the central pixel in a request (ie not a scale based on real world size of the entire layer).
Some web map servers will refuse to render images at a scale less than the value provided here.
return Min scale denominator for which it is appropriate to draw this layer
public double getScaleHintMax()
We assume this calculation is done in a similar manner to getScaleDenominatorMax(); but a look at common web services such as JPL show this not to be the case.
public void setScaleHintMax(double scaleHintMax)
We assume this calculation is done in a similar manner to setScaleDenominatorMax(); but a look at common web services such as JPL show this not to be the case.
The
- second scale hint value (understood to mean the max value)public double getScaleHintMin()
We assume this calculation is done in a similar manner to getScaleDenominatorMin(); but a look at common web services such as JPL show this not to be the case.
public void setScaleHintMin(double scaleHintMin)
We assume this calculation is done in a similar manner to setScaleDenominatorMin(); but a look at common web services such as JPL show this not to be the case.
param The first scale hint value (understood to mean the min value)
public GeneralEnvelope getEnvelope(CoordinateReferenceSystem crs)
Please note that the lookup is preformed based on the SRS Name of the provided CRS which is assumed to be one of its identifiers.
This method returns the first envelope found; this may not be valid for sparse data sets that indicate data location using multiple envelopes for a provided CRS.
crs
-
public String toString()
toString
in class Object
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |