com.luciad.create.features

Class FeatureCreator

java.lang.Object

com.luciad.create.features.FeatureCreator

All Implemented Interfaces:

IFeatureCreator, AutoCloseable

public final class FeatureCreator
extends Object
implements AutoCloseable, IFeatureCreator

This class can create feature instances, based on a geometry.

This creator will

• use an initial feature instance as a base
• create a geometry on the map
• fill in the remaining Feature values using the created geometry

This initial Feature must contain the following:

• (optional) an id. In many cases, models are responsible to assign the id to newly added features. In this case, the Feature must not contain an id. Other models however, allow newly added features to already have an id. In that case, this Feature must have an id.
• all necessary property values that are needed to correctly apply a geometry on a Feature

This creator doesn't consume any events itself, but it delegates the events to the wrapped geometry creator instance.

See Also:

Creator

Constructor Summary

Constructors

Constructor and Description
FeatureCreator(Feature initialFeature, IGeometryCreator geometryCreator) Creates a new FeatureCreator.

Method Summary

Modifier and Type	Method and Description
void	close()
protected void	finalize()
EventResult	onEvent(IInputEvent inputEvent, FeatureCreateContext context) Handles the given event, and returns if the event was handled or not.
void	start(IFeatureCreateCallback callback, FeatureCreateContext context) This method is called to start creation.

Methods inherited from class java.lang.Object

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

Constructor Detail

FeatureCreator

public FeatureCreator(@NotNull
                      Feature initialFeature,
                      @NotNull
                      IGeometryCreator geometryCreator)
               throws NullPointerException

Creates a new FeatureCreator.

Parameters:

initialFeature - the initial feature

geometryCreator - the delegate geometry creator to use, cannot be null.

Throws:

NullPointerException - when the geometry creator is null.

Method Detail

finalize

protected void finalize()

Overrides:

finalize in class Object

close

public void close()

Specified by:

close in interface AutoCloseable

start

public void start(@NotNull
                  IFeatureCreateCallback callback,
                  @NotNull
                  FeatureCreateContext context)
           throws NullPointerException

This method is called to start creation.

After this call, IFeatureCreator#onEvent can be called.

When a IFeatureCreator was started, it can not be started again until it has stopped. Implementations of this method are encouraged to throw an exception in that case to signal a programming error by the caller of this method.

Specified by:

start in interface IFeatureCreator

Parameters:

callback - the callback to signal feature changes, and whether creation for the feature has finished, cannot be null.

context - the creation context, cannot be null

Throws:

NullPointerException - when null is passed.

onEvent

@NotNull
public EventResult onEvent(@NotNull
                                    IInputEvent inputEvent,
                                    @NotNull
                                    FeatureCreateContext context)
                             throws NullPointerException

Handles the given event, and returns if the event was handled or not.

Specified by:

onEvent in interface IFeatureCreator

Parameters:

inputEvent - an event, cannot be null

context - the creation context, cannot be null

Returns:

if the event was consumed or not

Throws:

NullPointerException - when null is passed.