Package com.luciad.edit.features

Class FeatureEditContext

java.lang.Object

com.luciad.edit.features.FeatureEditContext

All Implemented Interfaces:

AutoCloseable

public final class FeatureEditContext
extends Object
implements AutoCloseable

FeatureEditContext provides context information for the feature that is being edited.

Method Summary

Modifier and Type	Method	Description
void	close()
protected void	finalize()
EditSettings	getDefaultSettings()	Returns the default edit settings.
Observable<@NotNull Feature>	getFeature()	Returns the Feature that is being edited.
LayerFeatureId	getHandleFeatureId()	Returns the feature ID for the handle to which this context is passed.
long	getHandleLayerId()	Returns the layer ID of the handle of the Feature that is being edited.
FeatureLayer	getLayer()	Returns the FeatureLayer on which the feature is edited.
Map	getMap()	Returns the map on which the feature is being edited.
IFeatureModel	getModel()	Returns the IFeatureModel of the Feature that is being edited.
LayerFeatureId	getPreviewFeatureId()	Returns the ID for the Feature that is used to visualize the editing result.

Methods inherited from class java.lang.Object

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

Method Details

finalize

protected void finalize()

Overrides:

finalize in class Object

close

public void close()

Specified by:

close in interface AutoCloseable

getMap

@NotNull
public Map getMap()

Returns the map on which the feature is being edited.

Returns:

the map on which the feature is being edited.

getLayer

@NotNull
public FeatureLayer getLayer()

Returns the FeatureLayer on which the feature is edited.

The layer can for example be used to retrieve the IFeatureGeometryProvider.

Returns:

the FeatureLayer on which the feature is edited.

See Also:

• FeatureLayer#getEditCreateGeometryProvider

getFeature

@NotNull
public Observable<@NotNull Feature> getFeature()

Returns the Feature that is being edited.

Returns:

the Feature that is being edited.

getModel

@NotNull
public IFeatureModel getModel()

Returns the IFeatureModel of the Feature that is being edited.

Returns:

the IFeatureModel of the Feature that is being edited.

getHandleLayerId

public long getHandleLayerId()

Returns the layer ID of the handle of the Feature that is being edited.

Returns:

the layer ID of the handle of the Feature that is being edited.

getHandleFeatureId

@NotNull
public LayerFeatureId getHandleFeatureId()

Returns the feature ID for the handle to which this context is passed.

It can be used to query the map for specific edit handles, for example. This method will throw an exception if it is called outside an IEditHandle call.

Returns:

the feature ID for the handle to which this context is passed.

getPreviewFeatureId

@NotNull
public LayerFeatureId getPreviewFeatureId()

Returns the ID for the Feature that is used to visualize the editing result.

Depending on the configured ModelUpdateMode, this can be a different ID.

For ModelUpdateMode#OnAnyChange, the original layer is used and the id of getFeature().

For ModelUpdateMode#OnMajorChanges and ModelUpdateMode#OnEditFinished, this is the ID of the a copy of the Feature, visualized by the handle layer.

This ID can be used for the Map#queryFeatures method to detect if the currently edited Feature is touched, for example.

Returns:

the ID for the Feature that is being edited.

getDefaultSettings

@NotNull
public EditSettings getDefaultSettings()

Returns the default edit settings.

Returns:

the default edit settings.