com.luciad.edit

Enum ModelUpdateMode

java.lang.Object

java.lang.Enum<ModelUpdateMode>

com.luciad.edit.ModelUpdateMode

All Implemented Interfaces:

Serializable, Comparable<ModelUpdateMode>

public enum ModelUpdateMode
extends Enum<ModelUpdateMode>

Enumeration that indicates when changes need to be committed to the model.

This mode is a configuration option for FeatureEditConfigurationBuilder.

This mode can have an influence on editing performance. It is not always a good idea to commit all intermediate editing changes to the model. This can lead to a large number of model updates, and for many model implementations, this can lead to a sub-optimal performance. For example: models that are backed by a database.

This enumeration allows you to specify the granularity of updates that are performed on a model.

Enum Constant Summary

Enum Constants

Enum Constant and Description
OnAnyChange Indicates that the model will be updated for any change, including ChangeStatus#InProgress changes to a Feature.
OnEditFinished Indicates that the model will be updated only after editing a Feature is completely finished, after all changes to the Feature are done.
OnMajorChanges Indicates that the model will be updated for major changes, meaning only changes that are marked as ChangeStatus#InProgressKeyPoint or ChangeStatus#Finished.

Method Summary

Modifier and Type	Method and Description
static ModelUpdateMode	valueOf(String name) Returns the enum constant of this type with the specified name.
static ModelUpdateMode[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

OnAnyChange

public static final ModelUpdateMode OnAnyChange

Indicates that the model will be updated for any change, including ChangeStatus#InProgress changes to a Feature.

OnMajorChanges

public static final ModelUpdateMode OnMajorChanges

Indicates that the model will be updated for major changes, meaning only changes that are marked as ChangeStatus#InProgressKeyPoint or ChangeStatus#Finished.

OnEditFinished

public static final ModelUpdateMode OnEditFinished

Indicates that the model will be updated only after editing a Feature is completely finished, after all changes to the Feature are done.

Method Detail

values

public static ModelUpdateMode[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ModelUpdateMode c : ModelUpdateMode.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ModelUpdateMode valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null