See: Description
Interface | Description |
---|---|
Parameterized |
An object which can supply its parameters in a
ParameterValueGroup . |
Class | Description |
---|---|
AbstractParameterDescriptor |
Abstract definition of a parameter or group of parameters used by a coordinate operation or a process.
|
DefaultParameterDescriptor<T> |
The definition of a single parameter used by an operation method.
|
DefaultParameterDescriptorGroup |
The definition of a group of related parameters used by an operation method.
|
DefaultParameterValue<T> |
A single parameter value used by an operation method.
|
DefaultParameterValueGroup |
A group of related parameter values.
|
ParameterBuilder |
Helper class for parameter descriptor instantiations.
|
ParameterFormat |
Formats parameter descriptors or
parameter values in a tabular format.
|
Parameters |
Static methods working on parameters and their descriptors.
|
TensorParameters<E> |
Creates parameter groups for tensors (usually matrices).
|
Enum | Description |
---|---|
ParameterFormat.ContentLevel |
The amount of information to include in the table formatted by
ParameterFormat . |
There is three categories of classes in this package:
ParameterDescriptor
s,
the search for parameter values and visualizing them in a tabular format.Parameters are organized in groups.
A group may be for example the set of all parameters needed for the definition of a Mercator projection.
Parameter groups have some similarities with java.util.Map
where:
int
, int[]
, double
, double[]
,
boolean
, String
, URI
or
Citation
.org.apache.sis.parameter
package, the starting point is usually to obtain a
parameter group descriptor for
the operation of interest. Those groups are provided by the operation implementors, so users do not
need to create their own.
Given a group descriptor, users can obtain a new instance of parameter values by a call to the
createValue()
method.
New value groups initially contain all mandatory parameters with their default values and no optional parameter.
A parameter(String)
convenience
method is provided for fetching a parameter regardless of whether it was present or not — optional parameters
are created when first needed.
ParameterDescriptorGroup
instance in a PARAMETERS
static constant:
ParameterValueGroup group = Mercator.PARAMETERS.createValue(); group.parameter("Longitude of natural origin").setValue(-60); // Using default units (e.g. degrees). group.parameter("False easting").setValue(200.0, SI.KILOMETRE); // Using explicit units.
parameter(…)
throw a ParameterNotFoundException
if the given name is unknown to the group.
Calls to setValue(…)
throw a InvalidParameterValueException
if the given value is not assignable to the expected class or is not inside the value domain.Defined in the sis-referencing
module
Copyright © 2010–2015 The Apache Software Foundation. All rights reserved.