Package org.geotools.coverage.grid.io.footprint

Enum FootprintInsetPolicy

Object

Enum<FootprintInsetPolicy>

FootprintInsetPolicy

All Implemented Interfaces:

Serializable, Comparable<FootprintInsetPolicy>

public enum FootprintInsetPolicy
extends Enum<FootprintInsetPolicy>

Policy specifying how to apply an inset of the footprints

Author:

Andrea Aime - GeoSolutions

Enum Constant Summary

Enum Constants

Enum Constant	Description
border	Applies the inset only on the footprint sections that are not lying about the granule bounds (assuming the granules are cut in a regular grid and meant to be displayed side by side (no overlap)
full	Full inset from all direction.

Field Summary

Fields

Modifier and Type	Field	Description
static String	INSET_PROPERTY
static String	INSET_TYPE_PROPERTY

Method Summary

Modifier and Type	Method	Description
abstract Geometry	applyInset(Geometry footprint, Geometry granuleBounds, double inset)
static double	getInset(Properties properties)
static FootprintInsetPolicy	getInsetPolicy(Properties properties)
static List<String>	names()	Returns the list of names for this enum
static FootprintInsetPolicy	valueOf(String name)	Returns the enum constant of this type with the specified name.
static FootprintInsetPolicy[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class Enum

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

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

full

public static final FootprintInsetPolicy full

Full inset from all direction. Works best with fully overlapping granules

border

public static final FootprintInsetPolicy border

Applies the inset only on the footprint sections that are not lying about the granule bounds (assuming the granules are cut in a regular grid and meant to be displayed side by side (no overlap)

Field Detail

INSET_PROPERTY

public static final String INSET_PROPERTY

See Also:

Constant Field Values

INSET_TYPE_PROPERTY

public static final String INSET_TYPE_PROPERTY

See Also:

Constant Field Values

Method Detail

values

public static FootprintInsetPolicy[] 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 (FootprintInsetPolicy c : FootprintInsetPolicy.values())
    System.out.println(c);

Returns:

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

valueOf

public static FootprintInsetPolicy 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

applyInset

public abstract Geometry applyInset(Geometry footprint,
                                    Geometry granuleBounds,
                                    double inset)

names

public static List<String> names()

Returns the list of names for this enum

getInsetPolicy

public static FootprintInsetPolicy getInsetPolicy(Properties properties)

getInset

public static double getInset(Properties properties)