Module org.opengis.geoapi.conformance

Package org.opengis.test

Class Configuration.Key<T>

Object

CodeList<Configuration.Key<?>>

Key<T>

Type Parameters:

T - the type of values associated with the key.

All Implemented Interfaces:

Serializable, Comparable<Configuration.Key<?>>, ControlledVocabulary

Enclosing class:

Configuration

public static final class Configuration.Key<T>
extends CodeList<Configuration.Key<?>>

Type-safe keys that can be used in a Configuration map. This code list is extensible: users can create new instances by invoking the valueOf(String, Class) static method.

Note on field names

Every constants declared in this class have a name matching exactly the field names in TestCase subclasses. This is a departure from the usual all upper-case letters convention, but make the relationship with fields more obvious and the parsing of Properties files easier.

Since:

3.1

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 Configuration.Key<CoordinateOperationAuthorityFactory>	copAuthorityFactory	The Coordinate Operation authority factory instance used for a test.
static final Configuration.Key<CoordinateOperationFactory>	copFactory	The Coordinate Operation factory instance used for a test.
static final Configuration.Key<CRSAuthorityFactory>	crsAuthorityFactory	The Coordinate Reference System authority factory instance used for a test.
static final Configuration.Key<CRSFactory>	crsFactory	The Coordinate Reference System factory instance used for a test.
static final Configuration.Key<CSAuthorityFactory>	csAuthorityFactory	The Coordinate System authority factory instance used for a test.
static final Configuration.Key<CSFactory>	csFactory	The Coordinate System factory instance used for a test.
static final Configuration.Key<DatumAuthorityFactory>	datumAuthorityFactory	The Datum authority factory instance used for a test.
static final Configuration.Key<DatumFactory>	datumFactory	The Datum factory instance used for a test.
static final Configuration.Key<Boolean>	isAxisSwappingSupported	Whether (y,x) axis order is supported.
static final Configuration.Key<Boolean>	isDependencyIdentificationSupported	Whether the IdentifiedObject instances created indirectly by the factories are expected to have correct identification information.
static final Configuration.Key<Boolean>	isDeprecatedObjectCreationSupported	Whether the authority factory supports creation of deprecated IdentifiedObject instances.
static final Configuration.Key<Boolean>	isDerivativeSupported	Whether MathTransform.derivative(DirectPosition) is supported.
static final Configuration.Key<Boolean>	isDoubleToDoubleSupported	Whether MathTransform.transform(double[], int, double[], int, int) is supported.
static final Configuration.Key<Boolean>	isDoubleToFloatSupported	Whether MathTransform.transform(double[], int, float[], int, int) is supported.
static final Configuration.Key<Boolean>	isFactoryPreservingUserValues	Whether the objects created by the tested ObjectFactory use the specified values as-is.
static final Configuration.Key<Boolean>	isFloatToDoubleSupported	Whether MathTransform.transform(float[], int, double[], int, int) is supported.
static final Configuration.Key<Boolean>	isFloatToFloatSupported	Whether MathTransform.transform(float[], int, float[], int, int) is supported.
static final Configuration.Key<Boolean>	isInverseTransformSupported	Whether MathTransform.inverse() is supported.
static final Configuration.Key<Boolean>	isMixedNameSyntaxSupported	Whether the GenericName instances can apply different syntax rules in different parts of their name.
static final Configuration.Key<Boolean>	isMultiLocaleSupported	Whether the InternationalString instances can support more than one Locale.
static final Configuration.Key<Boolean>	isNonBidimensionalSpaceSupported	Whether MathTransformFactory can create transforms between spaces that are not two-dimensional.
static final Configuration.Key<Boolean>	isNonSquareMatrixSupported	Whether MathTransformFactory.createAffineTransform(Matrix) accepts non-square matrixes.
static final Configuration.Key<Boolean>	isOverlappingArraySupported	Whether source and destination arrays can overlap in MathTransform operations.
static final Configuration.Key<Boolean>	isStandardAliasSupported	Whether the IdentifiedObject instances have at least the aliases declared in the EPSG database.
static final Configuration.Key<Boolean>	isStandardNameSupported	Whether the IdentifiedObject instances have names matching the names declared in the EPSG database.
static final Configuration.Key<Boolean>	isToleranceRelaxed	Whether the tolerance threshold of a TransformTestCase has been relaxed.
static final Configuration.Key<Boolean>	isValidationEnabled	Whether the test methods can invoke a validators.validate(…)} method.
static final Configuration.Key<MathTransformFactory>	mtFactory	The Math Transform factory instance used for a test.
static final Configuration.Key<Units>	units	The provider of units to use for tests.
static final Configuration.Key<ValidatorContainer>	validators	The set of Validator instances to use for validating objects.

Method Summary

Modifier and Type	Method	Description
Configuration.Key<?>[]	family()	Returns the list of codes of the same kind as this code list element.
static <T> Configuration.Key<? extends T>	valueOf(String name, Class<T> type)	Returns the key that matches the given name, or returns a new one if none match it.
static Configuration.Key<?>[]	values()	Returns the list of Keys.
Class<T>	valueType()	Returns the type of values assigned to this key.

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

isMultiLocaleSupported

public static final Configuration.Key<Boolean> isMultiLocaleSupported

Whether the InternationalString instances can support more than one Locale. If false, then the factory method may retain only one locale among the set of user-provided localized strings.

See Also:

• NameTest.isMultiLocaleSupported

isMixedNameSyntaxSupported

public static final Configuration.Key<Boolean> isMixedNameSyntaxSupported

Whether the GenericName instances can apply different syntax rules in different parts of their name. If true, then URI using different separators in different parts of their name (e.g. ":", ".", "/" and "#" in "http://www.opengis.net/gml/srs/epsg.xml#4326") are supported. If false, then only a single rule can be applied to the name as a whole (e.g. only the ":" separator is used in "urn:ogc:def:crs:epsg:4326").

See Also:

• NameTest.isMixedNameSyntaxSupported

isStandardNameSupported

public static final Configuration.Key<Boolean> isStandardNameSupported

Whether the IdentifiedObject instances have names matching the names declared in the EPSG database.

isStandardAliasSupported

public static final Configuration.Key<Boolean> isStandardAliasSupported

Whether the IdentifiedObject instances have at least the aliases declared in the EPSG database.

isDependencyIdentificationSupported

public static final Configuration.Key<Boolean> isDependencyIdentificationSupported

Whether the IdentifiedObject instances created indirectly by the factories are expected to have correct identification information.

isDeprecatedObjectCreationSupported

public static final Configuration.Key<Boolean> isDeprecatedObjectCreationSupported

Whether the authority factory supports creation of deprecated IdentifiedObject instances.

isDoubleToDoubleSupported

public static final Configuration.Key<Boolean> isDoubleToDoubleSupported

Whether MathTransform.transform(double[], int, double[], int, int) is supported. Implementers can set the value for this key to false in order to test MathTransform instances which are not yet fully implemented.

See Also:

• TransformTestCase.isDoubleToDoubleSupported

isFloatToFloatSupported

public static final Configuration.Key<Boolean> isFloatToFloatSupported

Whether MathTransform.transform(float[], int, float[], int, int) is supported. Implementers can set the value for this key to false in order to test MathTransform instances which are not yet fully implemented.

See Also:

• TransformTestCase.isFloatToFloatSupported

isDoubleToFloatSupported

public static final Configuration.Key<Boolean> isDoubleToFloatSupported

Whether MathTransform.transform(double[], int, float[], int, int) is supported. Implementers can set the value for this key to false in order to test MathTransform instances which are not yet fully implemented.

See Also:

• TransformTestCase.isDoubleToFloatSupported

isFloatToDoubleSupported

public static final Configuration.Key<Boolean> isFloatToDoubleSupported

Whether MathTransform.transform(float[], int, double[], int, int) is supported. Implementers can set the value for this key to false in order to test MathTransform instances which are not yet fully implemented.

See Also:

• TransformTestCase.isFloatToDoubleSupported

isOverlappingArraySupported

public static final Configuration.Key<Boolean> isOverlappingArraySupported

Whether source and destination arrays can overlap in MathTransform operations. Overlapping occur when:

• The invoked method is one of the following:
  • MathTransform.transform(double[], int, double[], int, int)
  • MathTransform.transform(float[], int, float[], int, int)
• The srcPts and dstPts arguments are references to the same array.
• The srcOff and dstOff offsets are such that the source region of the array overlaps with the target region.

See Also:

• TransformTestCase.isOverlappingArraySupported

isInverseTransformSupported

public static final Configuration.Key<Boolean> isInverseTransformSupported

Whether MathTransform.inverse() is supported. Implementers can set the value for this key to false in order to test MathTransform instances which are not yet fully implemented.

See Also:

• TransformTestCase.isInverseTransformSupported

isDerivativeSupported

public static final Configuration.Key<Boolean> isDerivativeSupported

Whether MathTransform.derivative(DirectPosition) is supported. Implementers can set the value for this key to false in order to test MathTransform instances which are not yet fully implemented.

See Also:

• TransformTestCase.isDerivativeSupported

isNonSquareMatrixSupported

public static final Configuration.Key<Boolean> isNonSquareMatrixSupported

Whether MathTransformFactory.createAffineTransform(Matrix) accepts non-square matrixes.

See Also:

• AffineTransformTest.isNonSquareMatrixSupported

isNonBidimensionalSpaceSupported

public static final Configuration.Key<Boolean> isNonBidimensionalSpaceSupported

Whether MathTransformFactory can create transforms between spaces that are not two-dimensional. If true, then the tested spaces may be one-dimensional (typically elevation or time), three-dimensional or four-dimensional.

See Also:

• AffineTransformTest.isNonBidimensionalSpaceSupported

isAxisSwappingSupported

public static final Configuration.Key<Boolean> isAxisSwappingSupported

Whether (y,x) axis order is supported. This axis swapping is not supported, then the tests that would normally expect (y,x) axis order or South Oriented CRS will rather use the (x,y) axis order and North Oriented CRS in their test.

See Also:

• AuthorityFactoryTest.isAxisSwappingSupported

isValidationEnabled

public static final Configuration.Key<Boolean> isValidationEnabled

Whether the test methods can invoke a validators.validate(…)} method. GeoAPI allows to disable the validation checks in some tests where strict conformance to a standard is relaxed.

Example: ISO 19111 (the Referencing by Coordinates abstract model) specifies that the name of the latitude axis in a geographic CRS shall be Geodetic latitude while ISO 19162 (a.k.a Well Known Text 2) specifies Latitude. Consequently, the GeoAPI conformance module allows implementer to disable the check for ISO 19111 conformance if their WKT parser does not adapt the parsed CRS objects to the ISO 19111 axis naming.

See Also:

• WKTParserTest.isValidationEnabled

isToleranceRelaxed

public static final Configuration.Key<Boolean> isToleranceRelaxed

Whether the tolerance threshold of a TransformTestCase has been relaxed. This information is determined after test execution.

units

public static final Configuration.Key<Units> units

The provider of units to use for tests. If this configuration hint is not specified, then the default instance is used.

mtFactory

public static final Configuration.Key<MathTransformFactory> mtFactory

The Math Transform factory instance used for a test.

See Also:

• AffineTransformTest.mtFactory
• ParameterizedTransformTest.mtFactory
• PseudoEpsgFactory.mtFactory

copFactory

public static final Configuration.Key<CoordinateOperationFactory> copFactory

The Coordinate Operation factory instance used for a test.

See Also:

• PseudoEpsgFactory.copFactory

copAuthorityFactory

public static final Configuration.Key<CoordinateOperationAuthorityFactory> copAuthorityFactory

The Coordinate Operation authority factory instance used for a test.

crsFactory

public static final Configuration.Key<CRSFactory> crsFactory

The Coordinate Reference System factory instance used for a test.

See Also:

• ObjectFactoryTest.crsFactory
• PseudoEpsgFactory.crsFactory

crsAuthorityFactory

public static final Configuration.Key<CRSAuthorityFactory> crsAuthorityFactory

The Coordinate Reference System authority factory instance used for a test.

See Also:

• AuthorityFactoryTest.crsAuthorityFactory

csFactory

public static final Configuration.Key<CSFactory> csFactory

The Coordinate System factory instance used for a test.

See Also:

• ObjectFactoryTest.csFactory
• PseudoEpsgFactory.csFactory

csAuthorityFactory

public static final Configuration.Key<CSAuthorityFactory> csAuthorityFactory

The Coordinate System authority factory instance used for a test.

See Also:

• AuthorityFactoryTest.csAuthorityFactory

datumFactory

public static final Configuration.Key<DatumFactory> datumFactory

The Datum factory instance used for a test.

See Also:

• ObjectFactoryTest.datumFactory
• PseudoEpsgFactory.datumFactory

datumAuthorityFactory

public static final Configuration.Key<DatumAuthorityFactory> datumAuthorityFactory

The Datum authority factory instance used for a test.

See Also:

• AuthorityFactoryTest.datumAuthorityFactory

isFactoryPreservingUserValues

public static final Configuration.Key<Boolean> isFactoryPreservingUserValues

Whether the objects created by the tested ObjectFactory use the specified values as-is. This flag should be set to false if the factory performs any of the following operations:

• Convert numerical values from user-provided linear units to metres.
• Convert numerical values from user-provided angular units to degrees.
• Change ellipsoid second defining parameter (e.g. from semi-major axis length to an equivalent inverse flattening factor).
• Change map projection parameters (e.g. from standard parallel to an equivalent scale factor).
• Any other change that preserve numeric equivalence.

If the factory does not perform any of the above conversions, then this flag can be true.

validators

public static final Configuration.Key<ValidatorContainer> validators

The set of Validator instances to use for validating objects. If no value is provided for this key, then the system-wide default validators are used.

See Also:

• Validators.DEFAULT

Method Details

valueOf

public static <T> Configuration.Key<? extends T> valueOf(String name,
 Class<T> type)

Returns the key that matches the given name, or returns a new one if none match it. If no existing instance is found, then a new one is created for the given name and type.

Type Parameters:

T - the type of the key to fetch.

Parameters:

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

type - the type of the key to fetch.

Returns:

a key matching the given name.

Throws:

NullPointerException - if the given name or type is null.

ClassCastException - if a key is found but the type is not assignable to the given type.

values

public static Configuration.Key<?>[] values()

Returns the list of Keys.

Returns:

the list of keys declared in the current JVM.

family

public Configuration.Key<?>[] family()

Returns the list of codes of the same kind as 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<Configuration.Key<?>>

Returns:

all code values for this code list.

valueType

public Class<T> valueType()

Returns the type of values assigned to this key.

Returns:

the value type.