Class DefaultGeorectified

Object

AbstractMetadata

ModifiableMetadata

ISOMetadata

AbstractSpatialRepresentation

DefaultGridSpatialRepresentation

DefaultGeorectified

All Implemented Interfaces:

Serializable, Emptiable, Lenient­Comparable, Identified­Object, Georectified, Grid­Spatial­Representation, Spatial­Representation

public class DefaultGeorectified
extends DefaultGridSpatialRepresentation
implements Georectified

Grid whose cells are regularly spaced in a geographic or projected coordinate reference system. Any cell in the grid can be geolocated given its grid coordinate and the grid origin, cell spacing, and orientation indication of whether or not geographic.

The following properties are mandatory or conditional (i.e. mandatory under some circumstances) in a well-formed metadata according ISO 19115:

MD_Georectified ├─number­Of­Dimensions………………………………………………… Number of independent spatial-temporal axes. ├─axis­Dimension­Properties…………………………………… Information about spatial-temporal axis properties. │ ├─dimension­Name…………………………………………………… Name of the axis. │ └─dimension­Size…………………………………………………… Number of elements along the axis. ├─cell­Geometry………………………………………………………………… Identification of grid data as point or cell. ├─transformation­Parameter­Availability…… Whether parameters for transformation exists. ├─check­Point­Availability……………………………………… Whether geographic position points are available to test the accuracy of the georeferenced grid data. ├─check­Point­Description………………………………………… Description of geographic position points used to test the accuracy of the georeferenced grid data. ├─corner­Points………………………………………………………………… Earth location in the coordinate reference system and the grid coordinate of the cells at opposite ends. └─point­In­Pixel………………………………………………………………… Point in a pixel corresponding to the Earth location of the pixel.

Providing the check point description implies that check point availability is true. The setter methods will ensure that this condition is not violated.

Limitations

• Instances of this class are not synchronized for multi-threading. Synchronization, if needed, is caller's responsibility.
• Serialized objects of this class are not guaranteed to be compatible with future Apache SIS releases. Serialization support is appropriate for short term storage or RMI between applications running the same version of Apache SIS. For long term storage, use XML instead.

Since:

0.3

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class ModifiableMetadata

Modifiable­Metadata.State

Modifier and Type	Class	Description
static enum	Modifiable­Metadata.State	Whether the metadata is still editable or has been made final.

Field Summary

Fields inherited from class ISOMetadata

identifiers

Modifier and Type	Field	Description
protected Collection<Identifier>	identifiers	All identifiers associated with this metadata, or null if none.

Constructor Summary

Constructors

Constructor	Description
Default­Georectified()	Constructs an initially empty georectified object.
Default­Georectified(Georectified object)	Constructs a new instance initialized with the values from the specified metadata object.

Method Summary

Modifier and Type	Method	Description
static Default­Georectified	cast­Or­Copy(Georectified object)	Returns a SIS metadata implementation with the values of the given arbitrary implementation.
Point	get­Center­Point()	Returns the Earth location in the coordinate system defined by the Spatial Reference System and the grid coordinate of the cell halfway between opposite ends of the grid in the spatial dimensions.
International­String	get­Check­Point­Description()	Returns a description of geographic position points used to test the accuracy of the georeferenced grid data.
Collection<GCP>	get­Check­Points()	Returns the geographic references used to validate georectification of the data.
List<Point>	get­Corner­Points()	Returns the Earth location in the coordinate system defined by the Spatial Reference System and the grid coordinate of the cells at opposite ends of grid coverage along two diagonals.
Pixel­Orientation	get­Point­In­Pixel()	Returns the point in a pixel corresponding to the Earth location of the pixel.
International­String	get­Transformation­Dimension­Description()	Returns a general description of the transformation.
Collection<International­String>	get­Transformation­Dimension­Mapping()	Returns information about which grid dimensions are the spatial dimensions.
boolean	is­Check­Point­Available()	Returns an indication of whether or not geographic position points are available to test the accuracy of the georeferenced grid data.
void	set­Center­Point(Point new­Value)	Sets the center point.
void	set­Check­Point­Available(boolean new­Value)	Sets an indication of whether or not geographic position points are available to test the accuracy of the georeferenced grid data.
void	set­Check­Point­Description(International­String new­Value)	Sets the description of geographic position points used to test the accuracy of the georeferenced grid data.
void	set­Check­Points(Collection<? extends GCP> new­Values)	Sets the geographic references used to validate georectification of the data.
void	set­Corner­Points(List<? extends Point> new­Values)	Sets the corner points.
void	set­Point­In­Pixel(Pixel­Orientation new­Value)	Sets the point in a pixel corresponding to the Earth location of the pixel.
void	set­Transformation­Dimension­Description(International­String new­Value)	Sets a general description of the transformation.
void	set­Transformation­Dimension­Mapping(Collection<? extends International­String> new­Values)	Sets information about which grid dimensions are the spatial dimensions.

Methods inherited from class DefaultGridSpatialRepresentation

cast­Or­Copy, get­Axis­Dimension­Properties, get­Cell­Geometry, get­Number­Of­Dimensions, is­Transformation­Parameter­Available, set­Axis­Dimension­Properties, set­Cell­Geometry, set­Number­Of­Dimensions, set­Transformation­Parameter­Available

Modifier and Type	Method	Description
static Default­Grid­Spatial­Representation	cast­Or­Copy(Grid­Spatial­Representation object)	Returns a SIS metadata implementation with the values of the given arbitrary implementation.
List<Dimension>	get­Axis­Dimension­Properties()	Returns information about spatial-temporal axis properties.
Cell­Geometry	get­Cell­Geometry()	Returns the identification of grid data as point or cell.
Integer	get­Number­Of­Dimensions()	Returns the number of independent spatial-temporal axes.
boolean	is­Transformation­Parameter­Available()	Returns indication of whether or not parameters for transformation exists.
void	set­Axis­Dimension­Properties(List<? extends Dimension> new­Values)	Sets the information about spatial-temporal axis properties.
void	set­Cell­Geometry(Cell­Geometry new­Value)	Sets identification of grid data as point or cell.
void	set­Number­Of­Dimensions(Integer new­Value)	Sets the number of independent spatial-temporal axes.
void	set­Transformation­Parameter­Available(boolean new­Value)	Sets indication of whether or not parameters for transformation exists.

Methods inherited from class AbstractSpatialRepresentation

cast­Or­Copy, get­Scope, set­Scope

Modifier and Type	Method	Description
static Abstract­Spatial­Representation	cast­Or­Copy(Spatial­Representation object)	Returns a SIS metadata implementation with the values of the given arbitrary implementation.
Scope	get­Scope()	Returns the level and extent of the spatial representation.
void	set­Scope(Scope new­Value)	Sets the level and extent of the spatial representation.

Methods inherited from class ISOMetadata

get­Identifier, get­Identifier­Map, get­Identifiers, get­Standard, set­Identifier

Modifier and Type	Method	Description
protected Identifier	get­Identifier()	Returns the first identifier which is presumed to be defined by ISO 19115 conceptual model.
Identifier­Map	get­Identifier­Map()	A map view of the identifiers collection as (authority, code) entries.
Collection<Identifier>	get­Identifiers()	Returns all identifiers associated with this object (from conceptual model and from XML document).
Metadata­Standard	get­Standard()	Returns the metadata standard implemented by subclasses, which is ISO 19115.
protected void	set­Identifier(Identifier new­Value)	Sets the identifier for metadata objects that are expected to contain at most one ISO 19115 identifier.

Methods inherited from class ModifiableMetadata

check­Write­Permission, copy­Collection, copy­List, copy­Map, copy­Set, deep­Copy, merge, non­Null­Collection, non­Null­List, non­Null­Map, non­Null­Set, singleton, state, write­Collection, write­List, write­Map, write­Set

Modifier and Type	Method	Description
protected void	check­Write­Permission(Object current)	Checks if changes in the metadata are allowed.
protected static <E> Collection<E>	copy­Collection(Collection<? extends E> source, Class<E> element­Type)	Creates a list or set with the content of the source collection, or returns null if the source is null or empty.
protected static <E> List<E>	copy­List(Collection<? extends E> source, Class<E> element­Type)	Creates a list with the content of the source collection, or returns null if the source is null or empty.
protected static <K,V> Map<K,V>	copy­Map(Map<? extends K, ? extends V> source, Class<K> key­Type)	Creates a map with the content of the source map, or returns null if the source is null or empty.
protected static <E> Set<E>	copy­Set(Collection<? extends E> source, Class<E> element­Type)	Creates a set with the content of the source collection, or returns null if the source is null or empty.
Modifiable­Metadata	deep­Copy(Modifiable­Metadata.State target)	Copies (if necessary) this metadata and all its children.
void	merge(Object source)	Merges the data from the given source into this metadata.
protected final <E> Collection<E>	non­Null­Collection(Collection<E> current, Class<E> element­Type)	Returns the specified collection, or a new one if current is null.
protected final <E> List<E>	non­Null­List(List<E> current, Class<E> element­Type)	Returns the specified list, or a new one if current is null.
protected final <K,V> Map<K,V>	non­Null­Map(Map<K,V> current, Class<K> key­Type)	Returns the specified map, or a new one if current is null.
protected final <E> Set<E>	non­Null­Set(Set<E> current, Class<E> element­Type)	Returns the specified set, or a new one if current is null.
protected static <E> Collection<E>	singleton(E value, Class<E> element­Type)	Creates a singleton list or set containing only the given value, if non-null.
Modifiable­Metadata.State	state()	Tells whether this instance of metadata is editable.
protected final <E> Collection<E>	write­Collection(Collection<? extends E> source, Collection<E> target, Class<E> element­Type)	Writes the content of the source collection into the target list or set, creating it if needed.
protected final <E> List<E>	write­List(Collection<? extends E> source, List<E> target, Class<E> element­Type)	Writes the content of the source collection into the target list, creating it if needed.
protected final <K,V> Map<K,V>	write­Map(Map<? extends K, ? extends V> source, Map<K,V> target, Class<K> key­Type)	Writes the content of the source map into the target map, creating it if needed.
protected final <E> Set<E>	write­Set(Collection<? extends E> source, Set<E> target, Class<E> element­Type)	Writes the content of the source collection into the target set, creating it if needed.

Methods inherited from class AbstractMetadata

as­Map, as­Tree­Table, clone, equals, equals, get­Interface, get­Standard­Type, hash­Code, is­Empty, nil­Reasons, prune, to­String

Modifier and Type	Method	Description
Map<String,Object>	as­Map()	Returns a view of the property values in a Map.
Tree­Table	as­Tree­Table()	Returns the property types and values as a tree table.
protected Abstract­Metadata	clone()	Returns a shallow clone of this metadata.
final boolean	equals(Object object)	Performs a strict comparison of this metadata with the given object.
boolean	equals(Object object, Comparison­Mode mode)	Compares this metadata with the specified object for equality.
final Class<?>	get­Interface()	Deprecated, for removal: This API element is subject to removal in a future version. Renamed Abstract­Metadata.get­Standard­Type() for integration with Lenient­Comparable.
Type	get­Standard­Type()	Returns the metadata interface implemented by this class.
int	hash­Code()	Computes a hash code value for this metadata using Java reflection.
boolean	is­Empty()	Returns true if this metadata contains only null, nil or empty properties.
Map<String, Nil­Reason>	nil­Reasons()	Returns a view of the reasons why some properties are missing.
void	prune()	Removes all references to empty properties.
String	to­String()	Returns a string representation of this metadata.

Methods inherited from class Object

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

Constructor Details

DefaultGeorectified

public DefaultGeorectified()

Constructs an initially empty georectified object.

DefaultGeorectified

public DefaultGeorectified(Georectified object)

Constructs a new instance initialized with the values from the specified metadata object. This is a shallow copy constructor, because the other metadata contained in the given object are not recursively copied.

Parameters:

object - the metadata to copy values from, or null if none.

See Also:

• cast­Or­Copy(Georectified)

Method Details

castOrCopy

public static DefaultGeorectified castOrCopy(Georectified object)

Returns a SIS metadata implementation with the values of the given arbitrary implementation. This method performs the first applicable action in the following choices:

• If the given object is null, then this method returns null.
• Otherwise if the given object is already an instance of Default­Georectified, then it is returned unchanged.
• Otherwise a new Default­Georectified instance is created using the copy constructor and returned. Note that this is a shallow copy operation, because the other metadata contained in the given object are not recursively copied.

Parameters:

object - the object to get as a SIS implementation, or null if none.

Returns:

a SIS implementation containing the values of the given object (may be the given object itself), or null if the argument was null.

isCheckPointAvailable

public boolean isCheckPointAvailable()

Returns an indication of whether or not geographic position points are available to test the accuracy of the georeferenced grid data.

Specified by:

is­Check­Point­Available in interface Georectified

Returns:

whether or not geographic position points are available to test accuracy.

setCheckPointAvailable

public void setCheckPointAvailable(boolean newValue)

Sets an indication of whether or not geographic position points are available to test the accuracy of the georeferenced grid data.

Effect on other properties

If and only if the given new­Value is false, then this method automatically hides the check point description property. The description can be shown again by reverting check­Point­Availability to true.

Parameters:

new­Value - true if check points are available.

getCheckPointDescription

public InternationalString getCheckPointDescription()

Returns a description of geographic position points used to test the accuracy of the georeferenced grid data. This value is non-null only if is­Check­Point­Available() returns true.

Specified by:

get­Check­Point­Description in interface Georectified

Returns:

description of geographic position points used to test accuracy, or null.

setCheckPointDescription

public void setCheckPointDescription(InternationalString newValue)

Sets the description of geographic position points used to test the accuracy of the georeferenced grid data.

Effect on other properties

If and only if the given new­Value is non-null, then this method automatically sets the check point availability property to true.

Parameters:

new­Value - the new check point description.

getCornerPoints

public List<Point> getCornerPoints()

Returns the Earth location in the coordinate system defined by the Spatial Reference System and the grid coordinate of the cells at opposite ends of grid coverage along two diagonals.

Specified by:

get­Corner­Points in interface Georectified

Returns:

the corner points.

setCornerPoints

public void setCornerPoints(List<? extends Point> newValues)

Sets the corner points. The list size should be 2 or 4. The list should contain at least two corner points along one diagonal. or may contain the 4 corner points of the georectified grid.

The first corner point shall correspond to the origin of the grid.

Parameters:

new­Values - the new corner points.

getCenterPoint

public Point getCenterPoint()

Returns the Earth location in the coordinate system defined by the Spatial Reference System and the grid coordinate of the cell halfway between opposite ends of the grid in the spatial dimensions.

Upcoming API change
This method may be renamed get­Centre­Point() in GeoAPI 4.0 for compliance with ISO 19115:2014.

Specified by:

get­Center­Point in interface Georectified

Returns:

the center point, or null.

setCenterPoint

public void setCenterPoint(Point newValue)

Sets the center point.

Upcoming API change
This method may be renamed set­Centre­Point(…) in GeoAPI 4.0 for compliance with ISO 19115:2014.

Parameters:

new­Value - the new center point.

getPointInPixel

public PixelOrientation getPointInPixel()

Returns the point in a pixel corresponding to the Earth location of the pixel.

Specified by:

get­Point­In­Pixel in interface Georectified

Returns:

earth location of the pixel, or null.

setPointInPixel

public void setPointInPixel(PixelOrientation newValue)

Sets the point in a pixel corresponding to the Earth location of the pixel.

Parameters:

new­Value - the new point in a pixel.

getTransformationDimensionDescription

public InternationalString getTransformationDimensionDescription()

Returns a general description of the transformation.

Specified by:

get­Transformation­Dimension­Description in interface Georectified

Returns:

general description of the transformation, or null.

setTransformationDimensionDescription

public void setTransformationDimensionDescription(InternationalString newValue)

Sets a general description of the transformation.

Parameters:

new­Value - the new general description.

getTransformationDimensionMapping

public Collection<InternationalString> getTransformationDimensionMapping()

Returns information about which grid dimensions are the spatial dimensions.

Specified by:

get­Transformation­Dimension­Mapping in interface Georectified

Returns:

information about which grid dimensions are the spatial dimensions, or null.

setTransformationDimensionMapping

public void setTransformationDimensionMapping(Collection<? extends InternationalString> newValues)

Sets information about which grid dimensions are the spatial dimensions. The given list should contain at most 2 elements.

Parameters:

new­Values - the new transformation mapping.

getCheckPoints

public Collection<GCP> getCheckPoints()

Returns the geographic references used to validate georectification of the data.

Specified by:

get­Check­Points in interface Georectified

Returns:

geographic references used to validate georectification.

setCheckPoints

public void setCheckPoints(Collection<? extends GCP> newValues)

Sets the geographic references used to validate georectification of the data.

Parameters:

new­Values - the new check points values.