Package com.vividsolutions.jump.workbench.model

Class Layer

java.lang.Object

com.vividsolutions.jump.workbench.model.AbstractLayerable

com.vividsolutions.jump.workbench.model.GeoReferencedLayerable

com.vividsolutions.jump.workbench.model.Layer

All Implemented Interfaces:

Disposable, Layerable, LayerManagerProxy

Direct Known Subclasses:

LayerView, ReferencedImagesLayer, SpatialDSLayer, SystemLayerFinder.NonSavePromptingLayer

public class Layer
extends GeoReferencedLayerable
implements Disposable

Adds colour, line-width, and other stylistic information to a Feature Collection.

When adding or removing multiple features to this Layer's FeatureCollection, prefer #addAll and #removeAll to #add and #remove -- fewer events will be fired.

Constructor Summary

Constructors

Constructor	Description
Layer()	Called by Java2XML
Layer(String name, Color fillColor, FeatureCollection featureCollection, LayerManager layerManager)

Method Summary

Modifier and Type	Method	Description
void	addFeatureSchemaOperation(String expression)
void	addStyle(Style style)
static UndoableCommand	addUndo(String layerName, LayerManagerProxy proxy, UndoableCommand wrappeeCommand)	Enables a layer to be changed undoably.
Collection<Style>	cloneStyles()
static Color	defaultLineColor(Color fillColor)
void	dispose()	Releases references to the data, to facilitate garbage collection.
BasicStyle	getBasicStyle()
DataSourceQuery	getDataSourceQuery()
String	getDescription()
FeatureCollectionWrapper	getFeatureCollectionWrapper()	Returns a wrapper around the FeatureCollection which was added using #wrapFeatureCollection.
Collection<String>	getFeatureSchemaOperations()
LabelStyle	getLabelStyle()
Style	getStyle(Class<?> c)	Styles do not notify the Layer when their parameters change.
List<Style>	getStyles()	get a list of all styles
List<Style>	getStyles(Class<?> filter)	get a list of all styles matching the parameter class
List<Style>	getStylesIfEnabled(Class<?> filter)	get a list of all enabled styles matching the parameter class
VertexStyle	getVertexStyle()
boolean	hasReadableDataSource()
boolean	isDrawingLast()
boolean	isFeatureCollectionModified()
boolean	isSynchronizingLineColor()
void	removeStyle(Style p)
Layer	setDataSourceQuery(DataSourceQuery dataSourceQuery)
void	setDescription(String description)
void	setDrawingLast(boolean drawingLast)	Used for lightweight layers like the Vector layer.
void	setFeatureCollection(FeatureCollection featureCollection)
Layer	setFeatureCollectionModified(boolean featureCollectionModified)
protected void	setFeatureCollectionWrapper(FeatureCollectionWrapper featureCollectionWrapper)
void	setLayerManager(LayerManager layerManager)	Called by Java2XML
void	setStyles(Collection<Style> newStyles)
void	setSynchronizingLineColor(boolean synchronizingLineColor)
static void	tryToInvalidateEnvelope(Layer layer)	Does nothing if the underlying feature collection is not a FeatureDataset.

Methods inherited from class com.vividsolutions.jump.workbench.model.GeoReferencedLayerable

getBlackboard, getEnvelope, getSrsInfo, setEnvelope, setSrsInfo

Methods inherited from class com.vividsolutions.jump.workbench.model.AbstractLayerable

fireAppearanceChanged, fireLayerChanged, getLayerManager, getMaxScale, getMinScale, getName, getTask, isEditable, isReadonly, isScaleDependentRenderingEnabled, isSelectable, isVisible, setEditable, setMaxScale, setMinScale, setName, setReadonly, setScaleDependentRenderingEnabled, setSelectable, setVisible, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Layer

public Layer()

Called by Java2XML

Layer

public Layer(String name,
             Color fillColor,
             FeatureCollection featureCollection,
             LayerManager layerManager)

Method Detail

defaultLineColor

public static Color defaultLineColor(Color fillColor)

Parameters:

fillColor - the fillColor we want to derive a lineColor

Returns:

a darker version of the given fill colour, for use as the line colour

setDescription

public void setDescription(String description)

setDrawingLast

public void setDrawingLast(boolean drawingLast)

Used for lightweight layers like the Vector layer.

Parameters:

drawingLast - true if the layer should be among those drawn last

setFeatureCollection

public void setFeatureCollection(FeatureCollection featureCollection)

setSynchronizingLineColor

public void setSynchronizingLineColor(boolean synchronizingLineColor)

getBasicStyle

public BasicStyle getBasicStyle()

getVertexStyle

public VertexStyle getVertexStyle()

getLabelStyle

public LabelStyle getLabelStyle()

getDescription

public String getDescription()

getFeatureCollectionWrapper

public FeatureCollectionWrapper getFeatureCollectionWrapper()

Returns a wrapper around the FeatureCollection which was added using #wrapFeatureCollection. The original FeatureCollection can be retrieved using FeatureCollectionWrapper#getWrappee. However, parties are encouraged to use the FeatureCollectionWrapper instead, so that feature additions and removals cause FeatureEvents to be fired (by the Layer).

Returns:

the FeatureCollectionWrapper containing features

setFeatureCollectionWrapper

protected void setFeatureCollectionWrapper(FeatureCollectionWrapper featureCollectionWrapper)

getStyle

public Style getStyle(Class<?> c)

Styles do not notify the Layer when their parameters change. Therefore, after you modify a Style's parameters (for example, the fill colour of BasicStyle), be sure to call #fireAppearanceChanged

Parameters:

c - Can even be the desired Style's superclass or interface

Returns:

The style value

getStylesIfEnabled

public List<Style> getStylesIfEnabled(Class<?> filter)

get a list of all enabled styles matching the parameter class

Parameters:

filter - superclass of the requested styles

Returns:

a list containing enabled styles implementing the requested class

getStyles

public List<Style> getStyles()

get a list of all styles

Returns:

all Styles of this Layer in a new unmodifiable List

getStyles

public List<Style> getStyles(Class<?> filter)

get a list of all styles matching the parameter class

Parameters:

filter - superclass or interface of the requested styles

Returns:

a list containing all styles implementing the requested class

hasReadableDataSource

public boolean hasReadableDataSource()

isDrawingLast

public boolean isDrawingLast()

isSynchronizingLineColor

public boolean isSynchronizingLineColor()

addStyle

public void addStyle(Style style)

dispose

public void dispose()

Releases references to the data, to facilitate garbage collection. Important for MDI apps like the JUMP Workbench. Called when the last JInternalFrame viewing the LayerManager is closed (i.e. internal frame's responsibility). To conserve memory, if layers are frequently added and removed from the LayerManager, parties may want to call #dispose themselves rather than waiting for the internal frame to be closed.

Specified by:

dispose in interface Disposable

removeStyle

public void removeStyle(Style p)

cloneStyles

public Collection<Style> cloneStyles()

setStyles

public void setStyles(Collection<Style> newStyles)

setLayerManager

public void setLayerManager(LayerManager layerManager)

Description copied from interface: Layerable

Called by Java2XML

Specified by:

setLayerManager in interface Layerable

Overrides:

setLayerManager in class AbstractLayerable

Parameters:

layerManager - the LayerManager

addUndo

public static UndoableCommand addUndo(String layerName,
                                      LayerManagerProxy proxy,
                                      UndoableCommand wrappeeCommand)

Enables a layer to be changed undoably. Since the layer's features are saved, only use this method for layers with few features.

Parameters:

layerName - the target Layer name

proxy - a LayerManager proxy

wrappeeCommand - the undoable command

Returns:

the command to be executed

tryToInvalidateEnvelope

public static void tryToInvalidateEnvelope(Layer layer)

Does nothing if the underlying feature collection is not a FeatureDataset.

Parameters:

layer - the Layer whose envelope must be invalidated

getDataSourceQuery

public DataSourceQuery getDataSourceQuery()

setDataSourceQuery

public Layer setDataSourceQuery(DataSourceQuery dataSourceQuery)

isFeatureCollectionModified

public boolean isFeatureCollectionModified()

setFeatureCollectionModified

public Layer setFeatureCollectionModified(boolean featureCollectionModified)

getFeatureSchemaOperations

public Collection<String> getFeatureSchemaOperations()

addFeatureSchemaOperation

public void addFeatureSchemaOperation(String expression)