ILayer (JMap 7.0 Kathmandu API Documentation)

All Known Subinterfaces:

IEcwLayer, IImageLayer, IRasterLayer, IVectorLayer, IWmsLayer

All Known Implementing Classes:

AdvancedImageLayer, AdvancedImageLayerInfo, EcwLayerInfo, ImageLayer, ImageLayerInfo, Layer, LayerInfo, PersonalLayerInfo, PersonalVectorLayer, RasterLayer, RasterLayerInfo, VectorLayer, VectorLayerInfo, WmsLayer, WmsLayerInfo, WmtsLayer, WmtsLayerInfo
```
public interface ILayer
```

Field Summary

Fields
Modifier and Type Field and Description

static long serialVersionUID

Fields
Modifier and Type	Field and Description
`static long`	`serialVersionUID`

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`java.lang.Object`	`clone()` Returns a deep clone of the current LayerInfo instance.
`java.lang.String`	`getDescription()` Returns the description of the layer.
`java.lang.String`	`getDescription(java.util.Locale locale)` Returns the description of this layer for a specific locale.
`int`	`getDynamicRefresh()` Gets the time at which a layer is automatically refreshed
`K2DElementFactory`	`getElementFactory()`
`int`	`getElementType()`
`Rectangle`	`getExtent()`
`int`	`getId()` Returns the id of the layer.
`JMapClientInfoReportConfig`	`getInfoReportConfig()`
`long`	`getLastUpdateTime()`
`long`	`getLayerProperties()` Returns a bitwise value that contains all layer properties.
`double`	`getMaximumVisibleScale()` Returns the maximum visible scale of the layer.
`java.lang.String`	`getMetadataUrl()`
`double`	`getMinimumVisibleScale()` Returns the minimum visible scale of the layer.
`java.lang.String`	`getName()` Returns the name of the layer.
`java.lang.String`	`getName(java.util.Locale locale)` Returns the name of this layer for a specific locale.
`long`	`getReadOnlyProperties()` Returns the a mask which contains all read-only properties for this layer.
`StyleManager`	`getStyleManager()`
`boolean`	`isDynamic()`
`boolean`	`isIndex()` Returns whether or not this layer should be drawn in the client overview.
`boolean`	`isListed()` Returns the current listed state of the layer.
`boolean`	`isLocal()` Returns the current local state of the layer.
`boolean`	`isSelectable()` Returns the current selectable state of the layer.
`boolean`	`isVisible()` Returns the current visibility state of the layer
`void`	`setDescription(java.lang.String description)` Sets the description of the layer.
`void`	`setDescription(java.lang.String description, java.util.Locale locale)` Sets the description of this layer for the specified Locale.
`void`	`setDynamicRefresh(int seconds)` Sets the time at which a layer is automatically refreshed.
`void`	`setElementFactory(K2DElementFactory elementFactory)`
`void`	`setElementType(int elementType)`
`void`	`setId(int id)` Sets the id of the layer.
`void`	`setIndex(boolean flag)` Sets whether or not this layer should be drawn in the client overview.
`void`	`setInfoReportConfig(JMapClientInfoReportConfig infoReportConfig)`
`void`	`setLastUpdateTime(long lastUpdateTime)`
`void`	`setLayerProperties(long value)` Sets all layer properties.
`void`	`setListed(boolean listed)` Sets the listed state of the layer.
`void`	`setLocal(boolean local)` Sets the local state of the layer.
`void`	`setMaximumVisibleScale(double scale)` Sets the maximum visible scale to set.
`void`	`setMetadataUrl(java.lang.String metadataUrl)`
`void`	`setMinimumVisibleScale(double scale)` Sets the minimum visible scale to set.
`void`	`setName(java.lang.String name)` Sets the name of the layer.
`void`	`setName(java.lang.String name, java.util.Locale locale)` Sets the name of this layer for the specified Locale.
`void`	`setProperty(long property, boolean enabled)` Sets the state for the specified property.
`void`	`setReadOnlyProperties(long value)` Sets all read-only properties for the layer.
`void`	`setReadOnlyProperty(long property, boolean isReadOnly)` Sets the read-only state for the specified property.
`void`	`setSelectable(boolean flag)` Sets the selectable state of the layer.
`void`	`setStyleManager(StyleManager styleManager)`
`void`	`setVisible(boolean flag)` Sets the visibility state of the layer.

- Field Detail
  - serialVersionUID
```
static final long serialVersionUID
```
    See Also:
    
    Constant Field Values
- Method Detail
  - getDescription
```
java.lang.String getDescription()
```
    Returns the description of the layer.
    
    Returns:
    
    the description of the layer.
  - getDescription
```
java.lang.String getDescription(java.util.Locale locale)
```
    Returns the description of this layer for a specific locale.
    
    Parameters:
    
    locale -
    
    Returns:
    
    description.
  - setDescription
```
void setDescription(java.lang.String description)
```
    Sets the description of the layer.
    
    Parameters:
    
    description - the description of the layer.
  - setDescription
```
void setDescription(java.lang.String description,
                    java.util.Locale locale)
```
    Sets the description of this layer for the specified Locale.
    
    Parameters:
    
    description - the new given description.
    
    locale - the locale for this description
  - getName
```
java.lang.String getName()
```
    Returns the name of the layer.
    
    Returns:
    
    the name of the layer.
  - getName
```
java.lang.String getName(java.util.Locale locale)
```
    Returns the name of this layer for a specific locale.
    
    Parameters:
    
    locale -
    
    Returns:
    
    name.
  - setName
```
void setName(java.lang.String name)
```
    Sets the name of the layer.
    
    Parameters:
    
    name - the name of the layer.
  - setName
```
void setName(java.lang.String name,
             java.util.Locale locale)
```
    Sets the name of this layer for the specified Locale.
    
    Parameters:
    
    name - the new given name.
    
    locale - the locale for this name
  - getElementType
```
int getElementType()
```
    Returns:
    
    Returns the elementType.
  - setElementType
```
void setElementType(int elementType)
```
    Parameters:
    
    elementType - The elementType to set.
  - getId
```
int getId()
```
    Returns the id of the layer.
    
    Returns:
    
    the id of the layer.
  - setId
```
void setId(int id)
```
    Sets the id of the layer.
    
    Parameters:
    
    id - the id of the layer.
  - isIndex
```
boolean isIndex()
```
    Returns whether or not this layer should be drawn in the client overview.
    
    Returns:
    
    whether or not this layer should be drawn in the client overview.
    
    See Also:
    
    OverView
  - setIndex
```
void setIndex(boolean flag)
```
    Sets whether or not this layer should be drawn in the client overview.
    
    Parameters:
    
    flag - the new state of the property.
    
    See Also:
    
    OverView
  - getLastUpdateTime
```
long getLastUpdateTime()
```
    Returns:
    
    Returns the lastUpdateTime.
  - setLastUpdateTime
```
void setLastUpdateTime(long lastUpdateTime)
```
    Parameters:
    
    lastUpdateTime - The lastUpdateTime to set.
  - getMaximumVisibleScale
```
double getMaximumVisibleScale()
```
    Returns the maximum visible scale of the layer.
    
    Returns:
    
    the maximum visible scale.
  - setMaximumVisibleScale
```
void setMaximumVisibleScale(double scale)
```
    Sets the maximum visible scale to set.
    
    Parameters:
    
    scale - the maximum visible scale to set.
  - getMinimumVisibleScale
```
double getMinimumVisibleScale()
```
    Returns the minimum visible scale of the layer.
    
    Returns:
    
    the minimum visible scale.
  - setMinimumVisibleScale
```
void setMinimumVisibleScale(double scale)
```
    Sets the minimum visible scale to set.
    
    Parameters:
    
    scale - the minimum visible scale to set.
  - setSelectable
```
void setSelectable(boolean flag)
```
    Sets the selectable state of the layer. Selection tools can check this state using the method getSelectable to determine if this layer should be processed.
    
    Parameters:
    
    flag - if true, the layer will be selectable otherwise not selectable
  - isSelectable
```
boolean isSelectable()
```
    Returns the current selectable state of the layer.
    
    Returns:
    
    true if the layer is selectable, false otherwise
  - getStyleManager
```
StyleManager getStyleManager()
```
    Returns:
    
    Returns the styleManager.
  - setStyleManager
```
void setStyleManager(StyleManager styleManager)
```
    Parameters:
    
    styleManager - the styleManager to set.
  - setListed
```
void setListed(boolean listed)
```
    Sets the listed state of the layer. This flag can be used to determine if the layer should be hidden to the user in a list of layers.
    
    Parameters:
    
    listed - if true, the layer will be a listed layer otherwise a normal layer
  - isListed
```
boolean isListed()
```
    Returns the current listed state of the layer.
    
    Returns:
    
    true if the layer is a listed layer, false otherwise
  - setLocal
```
void setLocal(boolean local)
```
    Sets the local state of the layer. A local layer is generated on the client side and therefore should not generate data requests to the server.
    
    Parameters:
    
    local - if true, the layer will be a local layer otherwise a normal layer
  - isLocal
```
boolean isLocal()
```
    Returns the current local state of the layer.
    
    Returns:
    
    true if the layer is local, false otherwise
  - setVisible
```
void setVisible(boolean flag)
```
    Sets the visibility state of the layer. If a layer is invisible, it is not drawn in a view.
    
    Parameters:
    
    flag - if true, the layer will be visible otherwise invisible
  - isVisible
```
boolean isVisible()
```
    Returns the current visibility state of the layer
    
    Returns:
    
    true if the layer is visible, false otherwise
  - clone
```
java.lang.Object clone()
```
    Returns a deep clone of the current LayerInfo instance.
    
    Returns:
    
    a clone of the current instance.
  - getExtent
```
Rectangle getExtent()
```
  - setReadOnlyProperty
```
void setReadOnlyProperty(long property,
                         boolean isReadOnly)
```
    Sets the read-only state for the specified property.
    
    Parameters:
    
    property - the property to set.
    
    isReadOnly - the read-only state.
  - setProperty
```
void setProperty(long property,
                 boolean enabled)
```
    Sets the state for the specified property.
    
    Parameters:
    
    property - the property to set.
    
    enabled - the property state.
  - getReadOnlyProperties
```
long getReadOnlyProperties()
```
    Returns the a mask which contains all read-only properties for this layer.
    
    Returns:
    
    the mask which defines read-only properties of the layer.
  - setReadOnlyProperties
```
void setReadOnlyProperties(long value)
```
    Sets all read-only properties for the layer.
    
    Parameters:
    
    value - a bitwise value that contains all read-only layer properties.
  - getLayerProperties
```
long getLayerProperties()
```
    Returns a bitwise value that contains all layer properties.
    
    Returns:
    
    a value that contains all layer properties.
  - setLayerProperties
```
void setLayerProperties(long value)
```
    Sets all layer properties.
    
    Parameters:
    
    value - a bitwise value that contains all layer properties.
  - getInfoReportConfig
```
JMapClientInfoReportConfig getInfoReportConfig()
```
    Returns:
    
    Returns the infoReportConfig.
  - setInfoReportConfig
```
void setInfoReportConfig(JMapClientInfoReportConfig infoReportConfig)
```
    Parameters:
    
    infoReportConfig - The infoReportConfig to set.
  - getElementFactory
```
K2DElementFactory getElementFactory()
```
  - setElementFactory
```
void setElementFactory(K2DElementFactory elementFactory)
```
  - getMetadataUrl
```
java.lang.String getMetadataUrl()
```
  - setMetadataUrl
```
void setMetadataUrl(java.lang.String metadataUrl)
```
  - isDynamic
```
boolean isDynamic()
```
    Returns:
    
    true if the layer is dynamic and is automatically refreshed periodically.
    
    Since:
    
    6.5
  - getDynamicRefresh
```
int getDynamicRefresh()
```
    Gets the time at which a layer is automatically refreshed
    
    Returns:
    
    the time in seconds
    
    Since:
    
    6.5
  - setDynamicRefresh
```
void setDynamicRefresh(int seconds)
```
    Sets the time at which a layer is automatically refreshed. A zero or negative value indicates that the layer is not dynamic.
    
    Parameters:
    
    seconds -
    
    Since:
    
    6.5

Interface ILayer

Field Summary

Method Summary

Field Detail

serialVersionUID

Method Detail

getDescription

getDescription

setDescription

setDescription

getName

getName

setName

setName

getElementType

setElementType

getId

setId

isIndex

setIndex

getLastUpdateTime

setLastUpdateTime

getMaximumVisibleScale

setMaximumVisibleScale

getMinimumVisibleScale

setMinimumVisibleScale

setSelectable

isSelectable

getStyleManager

setStyleManager

setListed

isListed

setLocal

isLocal

setVisible

isVisible

clone

getExtent

setReadOnlyProperty

setProperty

getReadOnlyProperties

setReadOnlyProperties

getLayerProperties

setLayerProperties

getInfoReportConfig

setInfoReportConfig

getElementFactory

setElementFactory

getMetadataUrl

setMetadataUrl

isDynamic

getDynamicRefresh

setDynamicRefresh