sis-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From desruisse...@apache.org
Subject svn commit: r1594911 - in /sis/branches/JDK8/core/sis-feature/src/main/java/org/apache/sis/feature: DefaultAssociation.java DefaultAssociationRole.java DefaultAttribute.java DefaultAttributeType.java DefaultFeature.java
Date Thu, 15 May 2014 13:30:19 GMT
Author: desruisseaux
Date: Thu May 15 13:30:19 2014
New Revision: 1594911

URL: http://svn.apache.org/r1594911
Log:
Javadoc.

Modified:
    sis/branches/JDK8/core/sis-feature/src/main/java/org/apache/sis/feature/DefaultAssociation.java
    sis/branches/JDK8/core/sis-feature/src/main/java/org/apache/sis/feature/DefaultAssociationRole.java
    sis/branches/JDK8/core/sis-feature/src/main/java/org/apache/sis/feature/DefaultAttribute.java
    sis/branches/JDK8/core/sis-feature/src/main/java/org/apache/sis/feature/DefaultAttributeType.java
    sis/branches/JDK8/core/sis-feature/src/main/java/org/apache/sis/feature/DefaultFeature.java

Modified: sis/branches/JDK8/core/sis-feature/src/main/java/org/apache/sis/feature/DefaultAssociation.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK8/core/sis-feature/src/main/java/org/apache/sis/feature/DefaultAssociation.java?rev=1594911&r1=1594910&r2=1594911&view=diff
==============================================================================
--- sis/branches/JDK8/core/sis-feature/src/main/java/org/apache/sis/feature/DefaultAssociation.java
[UTF-8] (original)
+++ sis/branches/JDK8/core/sis-feature/src/main/java/org/apache/sis/feature/DefaultAssociation.java
[UTF-8] Thu May 15 13:30:19 2014
@@ -37,6 +37,8 @@ import java.util.Objects;
  * @since   0.5
  * @version 0.5
  * @module
+ *
+ * @see DefaultAssociationRole
  */
 public class DefaultAssociation extends Property implements Cloneable, Serializable {
     /**

Modified: sis/branches/JDK8/core/sis-feature/src/main/java/org/apache/sis/feature/DefaultAssociationRole.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK8/core/sis-feature/src/main/java/org/apache/sis/feature/DefaultAssociationRole.java?rev=1594911&r1=1594910&r2=1594911&view=diff
==============================================================================
--- sis/branches/JDK8/core/sis-feature/src/main/java/org/apache/sis/feature/DefaultAssociationRole.java
[UTF-8] (original)
+++ sis/branches/JDK8/core/sis-feature/src/main/java/org/apache/sis/feature/DefaultAssociationRole.java
[UTF-8] Thu May 15 13:30:19 2014
@@ -26,6 +26,15 @@ import static org.apache.sis.util.Argume
 
 /**
  * Indicates the role played by the association between two features.
+ * In the area of geographic information, there exist multiple kinds of associations:
+ *
+ * <ul>
+ *   <li><b>Aggregation</b> represents associations between features which
can exist even if the aggregate is destroyed.</li>
+ *   <li><b>Composition</b> represents relationships where the owned features
are destroyed together with the composite.</li>
+ *   <li><b>Spatial</b> represents spatial or topological relationships
that may exist between features (e.g. “east of”).</li>
+ *   <li><b>Temporal</b> may represent for example a sequence of changes
over time involving the replacement of some
+ *       feature instances by other feature instances.</li>
+ * </ul>
  *
  * {@section Immutability and thread safety}
  * Instances of this class are immutable if all properties ({@link GenericName} and {@link
InternationalString}
@@ -36,6 +45,8 @@ import static org.apache.sis.util.Argume
  * @since   0.5
  * @version 0.5
  * @module
+ *
+ * @see DefaultAssociation
  */
 public class DefaultAssociationRole extends FieldType {
     /**

Modified: sis/branches/JDK8/core/sis-feature/src/main/java/org/apache/sis/feature/DefaultAttribute.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK8/core/sis-feature/src/main/java/org/apache/sis/feature/DefaultAttribute.java?rev=1594911&r1=1594910&r2=1594911&view=diff
==============================================================================
--- sis/branches/JDK8/core/sis-feature/src/main/java/org/apache/sis/feature/DefaultAttribute.java
[UTF-8] (original)
+++ sis/branches/JDK8/core/sis-feature/src/main/java/org/apache/sis/feature/DefaultAttribute.java
[UTF-8] Thu May 15 13:30:19 2014
@@ -48,6 +48,8 @@ import java.util.Objects;
  * @since   0.5
  * @version 0.5
  * @module
+ *
+ * @see DefaultAttributeType
  */
 public class DefaultAttribute<T> extends Property implements Cloneable, Serializable
{
     /**

Modified: sis/branches/JDK8/core/sis-feature/src/main/java/org/apache/sis/feature/DefaultAttributeType.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK8/core/sis-feature/src/main/java/org/apache/sis/feature/DefaultAttributeType.java?rev=1594911&r1=1594910&r2=1594911&view=diff
==============================================================================
--- sis/branches/JDK8/core/sis-feature/src/main/java/org/apache/sis/feature/DefaultAttributeType.java
[UTF-8] (original)
+++ sis/branches/JDK8/core/sis-feature/src/main/java/org/apache/sis/feature/DefaultAttributeType.java
[UTF-8] Thu May 15 13:30:19 2014
@@ -72,6 +72,8 @@ import java.util.Objects;
  * @since   0.5
  * @version 0.5
  * @module
+ *
+ * @see DefaultAttribute
  */
 public class DefaultAttributeType<T> extends FieldType {
     /**

Modified: sis/branches/JDK8/core/sis-feature/src/main/java/org/apache/sis/feature/DefaultFeature.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK8/core/sis-feature/src/main/java/org/apache/sis/feature/DefaultFeature.java?rev=1594911&r1=1594910&r2=1594911&view=diff
==============================================================================
--- sis/branches/JDK8/core/sis-feature/src/main/java/org/apache/sis/feature/DefaultFeature.java
[UTF-8] (original)
+++ sis/branches/JDK8/core/sis-feature/src/main/java/org/apache/sis/feature/DefaultFeature.java
[UTF-8] Thu May 15 13:30:19 2014
@@ -38,8 +38,12 @@ import org.apache.sis.util.collection.Co
  *   <li>{@linkplain DefaultOperation   Operations}</li>
  * </ul>
  *
- * If a feature allows only attributes and operations (no associations), and if the cardinality
of all attributes
- * is constrained to [1 … 1], then the feature is said “simple”.
+ * {@section Simple features}
+ * A feature is said “simple” if it complies to the following conditions:
+ * <ul>
+ *   <li>the feature allows only attributes and operations (no associations),</li>
+ *   <li>the cardinality of all attributes is constrained to [1 … 1].</li>
+ * </ul>
  *
  * {@section Usage in multi-thread environment}
  * {@code DefaultFeature} are <strong>not</strong> thread-safe.



Mime
View raw message