Module org.opengis.geoapi

Package org.opengis.metadata.spatial

Class PixelOrientation

Object

CodeList<PixelOrientation>

PixelOrientation

All Implemented Interfaces:

Serializable, Comparable<PixelOrientation>, ControlledVocabulary

@UML(identifier="MD_PixelOrientationCode",
     specification=ISO_19115)
public final class PixelOrientation
extends CodeList<PixelOrientation>

Point in a pixel corresponding to the Earth location of the pixel. This code-list assumes a two-dimensional case.

Upcoming API change — enumeration
According ISO 19115, PixelOrientation shall be an enumeration, not a code list. This class may be changed to a Java enum in GeoAPI 4.0. See GEO-199 for more information.

Since:

2.0

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.opengis.util.CodeList

CodeList.Filter

Field Summary

Fields

Modifier and Type	Field	Description
static final PixelOrientation	CENTER	Point in a pixel corresponding to the Earth location of the pixel.
static final PixelOrientation	LOWER_LEFT	The corner in the pixel closest to the origin of the SRS.
static final PixelOrientation	LOWER_RIGHT	Next corner counterclockwise from the lower left.
static final PixelOrientation	UPPER_LEFT	Next corner counterclockwise from the upper right.
static final PixelOrientation	UPPER_RIGHT	Next corner counterclockwise from the lower right.

Method Summary

Modifier and Type	Method	Description
PixelOrientation[]	family()	Returns the list of codes of the same kind than this code list element.
static PixelOrientation	valueOf(String code)	Returns the pixel orientation that matches the given string, or returns a new one if none match it.
static PixelOrientation[]	values()	Returns the list of PixelOrientations.

Methods inherited from class org.opengis.util.CodeList

compareTo, identifier, name, ordinal, readResolve, toString, valueOf, valueOf, valueOf, values

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opengis.util.ControlledVocabulary

names

Field Details

CENTER

@UML(identifier="center",
     obligation=CONDITIONAL,
     specification=ISO_19115)
public static final PixelOrientation CENTER

Point in a pixel corresponding to the Earth location of the pixel.

LOWER_LEFT

@UML(identifier="lowerLeft",
     obligation=CONDITIONAL,
     specification=ISO_19115)
public static final PixelOrientation LOWER_LEFT

The corner in the pixel closest to the origin of the SRS. If two are at the same distance from the origin, the one with the smallest x-value.

LOWER_RIGHT

@UML(identifier="lowerRight",
     obligation=CONDITIONAL,
     specification=ISO_19115)
public static final PixelOrientation LOWER_RIGHT

Next corner counterclockwise from the lower left.

UPPER_RIGHT

@UML(identifier="upperRight",
     obligation=CONDITIONAL,
     specification=ISO_19115)
public static final PixelOrientation UPPER_RIGHT

Next corner counterclockwise from the lower right.

UPPER_LEFT

@UML(identifier="upperLeft",
     obligation=CONDITIONAL,
     specification=ISO_19115)
public static final PixelOrientation UPPER_LEFT

Next corner counterclockwise from the upper right.

Method Details

values

public static PixelOrientation[] values()

Returns the list of PixelOrientations.

Returns:

the list of codes declared in the current JVM.

family

public PixelOrientation[] family()

Returns the list of codes of the same kind than this code list element. Invoking this method is equivalent to invoking values(), except that this method can be invoked on an instance of the parent CodeList class.

Specified by:

family in interface ControlledVocabulary

Specified by:

family in class CodeList<PixelOrientation>

Returns:

all code values for this code list.

valueOf

public static PixelOrientation valueOf(String code)

Returns the pixel orientation that matches the given string, or returns a new one if none match it. This methods returns the first instance (in declaration order) for which the name is equals, ignoring case, to the given name. If no existing instance is found, then a new one is created for the given name.

Parameters:

code - the name of the code to fetch or to create.

Returns:

a code matching the given name.