Module org.apache.sis.storage

Package org.apache.sis.storage

Enum Class WritableGridCoverageResource.CommonOption

Object

Enum<WritableGridCoverageResource.CommonOption>

CommonOption

All Implemented Interfaces:

Serializable, Comparable<Writable­Grid­Coverage­Resource.Common­Option>, Constable, Writable­Grid­Coverage­Resource.Option

Enclosing interface:

Writable­Grid­Coverage­Resource

public static enum WritableGridCoverageResource.CommonOption
extends Enum<WritableGridCoverageResource.CommonOption>
implements WritableGridCoverageResource.Option

Write options that may apply to any data store. The coverage write operation is configured by instances of Writable­Grid­Coverage­Resource.Option, sometimes in a Data­Store-specific basis. This Common­Option enumeration provides options that do not depend on the data store.

Since:

1.2

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.Enum­Desc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
REPLACE	Instructs the write operation to replace existing coverage if one exists.
UPDATE	Instructs the write operation to update existing coverage if one exists.

Method Summary

Modifier and Type	Method	Description
static Writable­Grid­Coverage­Resource.Common­Option	value­Of(String name)	Returns the enum constant of this class with the specified name.
static Writable­Grid­Coverage­Resource.Common­Option[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class Enum

clone, compare­To, describe­Constable, equals, finalize, get­Declaring­Class, hash­Code, name, ordinal, to­String, value­Of

Methods inherited from class Object

get­Class, notify, notify­All, wait, wait, wait

Enum Constant Details

REPLACE

public static final WritableGridCoverageResource.CommonOption REPLACE

Instructs the write operation to replace existing coverage if one exists. By default (when no option is specified) the write operation will only add new coverages and never modify existing ones. If this option is specified, then there is a choice:

• If a coverage already exists in the Grid­Coverage­Resource, then it will be deleted. The existing coverage will be replaced by the new coverage. The old and new coverages may have different grid geometries.
• If there are no existing coverages in the Grid­Coverage­Resource, then the new coverage will be added as if this option was not provided.

This option is mutually exclusive with UPDATE.

UPDATE

public static final WritableGridCoverageResource.CommonOption UPDATE

Instructs the write operation to update existing coverage if one exists. If this option is specified, then there is a choice:

• If a coverage already exists in the Grid­Coverage­Resource, then:
  • Cells of the provided Grid­Coverage that are within the Grid­Geometry of the existing coverage will overwrite the existing cells. The provided coverage may be resampled to the grid geometry of the existing coverage in this process.
  • Cells outside the Grid­Geometry of the existing coverage are ignored.
• If there are no existing coverages in the Grid­Coverage­Resource, then the new coverage will be added as if this option was not provided.

This option is mutually exclusive with REPLACE.

Method Details

values

public static WritableGridCoverageResource.CommonOption[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static WritableGridCoverageResource.CommonOption valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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:

Illegal­Argument­Exception - if this enum class has no constant with the specified name

Null­Pointer­Exception - if the argument is null