Package org.apache.sis.parameter

Class MapProjectionParameters

java.lang.Object

org.apache.sis.parameter.Parameters

org.apache.sis.parameter.DefaultParameterValueGroup

org.apache.sis.parameter.MapProjectionParameters

All Implemented Interfaces:

Serializable, Cloneable, LenientComparable, org.opengis.parameter.GeneralParameterValue, org.opengis.parameter.ParameterValueGroup

final class MapProjectionParameters
extends DefaultParameterValueGroup

Map projection parameters, with special processing for alternative ways to express the ellipsoid axis length and the standard parallels. See MapProjectionDescriptor for more information about those non-standard parameters.

Since:

0.6

Version:

0.8

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static final class	MapProjectionParameters.EarthRadius	The earth radius parameter.
(package private) static final class	MapProjectionParameters.InverseFlattening	The inverse flattening parameter.
(package private) static final class	MapProjectionParameters.IsIvfDefinitive	Whether the inverse flattening parameter is definitive.
(package private) static final class	MapProjectionParameters.StandardParallel	The standard parallels parameter as an array of double.

Field Summary

Fields

Modifier and Type	Field	Description
private org.opengis.parameter.ParameterValue<Double>	earthRadius	The MapProjectionParameters.EarthRadius parameter instance, created when first needed.
private MapProjectionParameters.InverseFlattening	inverseFlattening	The MapProjectionParameters.InverseFlattening parameter instance, created when first needed.
private org.opengis.parameter.ParameterValue<Boolean>	isIvfDefinitive	The MapProjectionParameters.IsIvfDefinitive parameter instance, created when first needed.
private static final long	serialVersionUID	For cross-version compatibility.
private org.opengis.parameter.ParameterValue<double[]>	standardParallel	The MapProjectionParameters.StandardParallel parameter instance, created when first needed.

Constructor Summary

Constructors

Constructor	Description
MapProjectionParameters(MapProjectionDescriptor descriptor)	Creates a new parameter value group.

Method Summary

Modifier and Type	Method	Description
MapProjectionParameters	clone()	Returns a deep copy of this group of parameter values.
private MapProjectionParameters.InverseFlattening	getInverseFlattening()	Returns the MapProjectionParameters.InverseFlattening instance, creating it when first needed.
(package private) boolean	isKnownImplementation()	Returns true since the parameterIfExist(String) method below is compatible with DefaultParameterValueGroup.parameter(String).
(package private) org.opengis.parameter.ParameterValue<?>	parameterIfExist(String name)	Returns the value in this group for the specified name.

Methods inherited from class org.apache.sis.parameter.DefaultParameterValueGroup

addGroup, equals, equals, equals, getDescriptor, getOrCreate, getParameter, groups, hashCode, parameter, values

Methods inherited from class org.apache.sis.parameter.Parameters

booleanValue, cast, cast, castOrWrap, copy, doubleValue, doubleValue, doubleValueList, getDescriptors, getMandatoryValue, getMemberName, getValue, getValueDomain, intValue, intValueList, isUnmodifiable, print, stringValue, toString, unmodifiable, unmodifiable

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

serialVersionUID

private static final long serialVersionUID

For cross-version compatibility.

See Also:

• Constant Field Values

earthRadius

private transient org.opengis.parameter.ParameterValue<Double> earthRadius

The MapProjectionParameters.EarthRadius parameter instance, created when first needed. This is an "invisible" parameter, never shown in the DefaultParameterValueGroup.values() list.

inverseFlattening

private transient MapProjectionParameters.InverseFlattening inverseFlattening

The MapProjectionParameters.InverseFlattening parameter instance, created when first needed. This is an "invisible" parameter, never shown in the DefaultParameterValueGroup.values() list.

standardParallel

private transient org.opengis.parameter.ParameterValue<double[]> standardParallel

The MapProjectionParameters.StandardParallel parameter instance, created when first needed. This is an "invisible" parameter, never shown in the DefaultParameterValueGroup.values() list.

isIvfDefinitive

private transient org.opengis.parameter.ParameterValue<Boolean> isIvfDefinitive

The MapProjectionParameters.IsIvfDefinitive parameter instance, created when first needed. This is an "invisible" parameter, never shown in the DefaultParameterValueGroup.values() list.

Constructor Details

MapProjectionParameters

MapProjectionParameters(MapProjectionDescriptor descriptor)

Creates a new parameter value group. An instance of MapProjectionDescriptor is mandatory, because some method in this class will need to cast the descriptor.

Method Details

isKnownImplementation

boolean isKnownImplementation()

Returns true since the parameterIfExist(String) method below is compatible with DefaultParameterValueGroup.parameter(String). Note that we would need to revisit this condition if this class was no longer final.

Overrides:

isKnownImplementation in class DefaultParameterValueGroup

parameterIfExist

org.opengis.parameter.ParameterValue<?> parameterIfExist(String name)
                                                  throws org.opengis.parameter.ParameterNotFoundException

Returns the value in this group for the specified name. If the given name is one of the "invisible" parameters, returns a dynamic parameter view without adding it to the list of real parameter values.

Overrides:

parameterIfExist in class DefaultParameterValueGroup

Parameters:

name - the case insensitive name of the parameter to search for.

Returns:

the parameter value for the given name.

Throws:

org.opengis.parameter.ParameterNotFoundException - if there is no parameter value for the given name.

See Also:

• DefaultParameterValueGroup.isKnownImplementation()

getInverseFlattening

private MapProjectionParameters.InverseFlattening getInverseFlattening()

Returns the MapProjectionParameters.InverseFlattening instance, creating it when first needed. This parameter is used also by MapProjectionParameters.IsIvfDefinitive.

clone

public MapProjectionParameters clone()

Returns a deep copy of this group of parameter values. Included parameter values and subgroups are cloned recursively.

Specified by:

clone in interface org.opengis.parameter.GeneralParameterValue

Specified by:

clone in interface org.opengis.parameter.ParameterValueGroup

Overrides:

clone in class DefaultParameterValueGroup

Returns:

a copy of this group of parameter values.

See Also:

• Parameters.copy(ParameterValueGroup, ParameterValueGroup)