sis-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From desruisse...@apache.org
Subject svn commit: r1577773 - /sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/parameter/package-info.java
Date Sat, 15 Mar 2014 01:38:22 GMT
Author: desruisseaux
Date: Sat Mar 15 01:38:22 2014
New Revision: 1577773

URL: http://svn.apache.org/r1577773
Log:
Added package info documentation.

Added:
    sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/parameter/package-info.java
  (with props)

Added: sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/parameter/package-info.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/parameter/package-info.java?rev=1577773&view=auto
==============================================================================
--- sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/parameter/package-info.java
(added)
+++ sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/parameter/package-info.java
[UTF-8] Sat Mar 15 01:38:22 2014
@@ -0,0 +1,57 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/**
+ * Descriptions and values of parameters used by a coordinate operation or a process.
+ * An explanation for this package is provided in the {@linkplain org.opengis.parameter OpenGIS®
javadoc}.
+ * The remaining discussion on this page is specific to the SIS implementation.
+ *
+ * <p>Parameters are organized in <cite>groups</cite>. A group may be for
example the set of all parameters needed
+ * for the definition of a <cite>Mercator projection</cite>. When using this
{@code org.apache.sis.parameter} package,
+ * the starting point is usually to obtain a {@linkplain org.apache.sis.parameter.DefaultParameterDescriptorGroup
+ * 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.</p>
+ *
+ * <p>Each parameter have a name and a cardinality (i.e. the parameter may be mandatory
or optional). Parameter values
+ * may also be constrained to a {@linkplain org.apache.sis.parameter.DefaultParameterDescriptor#getValueDomain()
domain},
+ * have a {@linkplain org.apache.sis.parameter.DefaultParameterDescriptor#getDefaultValue()
default value} and a
+ * {@linkplain org.apache.sis.parameter.DefaultParameterDescriptor#getUnit() unit of measurement}.
+ * All those information are provided by the descriptors.</p>
+ *
+ * <p>Given a group descriptor, users can obtain a new instance of parameter values
by a call to the
+ * {@link org.apache.sis.parameter.DefaultParameterDescriptorGroup#createValue() createValue()}
method.
+ * New value groups initially contain all mandatory parameters with their default values
and no optional parameter.
+ * A {@link org.apache.sis.parameter.DefaultParameterValueGroup#parameter(String) 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.</p>
+ *
+ * <div class="note"><b>Example:</b> the following code snippet assumes
that the implementor of a Mercator projection
+ * provides a {@code ParameterDescriptorGroup} instance in a {@code PARAMETERS} static constant:
+ *
+ * {@preformat java
+ *     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.
+ * }
+ * </div>
+ *
+ * @author  Martin Desruisseaux (IRD, Geomatys)
+ * @since   0.4 (derived from geotk-2.0)
+ * @version 0.4
+ * @module
+ */
+package org.apache.sis.parameter;

Propchange: sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/parameter/package-info.java
------------------------------------------------------------------------------
    svn:eol-style = native

Propchange: sis/branches/JDK7/core/sis-referencing/src/main/java/org/apache/sis/parameter/package-info.java
------------------------------------------------------------------------------
    svn:mime-type = text/plain;charset=UTF-8



Mime
View raw message