com.ontimize.util.gis.common.interfaces
Interface IGisLayer

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

DefaultGisLayer

public interface IGisLayer
extends java.io.Serializable

Gis layer interface

Field Summary

static int	LAYER_NOT_VALID_DATA_PROVIDER_ERROR
static int	LAYER_NOT_VALID_OUT_OF_SCALE
static int	LAYER_VALID

Method Summary

void	addParameter(java.lang.String name, java.lang.Object value) Add a new parameter to the actual layer
java.lang.Object	clone() Get a copy of the current layer
java.lang.String	getAttribute() Get the layer identifier
java.lang.Object	getBoundingBox() Get the layer initial area
java.lang.Object	getCRS() Get the layer coordinate reference system
java.lang.Object	getDataProviderDefinition() Get the layer data provider definition, usually with the interface IDataProviderDefinition
java.lang.Object	getDefinedFilters() Get layer filters Layer defined filters
java.lang.String	getDescription() Get the layer description
int	getInvalidCause() Get the layer valid state cause
java.util.Hashtable	getLayerParameters() Get the layer extra definition parameters
java.lang.String	getName() Get the layer name
IGisViewerOnMouseClickAction	getOnMouseClickAction() Get the layer onMouseClickAction event action listener
IGisViewerOnMouseOverAction	getOnMouseOverAction() Get the layer onMouseOver event action listener
java.lang.Object	getParameter(java.lang.String name) Get the actual layer parameter
java.util.Hashtable	getParentKeys() Get the actual defined parent keys map
java.util.Hashtable	getStaticKeys() Get all the static keys defined for the actual layer
java.lang.Object	getStyleDefinition() Get the actual layer style definition, usually with the interface IGisStyleDefinition
java.lang.String	getXMLDescription() Get the layer xml description
boolean	isClientSide() Get layer "client side" state
boolean	isEditable() Get the layer edition state
boolean	isLocal() Get layer local state on / off.
boolean	isLockedOnEdition() Check if the current layer is locked on edition or not.
boolean	isLockedOnSelection() Check if the current layer is locked on selection or not.
boolean	isSelectable() Get the layer selection state
boolean	isValid() Get the layer valid states
boolean	isVisible() Get the layer visibility state
void	lockEdition(boolean editLocked) Set the edition lock state for the current layer
void	lockSelection(boolean selectLocked) Set the selection lock state for the current layer
void	removeParentKeys() Remove the layer parent keys
void	setAttribute(java.lang.String attribute) Set the main identifier for the gis layer
void	setBoundingBox(java.lang.Object boundingBox) Set the layer initial area
void	setClientSide(boolean clientSide) Set layer "client side" state on / off.
void	setCRS(java.lang.Object crs) Set the actual layer base coordinate reference system
void	setDataProviderDefinition(java.lang.Object providerDefinition) Set the layer data provider definition
void	setDefinedFilters(java.lang.Object filters) Set layer filters for data presentation filtering on gis panel
void	setDescription(java.lang.String description) Set the layer description
void	setEditable(boolean editable) Set the layer edition enabled/disabled
void	setLayerParameters(java.util.Hashtable parameters) Set the extra layer parameters
void	setLocal(boolean local) Set layer local state on / off.
void	setName(java.lang.String name) Set the layer name
void	setOnMouseClickAction(IGisViewerOnMouseClickAction onMouseClickAction) Set onMouseClickAction event action listener
void	setOnMouseOverAction(IGisViewerOnMouseOverAction onMouseOverAction) Set onMouseOver event action listener
void	setParentKey(java.lang.Object formField, java.lang.Object layerField) Add a new layer parent key.
void	setSelectable(boolean selectable) Set the layer selection enabled/disabled
void	setStaticKey(java.lang.Object layerField, java.lang.Object value) Set a static key for the actual layer
void	setStyleDefinition(java.lang.Object styleDefinition) Set the acutal layer style definition
void	setValid(boolean valid, int cause) Set the layer actual valid state
void	setVisible(boolean visible) Set the layer visibility on/off

Field Detail

LAYER_VALID

static final int LAYER_VALID

See Also:

Constant Field Values

LAYER_NOT_VALID_OUT_OF_SCALE

static final int LAYER_NOT_VALID_OUT_OF_SCALE

See Also:

Constant Field Values

LAYER_NOT_VALID_DATA_PROVIDER_ERROR

static final int LAYER_NOT_VALID_DATA_PROVIDER_ERROR

See Also:

Constant Field Values

Method Detail

setAttribute

void setAttribute(java.lang.String attribute)

Set the main identifier for the gis layer

Parameters:

attribute - Layer identifier

getAttribute

java.lang.String getAttribute()

Get the layer identifier

Returns:

Layer identifier

setName

void setName(java.lang.String name)

Set the layer name

Parameters:

name - Layer name

getName

java.lang.String getName()

Get the layer name

Returns:

Layer name

setDescription

void setDescription(java.lang.String description)

Set the layer description

Parameters:

description - Layer description

getDescription

java.lang.String getDescription()

Get the layer description

Returns:

Layer description

setCRS

void setCRS(java.lang.Object crs)

Set the actual layer base coordinate reference system

Parameters:

crs - Coordinate Reference System

getCRS

java.lang.Object getCRS()

Get the layer coordinate reference system

Returns:

Coordinate Reference System

setBoundingBox

void setBoundingBox(java.lang.Object boundingBox)

Set the layer initial area

Parameters:

boundingBox - Layer initial bounding box

getBoundingBox

java.lang.Object getBoundingBox()

Get the layer initial area

Returns:

Layer initial bounding box

setDefinedFilters

void setDefinedFilters(java.lang.Object filters)

Set layer filters for data presentation filtering on gis panel

Parameters:

filters - Layer defined filters array

getDefinedFilters

java.lang.Object getDefinedFilters()

Get layer filters Layer defined filters

Returns:

Layer defined filters array

setStaticKey

void setStaticKey(java.lang.Object layerField,
                  java.lang.Object value)

Set a static key for the actual layer

Parameters:

layerField - Layer field that will use the static key

value - Static key value

getStaticKeys

java.util.Hashtable getStaticKeys()

Get all the static keys defined for the actual layer

Returns:

Map of the layer static keys

getStyleDefinition

java.lang.Object getStyleDefinition()

Get the actual layer style definition, usually with the interface IGisStyleDefinition

Returns:

Layer style definition

setStyleDefinition

void setStyleDefinition(java.lang.Object styleDefinition)

Set the acutal layer style definition

Parameters:

styleDefinition - Layer style definition

getDataProviderDefinition

java.lang.Object getDataProviderDefinition()

Get the layer data provider definition, usually with the interface IDataProviderDefinition

Returns:

Data provider definition

setDataProviderDefinition

void setDataProviderDefinition(java.lang.Object providerDefinition)

Set the layer data provider definition

Parameters:

providerDefinition - Data provider definition

setLayerParameters

void setLayerParameters(java.util.Hashtable parameters)

Set the extra layer parameters

Parameters:

parameters - Layer parameters Hashtable

getLayerParameters

java.util.Hashtable getLayerParameters()

Get the layer extra definition parameters

Returns:

Layer parameters

addParameter

void addParameter(java.lang.String name,
                  java.lang.Object value)

Add a new parameter to the actual layer

Parameters:

name - Parameter name

value - Parameter value

getParameter

java.lang.Object getParameter(java.lang.String name)

Get the actual layer parameter

Parameters:

name - Parameter name

Returns:

Parameter value

setVisible

void setVisible(boolean visible)

Set the layer visibility on/off

Parameters:

visible - Layer visibility

isVisible

boolean isVisible()

Get the layer visibility state

Returns:

Layer visibility

setOnMouseOverAction

void setOnMouseOverAction(IGisViewerOnMouseOverAction onMouseOverAction)

Set onMouseOver event action listener

Parameters:

onMouseOverAction - Action to do when the mouse is over a layer element

getOnMouseOverAction

IGisViewerOnMouseOverAction getOnMouseOverAction()

Get the layer onMouseOver event action listener

Returns:

Action to do when the mouse is over a layer element

setOnMouseClickAction

void setOnMouseClickAction(IGisViewerOnMouseClickAction onMouseClickAction)

Set onMouseClickAction event action listener

Parameters:

onMouseClickAction - Action to do when a layer element is clicked

getOnMouseClickAction

IGisViewerOnMouseClickAction getOnMouseClickAction()

Get the layer onMouseClickAction event action listener

Returns:

Action to do when a layer element is clicked

setSelectable

void setSelectable(boolean selectable)

Set the layer selection enabled/disabled

Parameters:

selectable - Selection state

isSelectable

boolean isSelectable()

Get the layer selection state

Returns:

Selection state

setEditable

void setEditable(boolean editable)

Set the layer edition enabled/disabled

Parameters:

editable - Edition state

isEditable

boolean isEditable()

Get the layer edition state

Returns:

Edition state

setLocal

void setLocal(boolean local)

Set layer local state on / off. Local layers are commonly used to insert data into the gis panel directly from the form interaction manager

Parameters:

local - Layer local state

isLocal

boolean isLocal()

Get layer local state on / off. Local layers are commonly used to insert data into the gis panel directly from the form interaction manager; like preprocessed data

Returns:

Layer local state

setClientSide

void setClientSide(boolean clientSide)

Set layer "client side" state on / off. Layers on client side send their data request to a local gis data manager and not to the gis server; this allow to reduce server traffic.

Parameters:

clientSide - Client side state

isClientSide

boolean isClientSide()

Get layer "client side" state

Returns:

Client side state

setParentKey

void setParentKey(java.lang.Object formField,
                  java.lang.Object layerField)

Add a new layer parent key.

Parameters:

formField - Field name of the gis component parent form used as parent key

layerField - Field name of the layer column used to filter by parent key

getParentKeys

java.util.Hashtable getParentKeys()

Get the actual defined parent keys map

Returns:

Layer parent keys

removeParentKeys

void removeParentKeys()

Remove the layer parent keys

setValid

void setValid(boolean valid,
              int cause)

Set the layer actual valid state

Parameters:

valid - Valid state

cause - Valid/Invalid cause code

isValid

boolean isValid()

Get the layer valid states

Returns:

Valid state

getInvalidCause

int getInvalidCause()

Get the layer valid state cause

Returns:

Valid state cause

clone

java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Get a copy of the current layer

Returns:

Layer copy

Throws:

java.lang.CloneNotSupportedException

getXMLDescription

java.lang.String getXMLDescription()

Get the layer xml description

Returns:

Layer xml description

lockSelection

void lockSelection(boolean selectLocked)

Set the selection lock state for the current layer

Parameters:

selectLocked -

lockEdition

void lockEdition(boolean editLocked)

Set the edition lock state for the current layer

Parameters:

editLocked -

isLockedOnEdition

boolean isLockedOnEdition()

Check if the current layer is locked on edition or not.

Returns:

Edition lock state

isLockedOnSelection

boolean isLockedOnSelection()

Check if the current layer is locked on selection or not.

Returns:

Selection lock state