org.gvsig.fmap.mapcontext.layers

Interface FLayer

All Superinterfaces:

org.gvsig.tools.dispose.Disposable, org.gvsig.tools.dynobject.DynObject, org.gvsig.metadata.Metadata, org.gvsig.tools.persistence.Persistent, org.cresques.geo.Projected

All Known Subinterfaces:

GraphicLayer, SingleLayer, VectorLayer

All Known Implementing Classes:

DefaultGraphicLayer, FLayers, FLyrDefault, FLyrVect

public interface FLayer
extends org.cresques.geo.Projected, org.gvsig.tools.persistence.Persistent, org.gvsig.metadata.Metadata, org.gvsig.tools.dispose.Disposable

Definition of the basic functionality that all kind of FMap layers should implement.

This kind of layers store their data, are drawable, projectable (with a projection), can be a node of a tree of layers, and could be editable and have a cache with previous draws. They also can be visible or not, and active or not.

A layer can also store information about errors produced working with it, and have a name (kind of layer) and a brief summary explaining what's for.

Each particular implementation can add new properties, and limit or expand the functionality.

See Also:

Projected

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	METADATA_CRS
static java.lang.String	METADATA_DEFINITION_DESCRIPTION
static java.lang.String	METADATA_DEFINITION_NAME
static java.lang.String	METADATA_NAME

Method Summary

Methods

Modifier and Type	Method and Description
void	addError(org.gvsig.tools.exception.BaseException exception) Adds an error reason that describes this layer's wrong status.
boolean	addLayerListener(LayerListener o) Adds a LayerListener to the listener list.
boolean	allowLinks() Returns information about if the layer allows HyperLink or not
FLayer	cloneLayer() This method can be used to have a fast cloned layer.
void	draw(java.awt.image.BufferedImage image, java.awt.Graphics2D g, ViewPort viewPort, org.gvsig.tools.task.Cancellable cancel, double scale) Draws the layer using a buffer.
org.cresques.cts.ICoordTrans	getCoordTrans() Returns the transformation coordinates.
long	getDrawVersion()
org.gvsig.tools.exception.BaseException	getError(int i) Returns the specified error.
java.util.List	getErrors() Returns a list with all layer errors.
java.util.Map	getExtendedProperties() Returns a hash map with all new properties associated to this layer.
FLayerStatus	getFLayerStatus() Returns the status of this layer.
org.gvsig.fmap.geom.primitive.Envelope	getFullEnvelope() Returns the full extension of the layer node.
java.lang.String	getInfoString() Returns an string with the information of this layer.
LayerListener[]	getLayerListeners() Returns all LayerListeners of this layer as an array.
java.net.URI[]	getLink(java.awt.geom.Point2D point, double tolerance) Provides an array with URIs.
org.gvsig.fmap.mapcontext.layers.AbstractLinkProperties	getLinkProperties() Returns an instance of AbstractLinkProperties that contains the information of the HyperLink
MapContext	getMapContext() Returns a reference to the model of this layer, or null if this layer has no model.
double	getMaxScale() Returns the maximum scale visible.
double	getMinScale() Returns the minimum scale visible.
java.lang.String	getName() Returns the name of this layer.
int	getNumErrors() Returns the number of errors which causes this layer to be in unavailable status.
FLayers	getParentLayer() Returns the parent FLayers node of this layer.
java.lang.Object	getProperty(java.lang.Object key) Returns a reference to an object (property) associated to this layer.
java.lang.String	getTocImageIcon() Returns the image icon that will be shown in the TOC next to this layer.
java.awt.Image	getTocStatusImage() Returns the image icon that will be shown in the TOC next to this layer, according its status.
boolean	isActive() Returns if this layer is active or not in TOC.
boolean	isAvailable() Returns the status of availability of this layer.
boolean	isEditing() Returns if this layer is editable.
boolean	isInTOC() Returns if this layer appears in the TOC.
boolean	isOk() Returns if this layer hasn't got errors.
boolean	isVisible() Returns if this layer is visible and available.
boolean	isWithinScale(double scale) Returns if the value of scale argument is within the maximum and minimum scale of this layer.
boolean	isWritable() Returns the writing status of this layer.
void	load() Executes the initialization operations of this layer.
ComposedLayer	newComposedLayer() Returns a new instance of ComposedLayer.
void	print(java.awt.Graphics2D g, ViewPort viewPort, org.gvsig.tools.task.Cancellable cancel, double scale, org.gvsig.compat.print.PrintAttributes properties) Prints this layer according to some properties requested.
void	reload() Tries recover a layer of a possible error.
boolean	removeLayerListener(LayerListener o) Removes the LayerListener argument from this layer.
void	setActive(boolean selected) Changes the status of this layer to active or inactive.
void	setAvailable(boolean available) Changes the status of availability of this layer.
void	setCoordTrans(org.cresques.cts.ICoordTrans ct) Inserts the transformation coordinates.
void	setFLayerStatus(FLayerStatus status) Sets the status of this layer.
void	setInTOC(boolean b) Sets that this layer appears or not in the TOC.
void	setMaxScale(double maxScale) Sets the maximum scale visible.
void	setMinScale(double minScale) Sets the minimum scale visible.
void	setName(java.lang.String name) Sets a name to this layer.
void	setParentLayer(FLayers root) Inserts the parent FLayers node of the layer.
void	setProjection(org.cresques.cts.IProjection proj) Inserts the projection to this layer.
void	setProperty(java.lang.Object key, java.lang.Object obj) Insets an object as a property to this layer.
void	setVisible(boolean visibility) Changes the status of this layer to visible or not.
boolean	visibleRequired() Returns true if this layer has the visible status enabled.

Methods inherited from interface org.cresques.geo.Projected

getProjection, reProject

Methods inherited from interface org.gvsig.tools.persistence.Persistent

loadFromState, saveToState

Methods inherited from interface org.gvsig.metadata.Metadata

getMetadataChildren, getMetadataID, getMetadataName

Methods inherited from interface org.gvsig.tools.dynobject.DynObject

clear, delegate, getDynClass, getDynValue, hasDynValue, implement, invokeDynMethod, invokeDynMethod, setDynValue

Methods inherited from interface org.gvsig.tools.dispose.Disposable

dispose

Field Detail

METADATA_CRS

static final java.lang.String METADATA_CRS

See Also:

Constant Field Values

METADATA_DEFINITION_DESCRIPTION

static final java.lang.String METADATA_DEFINITION_DESCRIPTION

See Also:

Constant Field Values

METADATA_DEFINITION_NAME

static final java.lang.String METADATA_DEFINITION_NAME

See Also:

Constant Field Values

METADATA_NAME

static final java.lang.String METADATA_NAME

See Also:

Constant Field Values

Method Detail

addError

void addError(org.gvsig.tools.exception.BaseException exception)

Adds an error reason that describes this layer's wrong status.

Parameters:

error - a BaseException with the information of the error

See Also:

getNumErrors(), getError(int), getErrors()

addLayerListener

boolean addLayerListener(LayerListener o)

Adds a LayerListener to the listener list.

Parameters:

o - a layer listener

Returns:

true if hasn't been any problem during the insertion of the listener

See Also:

getLayerListeners(), removeLayerListener(LayerListener)

allowLinks

boolean allowLinks()

Returns information about if the layer allows HyperLink or not

Returns:

boolean true if allows Link, false if not

cloneLayer

FLayer cloneLayer()
                  throws java.lang.Exception

This method can be used to have a fast cloned layer.

The implementations should take care of not recreate this layer. Instead of this, is better to use the same source (driver) and deepclone the legend. Exception: the labels aren't deepcloned to avoid memory consumption.

Note: Labels are memory consuming to speed up layers like PostGIS and so on.

Returns:

a layer that is a clonation of this layer

Throws:

java.lang.Exception - any exception produced during the cloning of this layer.

draw

void draw(java.awt.image.BufferedImage image,
        java.awt.Graphics2D g,
        ViewPort viewPort,
        org.gvsig.tools.task.Cancellable cancel,
        double scale)
          throws org.gvsig.fmap.dal.exception.ReadException

Draws the layer using a buffer.

Parameters:

image - an image used to accelerate the screen draw

g - for rendering 2-dimensional shapes, text and images on the Java(tm) platform

viewPort - information for drawing this layer

cancel - an object thread that implements the Cancellable interface, and will allow to cancel the draw

scale - value that represents the scale

Throws:

org.gvsig.fmap.dal.exception.ReadException - if fails the driver used in this method.

See Also:

print(Graphics2D, ViewPort, Cancellable, double, PrintAttributes)

getCoordTrans

org.cresques.cts.ICoordTrans getCoordTrans()

Returns the transformation coordinates.

Returns:

transformation coordinates

See Also:

setCoordTrans(ICoordTrans)

getDrawVersion

long getDrawVersion()

getError

org.gvsig.tools.exception.BaseException getError(int i)

Returns the specified error.

Parameters:

i - index of the error >= 0 && < getNumErrors

Returns:

a singular error

See Also:

getNumErrors(), getErrors()

getErrors

java.util.List getErrors()

Returns a list with all layer errors.

Returns:

an ArrayList with the errors

See Also:

getError(int), getNumErrors()

getExtendedProperties

java.util.Map getExtendedProperties()

Returns a hash map with all new properties associated to this layer.

Returns:

hash table with the added properties

See Also:

getProperty(Object), setProperty(Object, Object)

getFLayerStatus

FLayerStatus getFLayerStatus()

Returns the status of this layer.

Returns:

the status stored in a FLayerStatus object

See Also:

setFLayerStatus(FLayerStatus)

getFullEnvelope

org.gvsig.fmap.geom.primitive.Envelope getFullEnvelope()
                                                       throws org.gvsig.fmap.dal.exception.ReadException

Returns the full extension of the layer node.

Returns:

location and dimension of this layer node

Throws:

org.gvsig.fmap.dal.exception.ReadException - if fails the driver used in this method.

getInfoString

java.lang.String getInfoString()

Returns an string with the information of this layer.

Returns:

the string that is to be this component's information

getLayerListeners

LayerListener[] getLayerListeners()

Returns all LayerListeners of this layer as an array.

Returns:

an array with all layer listeners associated to this layer

See Also:

addLayerListener(LayerListener), removeLayerListener(LayerListener)

getLink

java.net.URI[] getLink(java.awt.geom.Point2D point,
                     double tolerance)
                       throws org.gvsig.fmap.dal.exception.ReadException

Provides an array with URIs. Returns one URI by geometry that includes the point in its own geometry limits with a allowed tolerance.

Parameters:

layer, - the layer

point, - the point to check that is contained or not in the geometries in the layer

tolerance, - the tolerance allowed. Allowed margin of error to detect if the point is contained in some geometries of the layer

Returns:

Throws:

org.gvsig.fmap.dal.exception.ReadException

BehaviorException

getLinkProperties

org.gvsig.fmap.mapcontext.layers.AbstractLinkProperties getLinkProperties()

Returns an instance of AbstractLinkProperties that contains the information of the HyperLink

Returns:

Abstra

getMapContext

MapContext getMapContext()

Returns a reference to the model of this layer, or null if this layer has no model.

Returns:

the model of this layer

getMaxScale

double getMaxScale()

Returns the maximum scale visible. Higher scales won't be drawn.

Returns:

the maximum scale > 0, -1 if not defined

See Also:

setMaxScale(double)

getMinScale

double getMinScale()

Returns the minimum scale visible. Lower scales won't be drawn.

Returns:

the minimum scale > 0, -1 if not defined

See Also:

setMinScale(double)

getName

java.lang.String getName()

Returns the name of this layer.

Returns:

an string with this layer's name

See Also:

setName(String)

getNumErrors

int getNumErrors()

Returns the number of errors which causes this layer to be in unavailable status.

Returns:

number of errors >= 0

See Also:

getError(int), getErrors()

getParentLayer

FLayers getParentLayer()

Returns the parent FLayers node of this layer.

Returns:

the parent of this layer, or null if hasn't parent

See Also:

setParentLayer(FLayers)

getProperty

java.lang.Object getProperty(java.lang.Object key)

Returns a reference to an object (property) associated to this layer.

For example, you can attach a network definition to key "network" and check if a layer has a network loaded using getAssociatedObject("network") and that it's not null.

Parameters:

key - the key associated to the property

Returns:

null if key is not found

See Also:

getExtendedProperties(), setProperty(Object, Object)

getTocImageIcon

java.lang.String getTocImageIcon()

Returns the image icon that will be shown in the TOC next to this layer.

Returns:

a String reference to the image icon, or null if there isn't any

getTocStatusImage

java.awt.Image getTocStatusImage()

Returns the image icon that will be shown in the TOC next to this layer, according its status.

Returns:

the image

isActive

boolean isActive()

Returns if this layer is active or not in TOC.

One layer is active if is selected in TOC.

Returns:

true if this layer is active; false otherwise

See Also:

setActive(boolean)

isAvailable

boolean isAvailable()

Returns the status of availability of this layer.

One layer is available if the source of data is on-line.

Returns:

true if the source of data is on-line; false otherwise

See Also:

setAvailable(boolean), isVisible()

isEditing

boolean isEditing()

Returns if this layer is editable.

One layer is editable if user can modify its information with graphical tools.

Returns:

true if this layer is editable; false otherwise

See Also:

setEditing(boolean)

isInTOC

boolean isInTOC()

Returns if this layer appears in the TOC.

If doesn't appears, remains in the view and in the project.

Returns:

true if this layer appears in the TOC; false otherwise

isOk

boolean isOk()

Returns if this layer hasn't got errors.

Returns:

true if this layer hasn't got errors; false otherwise

isVisible

boolean isVisible()

Returns if this layer is visible and available.

One layer is visible if it's check box associated is selected. This means that layer will tried to be painted.

One layer is available if the source of data is on-line.

It's probably that one layer selected hadn't available it's data, for example in a remote service.

Returns:

true if this layer is visible and available; false otherwise

See Also:

isAvailable(), setAvailable(boolean), visibleRequired()

isWithinScale

boolean isWithinScale(double scale)

Returns if the value of scale argument is within the maximum and minimum scale of this layer.

Parameters:

scale - the scale > 0

Returns:

true if the scale argument is within the range of scales of this layer; false otherwise

See Also:

setMinScale(double), setMaxScale(double)

isWritable

boolean isWritable()

Returns the writing status of this layer.

One layer is writable if there is a writing driver for this layer.

Returns:

true if there is a writing driver for this layer; false otherwise

load

void load()
          throws LoadLayerException

Executes the initialization operations of this layer. This method is invoked only one time during the life of this layer and just before visualize it.

Throws:

org.gvsig.fmap.drivers.reading.DriverIOException - if fails loading the layer.

LoadLayerException

See Also:

reload()

newComposedLayer

ComposedLayer newComposedLayer()

Returns a new instance of ComposedLayer.

This allows make a single draw for a group of layers with the same source.

If this operation isn't applicable for this kind of layer, this method returns null.

By default this operation is not supported.

Returns:

a new composed layer or null if not supported

See Also:

ComposedLayer

print

void print(java.awt.Graphics2D g,
         ViewPort viewPort,
         org.gvsig.tools.task.Cancellable cancel,
         double scale,
         org.gvsig.compat.print.PrintAttributes properties)
           throws org.gvsig.fmap.dal.exception.ReadException

Prints this layer according to some properties requested.

Parameters:

g - for rendering 2-dimensional shapes, text and images on the Java(tm) platform

viewPort - the information for drawing the layers

cancel - an object thread that implements the Cancellable interface, and will allow to cancel the draw

scale - the scale of the view. Must be between getMinScale() and getMaxScale().

properties - a set with the settings to be applied to a whole print job and to all the docs in the print job

Throws:

org.gvsig.fmap.dal.exception.ReadException - if fails the driver used in this method.

See Also:

draw(BufferedImage, Graphics2D, ViewPort, Cancellable, double)

reload

void reload()
            throws ReloadLayerException

Tries recover a layer of a possible error.

If it has any problem during the load, marks the availability to false and throws an exception.

Throws:

ReloadLayerException - if it's thrown a ReadException or an IOException during the load of this layer.

See Also:

load()

removeLayerListener

boolean removeLayerListener(LayerListener o)

Removes the LayerListener argument from this layer.

Parameters:

o - a layer listener

Returns:

true if hasn't been any problem doing this process

See Also:

addLayerListener(LayerListener), getLayerListeners()

setActive

void setActive(boolean selected)

Changes the status of this layer to active or inactive.

One layer is active if is selected in TOC.

Parameters:

selected - the boolean to be set

See Also:

isActive()

setAvailable

void setAvailable(boolean available)

Changes the status of availability of this layer.

One layer is available if the source of data is on-line.

Parameters:

the - boolean to be set

See Also:

isAvailable()

setCoordTrans

void setCoordTrans(org.cresques.cts.ICoordTrans ct)

Inserts the transformation coordinates.

Parameters:

ct - transformation coordinates

See Also:

getCoordTrans()

setFLayerStatus

void setFLayerStatus(FLayerStatus status)

Sets the status of this layer.

Parameters:

status - information of the status for this layer

See Also:

getFLayerStatus()

setInTOC

void setInTOC(boolean b)

Sets that this layer appears or not in the TOC.

Parameters:

b - true if appears in the TOC; false otherwise

setMaxScale

void setMaxScale(double maxScale)

Sets the maximum scale visible. Higher scales won't be drawn.

Parameters:

maxScale - the scale > 0, -1 if not defined

See Also:

getMaxScale()

setMinScale

void setMinScale(double minScale)

Sets the minimum scale visible. Lower scales won't be drawn.

Parameters:

minScale - the scale > 0, -1 if not defined

See Also:

getMinScale()

setName

void setName(java.lang.String name)

Sets a name to this layer.

Parameters:

name - the string that is to be this layer's name

See Also:

getName()

setParentLayer

void setParentLayer(FLayers root)

Inserts the parent FLayers node of the layer.

Parameters:

root - a FLayers object

See Also:

getParentLayer()

setProjection

void setProjection(org.cresques.cts.IProjection proj)

Inserts the projection to this layer.

Parameters:

proj - information about the new projection

setProperty

void setProperty(java.lang.Object key,
               java.lang.Object obj)

Insets an object as a property to this layer.

Parameters:

key - the key associated to the property

obj - the property

See Also:

getProperty(Object), getExtendedProperties()

setVisible

void setVisible(boolean visibility)

Changes the status of this layer to visible or not.

One layer is visible if it's check box associated is selected. This means that layer will tried to be painted. If the data associated isn't available, then this property will change to false.

Parameters:

visibility - the boolean to be set

See Also:

isVisible(), visibleRequired(), isAvailable()

visibleRequired

boolean visibleRequired()

Returns true if this layer has the visible status enabled.

Returns:

true if visible this layer has the visible status enabled, otherwise false

See Also:

isVisible(), setVisible(boolean)