com.luciad.layers.features

Class FeatureLayer

java.lang.Object

com.luciad.layers.Layer

com.luciad.layers.features.FeatureLayer

All Implemented Interfaces:

AutoCloseable

public final class FeatureLayer
extends Layer
implements AutoCloseable

A layer for feature models.

Use FeatureLayer#newBuilder to create a feature layer instance.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FeatureLayer.Builder Builder for the FeatureLayer class.

Field Summary

Fields

Modifier and Type	Field and Description
static String	PropertyEditable Returns the property name for the LayerEvent that is fired as a result of changing the layer's editable flag.
static String	PropertyLabeled Returns the property name for the LayerEvent that is fired as a result of changing the layer's labeled flag.
static String	PropertyPainter Returns the property name for the LayerEvent that is fired as a result of changing the layer's IFeaturePainter.
static String	PropertyQueryable Returns the property name for the LayerEvent that is fired as a result of changing the layer's queryable flag.

Fields inherited from class com.luciad.layers.Layer

PropertyTitle, PropertyVisible

Method Summary

Modifier and Type	Method and Description
void	close()
protected void	finalize()
IFeatureEditConfiguration	getEditConfiguration() Returns if editing is supported and how editing is configured.
IFeatureGeometryProvider	getEditCreateGeometryProvider()
FeatureLayerLoadingStrategy	getLoadingStrategy()
IFeatureModel	getModel()
IFeaturePainter	getPainter()
FeatureQueryConfiguration	getQueryConfiguration()
boolean	isEditable() Returns whether this layer is editable.
boolean	isLabeled()
boolean	isQueryable()
static FeatureLayer.Builder	newBuilder() Returns a new builder for creating a FeatureLayer.
void	setEditable(boolean editable) Sets whether this layer is editable.
void	setLabeled(boolean labeled) Sets whether the layer should display labels.
void	setPainter(IFeaturePainter featurePainter) Sets the new IFeaturePainter to use.
void	setQueryable(boolean queryable) Sets whether the features of this layer can be returned in the Map#queryFeatures method.

Methods inherited from class com.luciad.layers.Layer

addObserver, getId, getTitle, isVisible, removeObserver, setTitle, setVisible

Methods inherited from class java.lang.Object

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

Field Detail

PropertyEditable

public static final String PropertyEditable

Returns the property name for the LayerEvent that is fired as a result of changing the layer's editable flag.

See Also:

setEditable

PropertyLabeled

public static final String PropertyLabeled

Returns the property name for the LayerEvent that is fired as a result of changing the layer's labeled flag.

See Also:

setLabeled

PropertyQueryable

public static final String PropertyQueryable

Returns the property name for the LayerEvent that is fired as a result of changing the layer's queryable flag.

Since:

2023.1

See Also:

setQueryable

PropertyPainter

public static final String PropertyPainter

Returns the property name for the LayerEvent that is fired as a result of changing the layer's IFeaturePainter.

Since:

2023.1

See Also:

setPainter

Method Detail

finalize

protected void finalize()

Overrides:

finalize in class Layer

close

public void close()

Specified by:

close in interface AutoCloseable

Overrides:

close in class Layer

newBuilder

@NotNull
public static FeatureLayer.Builder newBuilder()

Returns a new builder for creating a FeatureLayer.

Returns:

a new builder for creating a FeatureLayer.

getModel

@NotNull
public IFeatureModel getModel()

Returns:

this layer's model, which provides the features to present.

getPainter

@NotNull
public IFeaturePainter getPainter()

Returns:

this layer's painter, which determines how the features are presented.

setPainter

public void setPainter(@NotNull
                       IFeaturePainter featurePainter)
                throws NullPointerException,
                       IllegalArgumentException

Sets the new IFeaturePainter to use.

It will replace the IFeaturePainter that was set using the FeatureLayer.Builder#painter method, or if that method was not called, it will replace the default feature painter.

Limitation: This method currently only supports setting a new IFeaturePainter with the exact same level of details as the previous painter. If this is not the case, this method will throw an exception.

Parameters:

featurePainter - the feature painter used to paint the feature model. Cannot be null.

Throws:

NullPointerException - when the given feature painter is null

IllegalArgumentException - when the new painter has different detail levels than the previous painter

Since:

2023.1

getQueryConfiguration

@NotNull
public FeatureQueryConfiguration getQueryConfiguration()

Returns:

this layer's query configuration, which specifies which feature to present at different map scales.

getEditConfiguration

@Nullable
public IFeatureEditConfiguration getEditConfiguration()

Returns if editing is supported and how editing is configured.

Whether or not the layer can be edited by the user is controlled using setEditable.

Returns:

an IFeatureEditConfiguration for the IFeatureModel of this layer, or null if editing is not supported.

See Also:

FeatureLayer.Builder#editConfiguration

getEditCreateGeometryProvider

@NotNull
public IFeatureGeometryProvider getEditCreateGeometryProvider()

Returns:

the edit/create geometry provider for a Feature.

See Also:

FeatureLayer.Builder#editCreateGeometryProvider

isEditable

public boolean isEditable()

Returns whether this layer is editable.

A layer is editable if it has an IFeatureEditConfiguration and if the editable flag is set.

Returns:

whether this layer is editable.

See Also:

setEditable

setEditable

public void setEditable(boolean editable)

Sets whether this layer is editable.

Sets whether or not the features of the layer can be edited by the user. If the new value is different from the old one, a LayerEvent is delivered to the observers with the property name FeatureLayer#propertyEditable.

This flag is checked by the Editor when receiving events from the IFeatureEditCandidateProvider in conjunction with the model's IFeatureModelUpdater and the layer's IFeatureEditConfiguration.

This flag is true by default. This flag has no effect if the layer does not contain an IFeatureEditConfiguration or if the model's IFeatureModelUpdater is missing.

Parameters:

editable - the new value for this property

isLabeled

public boolean isLabeled()

Returns:

if this layer currently displays labels.

setLabeled

public void setLabeled(boolean labeled)

Sets whether the layer should display labels.

Note that in order for the layer to display labels, its IFeaturePainter should also call the FeatureCanvas#drawLabel method for its features. If not, no labels will be displayed, regardless of this setting.

Parameters:

labeled - true to enable labels.

isQueryable

public boolean isQueryable()

Returns:

whether the features of this layer can be returned in the Map#queryFeatures method.

Since:

2023.1

setQueryable

public void setQueryable(boolean queryable)

Sets whether the features of this layer can be returned in the Map#queryFeatures method.

The default is true.

It is useful to set this property to false when:

• you don't want features to be selected or set to the hovered state by the SelectEventHandler or HoverEventHandler classes.
• there is a performance issue with the Map#queryFeatures method, for example for a layer with many features that don't need to be selected.

Parameters:

queryable - whether the features of this layer can be returned in the Map#queryFeatures method

Since:

2023.1

getLoadingStrategy

@NotNull
public FeatureLayerLoadingStrategy getLoadingStrategy()

Returns:

the loading strategy that is used.

Since:

2023.0.02

See Also:

FeatureLayer.Builder#loadingStrategy