You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@sis.apache.org by de...@apache.org on 2013/07/08 16:03:34 UTC
svn commit: r1500741 [2/3] - in /sis/branches/JDK7/core:
sis-metadata/src/main/java/org/apache/sis/metadata/iso/
sis-metadata/src/main/java/org/apache/sis/metadata/iso/acquisition/
sis-metadata/src/main/java/org/apache/sis/metadata/iso/citation/ sis-me...
Modified: sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/content/DefaultBand.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/content/DefaultBand.java?rev=1500741&r1=1500740&r2=1500741&view=diff
==============================================================================
--- sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/content/DefaultBand.java [UTF-8] (original)
+++ sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/content/DefaultBand.java [UTF-8] Mon Jul 8 14:03:32 2013
@@ -200,8 +200,11 @@ public class DefaultBand extends Default
}
/**
- * Returns the longest wavelength that the sensor is capable of collecting within
- * a designated band.
+ * Returns the longest wavelength that the sensor is capable of collecting within a designated band.
+ * The units of measurement is given by {@link #getUnits()}.
+ *
+ * @return Longest wavelength that the sensor is capable of collecting within a designated band,
+ * or {@code null} if unspecified.
*/
@Override
@XmlElement(name = "maxValue")
@@ -211,8 +214,7 @@ public class DefaultBand extends Default
}
/**
- * Sets the longest wavelength that the sensor is capable of collecting within a
- * designated band.
+ * Sets the longest wavelength that the sensor is capable of collecting within a designated band.
*
* @param newValue The new longest wavelength.
*/
@@ -222,8 +224,11 @@ public class DefaultBand extends Default
}
/**
- * Returns the shortest wavelength that the sensor is capable of collecting
- * within a designated band.
+ * Returns the shortest wavelength that the sensor is capable of collecting within a designated band.
+ * The units of measurement is given by {@link #getUnits()}.
+ *
+ * @return Shortest wavelength that the sensor is capable of collecting within a designated band,
+ * or {@code null} if unspecified.
*/
@Override
@XmlElement(name = "minValue")
@@ -233,8 +238,7 @@ public class DefaultBand extends Default
}
/**
- * Sets the shortest wavelength that the sensor is capable of collecting within
- * a designated band.
+ * Sets the shortest wavelength that the sensor is capable of collecting within a designated band.
*
* @param newValue The new shortest wavelength.
*/
@@ -244,9 +248,11 @@ public class DefaultBand extends Default
}
/**
- * Returns the units in which sensor wavelengths are expressed. Should be non-null
+ * Returns the units in which sensor wavelengths are expressed. Shall be non-null
* if {@linkplain #getMinValue() min value} or {@linkplain #getMaxValue() max value}
* are provided.
+ *
+ * @return Units in which sensor wavelengths are expressed, or {@code null}.
*/
@Override
@XmlElement(name = "units")
@@ -255,7 +261,7 @@ public class DefaultBand extends Default
}
/**
- * Sets the units in which sensor wavelengths are expressed. Should be non-null if
+ * Sets the units in which sensor wavelengths are expressed. Shall be non-null if
* {@linkplain #getMinValue() min value} or {@linkplain #getMaxValue() max value}
* are provided.
*
@@ -268,6 +274,9 @@ public class DefaultBand extends Default
/**
* Returns the wavelength at which the response is the highest.
+ * The units of measurement is given by {@link #getUnits()}.
+ *
+ * @return Wavelength at which the response is the highest, or {@code null} if unspecified.
*/
@Override
@XmlElement(name = "peakResponse")
@@ -288,6 +297,8 @@ public class DefaultBand extends Default
/**
* Returns the maximum number of significant bits in the uncompressed
* representation for the value in each band of each pixel.
+ *
+ * @return Maximum number of significant bits in the uncompressed representation, or {@code null}.
*/
@Override
@ValueRange(minimum=1)
@@ -309,6 +320,8 @@ public class DefaultBand extends Default
/**
* Returns the number of discrete numerical values in the grid data.
+ *
+ * @return Number of discrete numerical values in the grid data, or {@code null}.
*/
@Override
@ValueRange(minimum=0)
@@ -329,6 +342,8 @@ public class DefaultBand extends Default
/**
* Returns the scale factor which has been applied to the cell value.
+ *
+ * @return Scale factor which has been applied to the cell value, or {@code null}.
*/
@Override
@XmlElement(name = "scaleFactor")
@@ -348,6 +363,8 @@ public class DefaultBand extends Default
/**
* Returns the physical value corresponding to a cell value of zero.
+ *
+ * @return The physical value corresponding to a cell value of zero, or {@code null}.
*/
@Override
@XmlElement(name = "offset")
@@ -366,8 +383,9 @@ public class DefaultBand extends Default
}
/**
- * Returns the designation of criterion for defining maximum and minimum wavelengths
- * for a spectral band.
+ * Returns the designation of criterion for defining maximum and minimum wavelengths for a spectral band.
+ *
+ * @return Criterion for defining maximum and minimum wavelengths, or {@code null}.
*/
@Override
@XmlElement(name = "bandBoundaryDefinition", namespace = Namespaces.GMI)
@@ -376,8 +394,7 @@ public class DefaultBand extends Default
}
/**
- * Sets designation of criterion for defining maximum and minimum wavelengths
- * for a spectral band.
+ * Sets designation of criterion for defining maximum and minimum wavelengths for a spectral band.
*
* @param newValue The new band definition.
*/
@@ -389,6 +406,8 @@ public class DefaultBand extends Default
/**
* Returns the smallest distance between which separate points can be distinguished,
* as specified in instrument design.
+ *
+ * @return Smallest distance between which separate points can be distinguished, or {@code null}.
*/
@Override
@ValueRange(minimum=0, isMinIncluded=false)
@@ -410,6 +429,8 @@ public class DefaultBand extends Default
/**
* Returns type of transfer function to be used when scaling a physical value for a given element.
+ *
+ * @return Type of transfer function, or {@code null}.
*/
@Override
@XmlElement(name = "transferFunctionType", namespace = Namespaces.GMI)
@@ -429,6 +450,8 @@ public class DefaultBand extends Default
/**
* Polarization of the radiation transmitted.
+ *
+ * @return Polarization of the radiation transmitted, or {@code null}.
*/
@Override
@XmlElement(name = "transmittedPolarization", namespace = Namespaces.GMI)
@@ -448,6 +471,8 @@ public class DefaultBand extends Default
/**
* Polarization of the radiation detected.
+ *
+ * @return Polarization of the radiation detected, or {@code null}.
*/
@Override
@XmlElement(name = "detectedPolarization", namespace = Namespaces.GMI)
Modified: sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/content/DefaultCoverageDescription.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/content/DefaultCoverageDescription.java?rev=1500741&r1=1500740&r2=1500741&view=diff
==============================================================================
--- sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/content/DefaultCoverageDescription.java [UTF-8] (original)
+++ sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/content/DefaultCoverageDescription.java [UTF-8] Mon Jul 8 14:03:32 2013
@@ -135,6 +135,8 @@ public class DefaultCoverageDescription
/**
* Returns the description of the attribute described by the measurement value.
+ *
+ * @return Description of the attribute, or {@code null}.
*/
@Override
@XmlElement(name = "attributeDescription", required = true)
@@ -154,6 +156,8 @@ public class DefaultCoverageDescription
/**
* Returns the type of information represented by the cell value.
+ *
+ * @return Type of information represented by the cell value, or {@code null}.
*/
@Override
@XmlElement(name = "contentType", required = true)
@@ -173,6 +177,8 @@ public class DefaultCoverageDescription
/**
* Returns the information on the dimensions of the cell measurement value.
+ *
+ * @return Dimensions of the cell measurement value.
*/
@Override
@XmlElement(name = "dimension")
Modified: sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/content/DefaultFeatureCatalogueDescription.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/content/DefaultFeatureCatalogueDescription.java?rev=1500741&r1=1500740&r2=1500741&view=diff
==============================================================================
--- sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/content/DefaultFeatureCatalogueDescription.java [UTF-8] (original)
+++ sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/content/DefaultFeatureCatalogueDescription.java [UTF-8] Mon Jul 8 14:03:32 2013
@@ -148,6 +148,8 @@ public class DefaultFeatureCatalogueDesc
/**
* Returns whether or not the cited feature catalogue complies with ISO 19110.
+ *
+ * @return Whether or not the cited feature catalogue complies with ISO 19110, or {@code null}.
*/
@Override
@XmlElement(name = "complianceCode")
@@ -167,6 +169,8 @@ public class DefaultFeatureCatalogueDesc
/**
* Returns the language(s) used within the catalogue
+ *
+ * @return Language(s) used within the catalogue.
*/
@Override
@XmlElement(name = "language")
@@ -185,6 +189,8 @@ public class DefaultFeatureCatalogueDesc
/**
* Returns whether or not the feature catalogue is included with the dataset.
+ *
+ * @return Whether or not the feature catalogue is included with the dataset.
*/
@Override
@XmlElement(name = "includedWithDataset", required = true)
@@ -208,6 +214,8 @@ public class DefaultFeatureCatalogueDesc
/**
* Returns the subset of feature types from cited feature catalogue occurring in dataset.
+ *
+ * @return Subset of feature types occurring in dataset.
*/
@Override
@XmlElement(name = "featureTypes")
@@ -226,6 +234,8 @@ public class DefaultFeatureCatalogueDesc
/**
* Returns the complete bibliographic reference to one or more external feature catalogues.
+ *
+ * @return Bibliographic reference to one or more external feature catalogues.
*/
@Override
@XmlElement(name = "featureCatalogueCitation", required = true)
Modified: sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/content/DefaultImageDescription.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/content/DefaultImageDescription.java?rev=1500741&r1=1500740&r2=1500741&view=diff
==============================================================================
--- sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/content/DefaultImageDescription.java [UTF-8] (original)
+++ sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/content/DefaultImageDescription.java [UTF-8] Mon Jul 8 14:03:32 2013
@@ -218,6 +218,8 @@ public class DefaultImageDescription ext
* For images from a scanning device, refer to the centre pixel of the image.
*
* <p>The horizon is at 0°, straight up has an elevation of 90°.</p>
+ *
+ * @return A value between -90° and +90°, or {@code null} if unspecified.
*/
@Override
@ValueRange(minimum=0, maximum=180)
@@ -240,8 +242,9 @@ public class DefaultImageDescription ext
/**
* Returns the illumination azimuth measured in degrees clockwise from true north at the time
- * the image is taken. For images from a scanning device, refer to the centre pixel of the
- * image.
+ * the image is taken. For images from a scanning device, refer to the centre pixel of the image.
+ *
+ * @return A value between 0° and 360°, or {@code null} if unspecified.
*/
@Override
@ValueRange(minimum=0, maximum=360)
@@ -263,6 +266,8 @@ public class DefaultImageDescription ext
/**
* Returns the conditions affected the image.
+ *
+ * @return Conditions affected the image, or {@code null} if unspecified.
*/
@Override
@XmlElement(name = "imagingCondition")
@@ -282,6 +287,8 @@ public class DefaultImageDescription ext
/**
* Returns the identifier that specifies the image quality.
+ *
+ * @return The image quality, or {@code null} if unspecified.
*/
@Override
@XmlElement(name = "imageQualityCode")
@@ -301,6 +308,8 @@ public class DefaultImageDescription ext
/**
* Returns the area of the dataset obscured by clouds, expressed as a percentage of the spatial extent.
+ *
+ * @return A value between 0 and 100, or {@code null} if unspecified.
*/
@Override
@ValueRange(minimum=0, maximum=100)
@@ -322,6 +331,9 @@ public class DefaultImageDescription ext
/**
* Returns the image distributor's code that identifies the level of radiometric and geometric
* processing that has been applied.
+ *
+ * @return The level of radiometric and geometric processing that has been applied,
+ * or {@code null} if unspecified.
*/
@Override
@XmlElement(name = "processingLevelCode")
@@ -342,6 +354,9 @@ public class DefaultImageDescription ext
/**
* Returns the count of the number of lossy compression cycles performed on the image.
+ *
+ * @return The number of lossy compression cycles performed on the image,
+ * or {@code null} if unspecified.
*/
@Override
@ValueRange(minimum=0)
@@ -362,6 +377,9 @@ public class DefaultImageDescription ext
/**
* Returns the indication of whether or not triangulation has been performed upon the image.
+ *
+ * @return Whether or not triangulation has been performed upon the image,
+ * or {@code null} if unspecified.
*/
@Override
@XmlElement(name = "triangulationIndicator")
@@ -382,6 +400,9 @@ public class DefaultImageDescription ext
/**
* Returns the indication of whether or not the radiometric calibration information for
* generating the radiometrically calibrated standard data product is available.
+ *
+ * @return Whether or not the radiometric calibration information is available,
+ * or {@code null} if unspecified.
*/
@Override
@XmlElement(name = "radiometricCalibrationDataAvailability")
@@ -403,6 +424,9 @@ public class DefaultImageDescription ext
/**
* Returns the indication of whether or not constants are available which allow for camera
* calibration corrections.
+ *
+ * @return Whether or not constants are available for camera calibration corrections,
+ * or {@code null} if unspecified.
*/
@Override
@XmlElement(name = "cameraCalibrationInformationAvailability")
@@ -423,6 +447,9 @@ public class DefaultImageDescription ext
/**
* Returns the indication of whether or not Calibration Reseau information is available.
+ *
+ * @return Whether or not Calibration Reseau information is available,
+ * or {@code null} if unspecified.
*/
@Override
@XmlElement(name = "filmDistortionInformationAvailability")
@@ -442,6 +469,9 @@ public class DefaultImageDescription ext
/**
* Returns the indication of whether or not lens aberration correction information is available.
+ *
+ * @return Whether or not lens aberration correction information is available,
+ * or {@code null} if unspecified.
*/
@Override
@XmlElement(name = "lensDistortionInformationAvailability")
Modified: sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/content/DefaultRangeDimension.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/content/DefaultRangeDimension.java?rev=1500741&r1=1500740&r2=1500741&view=diff
==============================================================================
--- sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/content/DefaultRangeDimension.java [UTF-8] (original)
+++ sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/content/DefaultRangeDimension.java [UTF-8] Mon Jul 8 14:03:32 2013
@@ -114,8 +114,9 @@ public class DefaultRangeDimension exten
}
/**
- * Returns the number that uniquely identifies instances of bands of wavelengths
- * on which a sensor operates.
+ * Returns the number that uniquely identifies instances of bands of wavelengths on which a sensor operates.
+ *
+ * @return Identifier of bands on which a sensor operates, or {@code null}.
*/
@Override
@XmlElement(name = "sequenceIdentifier")
@@ -124,8 +125,7 @@ public class DefaultRangeDimension exten
}
/**
- * Sets the number that uniquely identifies instances of bands of wavelengths
- * on which a sensor operates.
+ * Sets the number that uniquely identifies instances of bands of wavelengths on which a sensor operates.
*
* @param newValue The new sequence identifier.
*/
@@ -136,6 +136,8 @@ public class DefaultRangeDimension exten
/**
* Returns the description of the range of a cell measurement value.
+ *
+ * @return Description of the range of a cell measurement value, or {@code null}.
*/
@Override
@XmlElement(name = "descriptor")
Modified: sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/content/DefaultRangeElementDescription.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/content/DefaultRangeElementDescription.java?rev=1500741&r1=1500740&r2=1500741&view=diff
==============================================================================
--- sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/content/DefaultRangeElementDescription.java [UTF-8] (original)
+++ sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/content/DefaultRangeElementDescription.java [UTF-8] Mon Jul 8 14:03:32 2013
@@ -114,6 +114,8 @@ public class DefaultRangeElementDescript
/**
* Returns the designation associated with a set of range elements.
+ *
+ * @return Designation associated with a set of range elements, or {@code null}.
*/
@Override
@XmlElement(name = "name", namespace = Namespaces.GMI, required = true)
@@ -133,6 +135,8 @@ public class DefaultRangeElementDescript
/**
* Returns the description of a set of specific range elements.
+ *
+ * @return Description of a set of specific range elements, or {@code null}.
*/
@Override
@XmlElement(name = "definition", namespace = Namespaces.GMI, required = true)
@@ -154,6 +158,8 @@ public class DefaultRangeElementDescript
* Returns the specific range elements, i.e. range elements associated with a name
* and their definition.
*
+ * @return Specific range elements.
+ *
* @todo implements {@link Record} in order to use the annotation.
*/
@Override
Modified: sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/distribution/DefaultDataFile.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/distribution/DefaultDataFile.java?rev=1500741&r1=1500740&r2=1500741&view=diff
==============================================================================
--- sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/distribution/DefaultDataFile.java [UTF-8] (original)
+++ sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/distribution/DefaultDataFile.java [UTF-8] Mon Jul 8 14:03:32 2013
@@ -113,6 +113,8 @@ public class DefaultDataFile extends ISO
* the transfer choices, a data file may contain data related to one or many feature types.
* This attribute may be omitted when the dataset is composed of a single file and/or the
* data does not relate to a feature catalogue.
+ *
+ * @return List of features types concerned by the transfer data file.
*/
@Override
@XmlElement(name = "featureType", namespace = Namespaces.GMX)
@@ -131,6 +133,8 @@ public class DefaultDataFile extends ISO
/**
* Returns the format of the transfer data file.
+ *
+ * @return Format of the transfer data file, or {@code null}.
*/
@Override
@XmlElement(name = "fileFormat", namespace = Namespaces.GMX, required = true)
Modified: sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/distribution/DefaultDigitalTransferOptions.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/distribution/DefaultDigitalTransferOptions.java?rev=1500741&r1=1500740&r2=1500741&view=diff
==============================================================================
--- sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/distribution/DefaultDigitalTransferOptions.java [UTF-8] (original)
+++ sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/distribution/DefaultDigitalTransferOptions.java [UTF-8] Mon Jul 8 14:03:32 2013
@@ -126,6 +126,8 @@ public class DefaultDigitalTransferOptio
/**
* Returns tiles, layers, geographic areas, <i>etc.</i>, in which data is available.
+ *
+ * @return Tiles, layers, geographic areas, <cite>etc.</cite> in which data is available, or {@code null}.
*/
@Override
@XmlElement(name = "unitsOfDistribution")
@@ -146,6 +148,8 @@ public class DefaultDigitalTransferOptio
/**
* Returns an estimated size of a unit in the specified transfer format, expressed in megabytes.
* The transfer size is greater than zero.
+ *
+ * @return Estimated size of a unit in the specified transfer format in megabytes, or {@code null}.
*/
@Override
@XmlElement(name = "transferSize")
@@ -168,6 +172,8 @@ public class DefaultDigitalTransferOptio
/**
* Returns information about online sources from which the resource can be obtained.
+ *
+ * @return Online sources from which the resource can be obtained.
*/
@Override
@XmlElement(name = "onLine")
@@ -186,6 +192,8 @@ public class DefaultDigitalTransferOptio
/**
* Returns information about offline media on which the resource can be obtained.
+ *
+ * @return Offline media on which the resource can be obtained, or {@code null}.
*/
@Override
@XmlElement(name = "offLine")
Modified: sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/distribution/DefaultDistribution.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/distribution/DefaultDistribution.java?rev=1500741&r1=1500740&r2=1500741&view=diff
==============================================================================
--- sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/distribution/DefaultDistribution.java [UTF-8] (original)
+++ sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/distribution/DefaultDistribution.java [UTF-8] Mon Jul 8 14:03:32 2013
@@ -116,6 +116,8 @@ public class DefaultDistribution extends
/**
* Provides a description of the format of the data to be distributed.
+ *
+ * @return Description of the format of the data to be distributed.
*/
@Override
@XmlElement(name = "distributionFormat")
@@ -134,6 +136,8 @@ public class DefaultDistribution extends
/**
* Provides information about the distributor.
+ *
+ * @return Information about the distributor.
*/
@Override
@XmlElement(name = "distributor")
@@ -151,8 +155,9 @@ public class DefaultDistribution extends
}
/**
- * Provides information about technical means and media by which a resource is obtained
- * from the distributor.
+ * Provides information about technical means and media by which a resource is obtained from the distributor.
+ *
+ * @return Technical means and media by which a resource is obtained from the distributor.
*/
@Override
@XmlElement(name = "transferOptions")
Modified: sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/distribution/DefaultDistributor.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/distribution/DefaultDistributor.java?rev=1500741&r1=1500740&r2=1500741&view=diff
==============================================================================
--- sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/distribution/DefaultDistributor.java [UTF-8] (original)
+++ sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/distribution/DefaultDistributor.java [UTF-8] Mon Jul 8 14:03:32 2013
@@ -133,6 +133,8 @@ public class DefaultDistributor extends
/**
* Party from whom the resource may be obtained. This list need not be exhaustive.
+ *
+ * @return Party from whom the resource may be obtained, or {@code null}.
*/
@Override
@XmlElement(name = "distributorContact", required = true)
@@ -153,6 +155,8 @@ public class DefaultDistributor extends
/**
* Provides information about how the resource may be obtained,
* and related instructions and fee information.
+ *
+ * @return Information about how the resource may be obtained.
*/
@Override
@XmlElement(name = "distributionOrderProcess")
@@ -172,6 +176,8 @@ public class DefaultDistributor extends
/**
* Provides information about the format used by the distributor.
+ *
+ * @return Information about the format used by the distributor.
*/
@Override
@XmlElement(name = "distributorFormat")
@@ -190,6 +196,8 @@ public class DefaultDistributor extends
/**
* Provides information about the technical means and media used by the distributor.
+ *
+ * @return Information about the technical means and media used by the distributor.
*/
@Override
@XmlElement(name = "distributorTransferOptions")
Modified: sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/distribution/DefaultFormat.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/distribution/DefaultFormat.java?rev=1500741&r1=1500740&r2=1500741&view=diff
==============================================================================
--- sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/distribution/DefaultFormat.java [UTF-8] (original)
+++ sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/distribution/DefaultFormat.java [UTF-8] Mon Jul 8 14:03:32 2013
@@ -149,6 +149,8 @@ public class DefaultFormat extends ISOMe
/**
* Returns the name of the data transfer format(s).
+ *
+ * @return Name of the data transfer format(s), or {@code null}.
*/
@Override
@XmlElement(name = "name", required = true)
@@ -168,6 +170,8 @@ public class DefaultFormat extends ISOMe
/**
* Returns the version of the format (date, number, etc.).
+ *
+ * @return Version of the format, or {@code null}.
*/
@Override
@XmlElement(name = "version", required = true)
@@ -187,6 +191,8 @@ public class DefaultFormat extends ISOMe
/**
* Returns the amendment number of the format version.
+ *
+ * @return Amendment number of the format version, or {@code null}.
*/
@Override
@XmlElement(name = "amendmentNumber")
@@ -206,6 +212,8 @@ public class DefaultFormat extends ISOMe
/**
* Returns the name of a subset, profile, or product specification of the format.
+ *
+ * @return Name of a subset, profile, or product specification of the format, or {@code null}.
*/
@Override
@XmlElement(name = "specification")
@@ -226,6 +234,9 @@ public class DefaultFormat extends ISOMe
/**
* Returns recommendations of algorithms or processes that can be applied to read or
* expand resources to which compression techniques have been applied.
+ *
+ * @return Processes that can be applied to read resources to which compression techniques have
+ * been applied, or {@code null}.
*/
@Override
@XmlElement(name = "fileDecompressionTechnique")
@@ -246,6 +257,8 @@ public class DefaultFormat extends ISOMe
/**
* Provides information about the distributor's format.
+ *
+ * @return Information about the distributor's format.
*/
@Override
@XmlElement(name = "formatDistributor")
Modified: sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/distribution/DefaultMedium.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/distribution/DefaultMedium.java?rev=1500741&r1=1500740&r2=1500741&view=diff
==============================================================================
--- sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/distribution/DefaultMedium.java [UTF-8] (original)
+++ sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/distribution/DefaultMedium.java [UTF-8] Mon Jul 8 14:03:32 2013
@@ -139,6 +139,8 @@ public class DefaultMedium extends ISOMe
/**
* Returns the name of the medium on which the resource can be received.
+ *
+ * @return Name of the medium, or {@code null}.
*/
@Override
@XmlElement(name = "name")
@@ -159,6 +161,8 @@ public class DefaultMedium extends ISOMe
/**
* Returns the density at which the data is recorded.
* The numbers shall be greater than zero.
+ *
+ * @return Density at which the data is recorded, or {@code null}.
*/
@Override
@XmlElement(name = "density")
@@ -179,6 +183,8 @@ public class DefaultMedium extends ISOMe
/**
* Returns the units of measure for the recording density.
+ *
+ * @return Units of measure for the recording density, or {@code null}.
*/
@Override
@XmlElement(name = "densityUnits")
@@ -198,6 +204,8 @@ public class DefaultMedium extends ISOMe
/**
* Returns the number of items in the media identified.
+ *
+ * @return Number of items in the media identified, or {@code null}.
*/
@Override
@ValueRange(minimum=0)
@@ -218,6 +226,8 @@ public class DefaultMedium extends ISOMe
/**
* Returns the method used to write to the medium.
+ *
+ * @return Method used to write to the medium, or {@code null}.
*/
@Override
@XmlElement(name = "mediumFormat")
@@ -236,6 +246,8 @@ public class DefaultMedium extends ISOMe
/**
* Returns a description of other limitations or requirements for using the medium.
+ *
+ * @return Description of other limitations for using the medium, or {@code null}.
*/
@Override
@XmlElement(name = "mediumNote")
Modified: sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/distribution/DefaultStandardOrderProcess.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/distribution/DefaultStandardOrderProcess.java?rev=1500741&r1=1500740&r2=1500741&view=diff
==============================================================================
--- sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/distribution/DefaultStandardOrderProcess.java [UTF-8] (original)
+++ sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/distribution/DefaultStandardOrderProcess.java [UTF-8] Mon Jul 8 14:03:32 2013
@@ -127,6 +127,8 @@ public class DefaultStandardOrderProcess
/**
* Returns fees and terms for retrieving the resource.
* Include monetary units (as specified in ISO 4217).
+ *
+ * @return Fees and terms for retrieving the resource, or {@code null}.
*/
@Override
@XmlElement(name = "fees")
@@ -147,6 +149,8 @@ public class DefaultStandardOrderProcess
/**
* Returns the date and time when the dataset will be available.
+ *
+ * @return Date and time when the dataset will be available, or {@code null}.
*/
@Override
@XmlElement(name = "plannedAvailableDateTime")
@@ -166,6 +170,8 @@ public class DefaultStandardOrderProcess
/**
* Returns general instructions, terms and services provided by the distributor.
+ *
+ * @return General instructions, terms and services provided by the distributor, or {@code null}.
*/
@Override
@XmlElement(name = "orderingInstructions")
@@ -185,6 +191,8 @@ public class DefaultStandardOrderProcess
/**
* Returns typical turnaround time for the filling of an order.
+ *
+ * @return Typical turnaround time for the filling of an order, or {@code null}.
*/
@Override
@XmlElement(name = "turnaround")
Modified: sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/extent/DefaultBoundingPolygon.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/extent/DefaultBoundingPolygon.java?rev=1500741&r1=1500740&r2=1500741&view=diff
==============================================================================
--- sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/extent/DefaultBoundingPolygon.java [UTF-8] (original)
+++ sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/extent/DefaultBoundingPolygon.java [UTF-8] Mon Jul 8 14:03:32 2013
@@ -108,6 +108,8 @@ public class DefaultBoundingPolygon exte
/**
* Returns the sets of points defining the bounding polygon.
+ *
+ * @return The sets of points defining the bounding polygon.
*/
@Override
@XmlElement(name = "polygon", required = true)
Modified: sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/extent/DefaultExtent.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/extent/DefaultExtent.java?rev=1500741&r1=1500740&r2=1500741&view=diff
==============================================================================
--- sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/extent/DefaultExtent.java [UTF-8] (original)
+++ sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/extent/DefaultExtent.java [UTF-8] Mon Jul 8 14:03:32 2013
@@ -153,6 +153,8 @@ public class DefaultExtent extends ISOMe
/**
* Returns the spatial and temporal extent for the referring object.
+ *
+ * @return The spatial and temporal extent, or {@code null} in none.
*/
@Override
@XmlElement(name = "description")
@@ -172,6 +174,8 @@ public class DefaultExtent extends ISOMe
/**
* Provides geographic component of the extent of the referring object
+ *
+ * @return The geographic extent, or an empty set if none.
*/
@Override
@XmlElement(name = "geographicElement")
@@ -190,6 +194,8 @@ public class DefaultExtent extends ISOMe
/**
* Provides temporal component of the extent of the referring object.
+ *
+ * @return The temporal extent, or an empty set if none.
*/
@Override
@XmlElement(name = "temporalElement")
@@ -208,6 +214,8 @@ public class DefaultExtent extends ISOMe
/**
* Provides vertical component of the extent of the referring object.
+ *
+ * @return The vertical extent, or an empty set if none.
*/
@Override
@XmlElement(name = "verticalElement")
Modified: sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/extent/DefaultGeographicDescription.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/extent/DefaultGeographicDescription.java?rev=1500741&r1=1500740&r2=1500741&view=diff
==============================================================================
--- sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/extent/DefaultGeographicDescription.java [UTF-8] (original)
+++ sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/extent/DefaultGeographicDescription.java [UTF-8] Mon Jul 8 14:03:32 2013
@@ -113,6 +113,8 @@ public class DefaultGeographicDescriptio
/**
* Returns the identifier used to represent a geographic area.
+ *
+ * @return The identifier used to represent a geographic area, or {@code null}.
*/
@Override
@XmlElement(name = "geographicIdentifier", required = true)
Modified: sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/extent/DefaultTemporalExtent.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/extent/DefaultTemporalExtent.java?rev=1500741&r1=1500740&r2=1500741&view=diff
==============================================================================
--- sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/extent/DefaultTemporalExtent.java [UTF-8] (original)
+++ sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/extent/DefaultTemporalExtent.java [UTF-8] Mon Jul 8 14:03:32 2013
@@ -125,7 +125,7 @@ public class DefaultTemporalExtent exten
* then this method will build an extent from the {@linkplain #getStartTime() start
* time} and {@linkplain #getEndTime() end time} if any.
*
- * @return The content date.
+ * @return The date and time for the content, or {@code null}.
*/
@Override
@XmlElement(name = "extent", required = true)
Modified: sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/extent/DefaultVerticalExtent.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/extent/DefaultVerticalExtent.java?rev=1500741&r1=1500740&r2=1500741&view=diff
==============================================================================
--- sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/extent/DefaultVerticalExtent.java [UTF-8] (original)
+++ sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/extent/DefaultVerticalExtent.java [UTF-8] Mon Jul 8 14:03:32 2013
@@ -138,6 +138,8 @@ public class DefaultVerticalExtent exten
/**
* Returns the lowest vertical extent contained in the dataset.
+ *
+ * @return The lowest vertical extent, or {@code null}.
*/
@Override
@XmlElement(name = "minimumValue", required = true)
@@ -157,6 +159,8 @@ public class DefaultVerticalExtent exten
/**
* Returns the highest vertical extent contained in the dataset.
+ *
+ * @return The highest vertical extent, or {@code null}.
*/
@Override
@XmlElement(name = "maximumValue", required = true)
@@ -176,8 +180,10 @@ public class DefaultVerticalExtent exten
/**
* Provides information about the vertical coordinate reference system to
- * which the maximum and minimum elevation values are measured. The CRS
- * identification includes unit of measure.
+ * which the maximum and minimum elevation values are measured.
+ * The CRS identification includes unit of measure.
+ *
+ * @return The vertical CRS, or {@code null}.
*/
@Override
@XmlElement(name = "verticalCRS", required = true)
Modified: sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/identification/AbstractIdentification.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/identification/AbstractIdentification.java?rev=1500741&r1=1500740&r2=1500741&view=diff
==============================================================================
--- sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/identification/AbstractIdentification.java [UTF-8] (original)
+++ sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/identification/AbstractIdentification.java [UTF-8] Mon Jul 8 14:03:32 2013
@@ -216,6 +216,8 @@ public class AbstractIdentification exte
/**
* Returns the citation data for the resource(s).
+ *
+ * @return Citation data for the resource(s), or {@code null}.
*/
@Override
@XmlElement(name = "citation", required = true)
@@ -235,6 +237,8 @@ public class AbstractIdentification exte
/**
* Returns a brief narrative summary of the content of the resource(s).
+ *
+ * @return Brief narrative summary of the content, or {@code null}.
*/
@Override
@XmlElement(name = "abstract", required = true)
@@ -254,6 +258,8 @@ public class AbstractIdentification exte
/**
* Returns a summary of the intentions with which the resource(s) was developed.
+ *
+ * @return The intentions with which the resource(s) was developed, or {@code null}.
*/
@Override
@XmlElement(name = "purpose")
@@ -273,6 +279,8 @@ public class AbstractIdentification exte
/**
* Returns the recognition of those who contributed to the resource(s).
+ *
+ * @return Recognition of those who contributed to the resource(s).
*/
@Override
@XmlElement(name = "credit")
@@ -291,6 +299,8 @@ public class AbstractIdentification exte
/**
* Returns the status of the resource(s).
+ *
+ * @return Status of the resource(s), or {@code null}.
*/
@Override
@XmlElement(name = "status")
@@ -310,6 +320,8 @@ public class AbstractIdentification exte
/**
* Returns the identification of, and means of communication with, person(s) and organizations(s)
* associated with the resource(s).
+ *
+ * @return Means of communication with person(s) and organizations(s) associated with the resource(s).
*/
@Override
@XmlElement(name = "pointOfContact")
@@ -328,6 +340,8 @@ public class AbstractIdentification exte
/**
* Provides information about the frequency of resource updates, and the scope of those updates.
+ *
+ * @return Frequency and scope of resource updates.
*/
@Override
@XmlElement(name = "resourceMaintenance")
@@ -346,6 +360,8 @@ public class AbstractIdentification exte
/**
* Provides a graphic that illustrates the resource(s) (should include a legend for the graphic).
+ *
+ * @return A graphic that illustrates the resource(s).
*/
@Override
@XmlElement(name = "graphicOverview")
@@ -364,6 +380,8 @@ public class AbstractIdentification exte
/**
* Provides a description of the format of the resource(s).
+ *
+ * @return Description of the format.
*/
@Override
@XmlElement(name = "resourceFormat")
@@ -382,6 +400,8 @@ public class AbstractIdentification exte
/**
* Provides category keywords, their type, and reference source.
+ *
+ * @return Category keywords, their type, and reference source.
*/
@Override
@XmlElement(name = "descriptiveKeywords")
@@ -401,6 +421,9 @@ public class AbstractIdentification exte
/**
* Provides basic information about specific application(s) for which the resource(s)
* has/have been or is being used by different users.
+ *
+ * @return Information about specific application(s) for which the resource(s)
+ * has/have been or is being used.
*/
@Override
@XmlElement(name = "resourceSpecificUsage")
@@ -419,6 +442,8 @@ public class AbstractIdentification exte
/**
* Provides information about constraints which apply to the resource(s).
+ *
+ * @return Constraints which apply to the resource(s).
*/
@Override
@XmlElement(name = "resourceConstraints")
@@ -437,6 +462,8 @@ public class AbstractIdentification exte
/**
* Provides aggregate dataset information.
+ *
+ * @return Aggregate dataset information.
*/
@Override
@XmlElement(name = "aggregationInfo")
Modified: sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/identification/DefaultBrowseGraphic.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/identification/DefaultBrowseGraphic.java?rev=1500741&r1=1500740&r2=1500741&view=diff
==============================================================================
--- sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/identification/DefaultBrowseGraphic.java [UTF-8] (original)
+++ sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/identification/DefaultBrowseGraphic.java [UTF-8] Mon Jul 8 14:03:32 2013
@@ -123,6 +123,8 @@ public class DefaultBrowseGraphic extend
/**
* Returns the name of the file that contains a graphic that provides an illustration of the dataset.
+ *
+ * @return File that contains a graphic that provides an illustration of the dataset, or {@code null}.
*/
@Override
@XmlElement(name = "fileName", required = true)
@@ -142,6 +144,8 @@ public class DefaultBrowseGraphic extend
/**
* Returns the text description of the illustration.
+ *
+ * @return Text description of the illustration, or {@code null}.
*/
@Override
@XmlElement(name = "fileDescription")
@@ -162,6 +166,8 @@ public class DefaultBrowseGraphic extend
/**
* Format in which the illustration is encoded.
* Examples: CGM, EPS, GIF, JPEG, PBM, PS, TIFF, XWD.
+ *
+ * @return Format in which the illustration is encoded, or {@code null}.
*/
@Override
@XmlElement(name = "fileType")
Modified: sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/identification/DefaultDataIdentification.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/identification/DefaultDataIdentification.java?rev=1500741&r1=1500740&r2=1500741&view=diff
==============================================================================
--- sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/identification/DefaultDataIdentification.java [UTF-8] (original)
+++ sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/identification/DefaultDataIdentification.java [UTF-8] Mon Jul 8 14:03:32 2013
@@ -174,6 +174,8 @@ public class DefaultDataIdentification e
/**
* Returns the method used to spatially represent geographic information.
+ *
+ * @return Method(s) used to spatially represent geographic information.
*/
@Override
@XmlElement(name = "spatialRepresentationType")
@@ -191,8 +193,9 @@ public class DefaultDataIdentification e
}
/**
- * Returns the factor which provides a general understanding of the density of spatial data
- * in the dataset.
+ * Returns the factor which provides a general understanding of the density of spatial data in the dataset.
+ *
+ * @return Factor which provides a general understanding of the density of spatial data.
*/
@Override
@XmlElement(name = "spatialResolution")
@@ -201,8 +204,7 @@ public class DefaultDataIdentification e
}
/**
- * Sets the factor which provides a general understanding of the density of spatial data
- * in the dataset.
+ * Sets the factor which provides a general understanding of the density of spatial data in the dataset.
*
* @param newValues The new spatial resolutions.
*/
@@ -212,6 +214,8 @@ public class DefaultDataIdentification e
/**
* Returns the language(s) used within the dataset.
+ *
+ * @return Language(s) used.
*/
@Override
@XmlElement(name = "language", required = true)
@@ -230,6 +234,8 @@ public class DefaultDataIdentification e
/**
* Returns the full name of the character coding standard used for the dataset.
+ *
+ * @return Name(s) of the character coding standard(s) used.
*/
@Override
@XmlElement(name = "characterSet")
@@ -248,6 +254,8 @@ public class DefaultDataIdentification e
/**
* Returns the main theme(s) of the dataset.
+ *
+ * @return Main theme(s).
*/
@Override
@XmlElement(name = "topicCategory")
@@ -267,6 +275,8 @@ public class DefaultDataIdentification e
/**
* Returns a description of the dataset in the producer's processing environment. This includes
* items such as the software, the computer operating system, file name, and the dataset size.
+ *
+ * @return Description of the dataset in the producer's processing environment, or {@code null}.
*/
@Override
@XmlElement(name = "environmentDescription")
@@ -287,6 +297,8 @@ public class DefaultDataIdentification e
/**
* Returns additional extent information including the bounding polygon, vertical, and temporal
* extent of the dataset.
+ *
+ * @return Additional extent information.
*/
@Override
@XmlElement(name = "extent")
@@ -305,6 +317,8 @@ public class DefaultDataIdentification e
/**
* Any other descriptive information about the dataset.
+ *
+ * @return Other descriptive information, or {@code null}.
*/
@Override
@XmlElement(name = "supplementalInformation")
Modified: sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/identification/DefaultKeywords.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/identification/DefaultKeywords.java?rev=1500741&r1=1500740&r2=1500741&view=diff
==============================================================================
--- sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/identification/DefaultKeywords.java [UTF-8] (original)
+++ sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/identification/DefaultKeywords.java [UTF-8] Mon Jul 8 14:03:32 2013
@@ -136,6 +136,8 @@ public class DefaultKeywords extends ISO
/**
* Returns commonly used word(s) or formalised word(s) or phrase(s) used to describe the subject.
+ *
+ * @return Word(s) or phrase(s) used to describe the subject.
*/
@Override
@XmlElement(name = "keyword", required = true)
@@ -154,6 +156,8 @@ public class DefaultKeywords extends ISO
/**
* Returns the subject matter used to group similar keywords.
+ *
+ * @return Subject matter used to group similar keywords, or {@code null}.
*/
@Override
@XmlElement(name = "type")
@@ -172,8 +176,9 @@ public class DefaultKeywords extends ISO
}
/**
- * Returns the name of the formally registered thesaurus
- * or a similar authoritative source of keywords.
+ * Returns the name of the formally registered thesaurus or a similar authoritative source of keywords.
+ *
+ * @return Name of registered thesaurus or similar authoritative source of keywords, or {@code null}.
*/
@Override
@XmlElement(name = "thesaurusName")
@@ -182,8 +187,7 @@ public class DefaultKeywords extends ISO
}
/**
- * Sets the name of the formally registered thesaurus or a similar authoritative source
- * of keywords.
+ * Sets the name of the formally registered thesaurus or a similar authoritative source of keywords.
*
* @param newValue The new thesaurus name.
*/
Modified: sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/identification/DefaultRepresentativeFraction.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/identification/DefaultRepresentativeFraction.java?rev=1500741&r1=1500740&r2=1500741&view=diff
==============================================================================
--- sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/identification/DefaultRepresentativeFraction.java [UTF-8] (original)
+++ sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/identification/DefaultRepresentativeFraction.java [UTF-8] Mon Jul 8 14:03:32 2013
@@ -105,6 +105,8 @@ public class DefaultRepresentativeFracti
/**
* Returns the denominator of this representative fraction.
+ *
+ * @return The denominator.
*/
@Override
@XmlJavaTypeAdapter(value = GO_Integer.AsLong.class, type = long.class)
Modified: sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/identification/DefaultResolution.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/identification/DefaultResolution.java?rev=1500741&r1=1500740&r2=1500741&view=diff
==============================================================================
--- sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/identification/DefaultResolution.java [UTF-8] (original)
+++ sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/identification/DefaultResolution.java [UTF-8] Mon Jul 8 14:03:32 2013
@@ -134,7 +134,9 @@ public class DefaultResolution extends I
/**
* Returns the level of detail expressed as the scale of a comparable hardcopy map or chart.
* Only one of {@linkplain #getEquivalentScale() equivalent scale} and
- * {@linkplain #getDistance() ground sample distance} may be provided.
+ * {@linkplain #getDistance() ground sample distance} shall be provided.
+ *
+ * @return Level of detail expressed as the scale of a comparable hardcopy, or {@code null}.
*/
@Override
@XmlElement(name = "equivalentScale")
@@ -165,7 +167,9 @@ public class DefaultResolution extends I
/**
* Returns the ground sample distance.
* Only one of {@linkplain #getEquivalentScale equivalent scale} and
- * {@linkplain #getDistance ground sample distance} may be provided.
+ * {@linkplain #getDistance ground sample distance} shall be provided.
+ *
+ * @return The ground sample distance, or {@code null}.
*/
@Override
@ValueRange(minimum=0, isMinIncluded=false)
Modified: sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/identification/DefaultUsage.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/identification/DefaultUsage.java?rev=1500741&r1=1500740&r2=1500741&view=diff
==============================================================================
--- sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/identification/DefaultUsage.java [UTF-8] (original)
+++ sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/identification/DefaultUsage.java [UTF-8] Mon Jul 8 14:03:32 2013
@@ -143,6 +143,8 @@ public class DefaultUsage extends ISOMet
/**
* Returns a brief description of the resource and/or resource series usage.
+ *
+ * @return Description of the resource usage, or {@code null}.
*/
@Override
@XmlElement(name = "specificUsage", required = true)
@@ -163,6 +165,8 @@ public class DefaultUsage extends ISOMet
/**
* Returns the date and time of the first use or range of uses
* of the resource and/or resource series.
+ *
+ * @return Date of the first use of the resource, or {@code null}.
*/
@Override
@XmlElement(name = "usageDateTime")
@@ -183,6 +187,8 @@ public class DefaultUsage extends ISOMet
/**
* Returns applications, determined by the user for which the resource and/or resource series
* is not suitable.
+ *
+ * @return Applications for which the resource and/or resource series is not suitable, or {@code null}.
*/
@Override
@XmlElement(name = "userDeterminedLimitations")
@@ -204,6 +210,8 @@ public class DefaultUsage extends ISOMet
/**
* Returns identification of and means of communicating with person(s) and organization(s)
* using the resource(s).
+ *
+ * @return Means of communicating with person(s) and organization(s) using the resource(s).
*/
@Override
@XmlElement(name = "userContactInfo", required = true)
Modified: sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/lineage/DefaultAlgorithm.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/lineage/DefaultAlgorithm.java?rev=1500741&r1=1500740&r2=1500741&view=diff
==============================================================================
--- sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/lineage/DefaultAlgorithm.java [UTF-8] (original)
+++ sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/lineage/DefaultAlgorithm.java [UTF-8] Mon Jul 8 14:03:32 2013
@@ -107,6 +107,8 @@ public class DefaultAlgorithm extends IS
/**
* Returns the information identifying the algorithm and version or date.
+ *
+ * @return Algorithm and version or date, or {@code null}.
*/
@Override
@XmlElement(name = "citation", namespace = Namespaces.GMI, required = true)
@@ -126,6 +128,8 @@ public class DefaultAlgorithm extends IS
/**
* Returns the information describing the algorithm used to generate the data.
+ *
+ * @return Algorithm used to generate the data, or {@code null}.
*/
@Override
@XmlElement(name = "description", namespace = Namespaces.GMI, required = true)
Modified: sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/lineage/DefaultLineage.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/lineage/DefaultLineage.java?rev=1500741&r1=1500740&r2=1500741&view=diff
==============================================================================
--- sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/lineage/DefaultLineage.java [UTF-8] (original)
+++ sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/lineage/DefaultLineage.java [UTF-8] Mon Jul 8 14:03:32 2013
@@ -125,6 +125,8 @@ public class DefaultLineage extends ISOM
* Returns the general explanation of the data producer's knowledge about the lineage of a dataset.
* Can be provided only if {@linkplain DefaultScope#getLevel scope level}
* is {@link ScopeCode#DATASET DATASET} or {@link ScopeCode#SERIES SERIES}.
+ *
+ * @return Explanation of the data producer's knowledge about the lineage, or {@code null}.
*/
@Override
@XmlElement(name = "statement")
@@ -144,6 +146,8 @@ public class DefaultLineage extends ISOM
/**
* Returns the information about an event in the creation process for the data specified by the scope.
+ *
+ * @return Information about an event in the creation process.
*/
@Override
@XmlElement(name = "processStep")
@@ -162,6 +166,8 @@ public class DefaultLineage extends ISOM
/**
* Returns information about the source data used in creating the data specified by the scope.
+ *
+ * @return Information about the source data.
*/
@Override
@XmlElement(name = "source")
Modified: sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/lineage/DefaultNominalResolution.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/lineage/DefaultNominalResolution.java?rev=1500741&r1=1500740&r2=1500741&view=diff
==============================================================================
--- sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/lineage/DefaultNominalResolution.java [UTF-8] (original)
+++ sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/lineage/DefaultNominalResolution.java [UTF-8] Mon Jul 8 14:03:32 2013
@@ -108,6 +108,8 @@ public class DefaultNominalResolution ex
/**
* Returns the distance between consistent parts of (centre, left side, right side)
* adjacent pixels in the scan plane.
+ *
+ * @return Distance between consistent parts of adjacent pixels in the scan plane, or {@code null}.
*/
@Override
@ValueRange(minimum=0, isMinIncluded=false)
@@ -130,6 +132,8 @@ public class DefaultNominalResolution ex
/**
* Returns the distance between consistent parts of (centre, left side, right side) adjacent
* pixels in the object space.
+ *
+ * @return Distance between consistent parts of adjacent pixels in the object space, or {@code null}.
*/
@Override
@ValueRange(minimum=0, isMinIncluded=false)
Modified: sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/lineage/DefaultProcessStep.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/lineage/DefaultProcessStep.java?rev=1500741&r1=1500740&r2=1500741&view=diff
==============================================================================
--- sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/lineage/DefaultProcessStep.java [UTF-8] (original)
+++ sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/lineage/DefaultProcessStep.java [UTF-8] Mon Jul 8 14:03:32 2013
@@ -172,8 +172,10 @@ public class DefaultProcessStep extends
return new DefaultProcessStep(object);
}
- /**
+ /**
* Returns the description of the event, including related parameters or tolerances.
+ *
+ * @return Description of the event, or {@code null}.
*/
@Override
@XmlElement(name = "description", required = true)
@@ -193,6 +195,8 @@ public class DefaultProcessStep extends
/**
* Returns the requirement or purpose for the process step.
+ *
+ * @return Requirement or purpose for the process step, or {@code null}.
*/
@Override
@XmlElement(name = "rationale")
@@ -211,8 +215,9 @@ public class DefaultProcessStep extends
}
/**
- * Returns the date and time or range of date and time on or over which
- * the process step occurred.
+ * Returns the date and time or range of date and time on or over which the process step occurred.
+ *
+ * @return Date on or over which the process step occurred, or {@code null}.
*/
@Override
@XmlElement(name = "dateTime")
@@ -221,8 +226,7 @@ public class DefaultProcessStep extends
}
/**
- * Sets the date and time or range of date and time on or over which the process
- * step occurred.
+ * Sets the date and time or range of date and time on or over which the process step occurred.
*
* @param newValue The new date.
*/
@@ -234,6 +238,8 @@ public class DefaultProcessStep extends
/**
* Returns the identification of, and means of communication with, person(s) and
* organization(s) associated with the process step.
+ *
+ * @return Means of communication with person(s) and organization(s) associated with the process step.
*/
@Override
@XmlElement(name = "processor")
@@ -252,8 +258,9 @@ public class DefaultProcessStep extends
}
/**
- * Returns the information about the source data used in creating the data specified
- * by the scope.
+ * Returns the information about the source data used in creating the data specified by the scope.
+ *
+ * @return Information about the source data used in creating the data.
*/
@Override
@XmlElement(name = "source")
@@ -272,6 +279,8 @@ public class DefaultProcessStep extends
/**
* Returns the description of the product generated as a result of the process step.
+ *
+ * @return Product generated as a result of the process step.
*/
@Override
@XmlElement(name = "output", namespace = Namespaces.GMI)
@@ -291,7 +300,9 @@ public class DefaultProcessStep extends
/**
* Returns the comprehensive information about the procedure by which the algorithm
* was applied to derive geographic data from the raw instrument measurements, such
- * as datasets, software used, and the processing environment. {@code null} if unspecified.
+ * as datasets, software used, and the processing environment.
+ *
+ * @return Procedure by which the algorithm was applied to derive geographic data, or {@code null}.
*/
@Override
@XmlElement(name = "processingInformation", namespace = Namespaces.GMI)
@@ -313,6 +324,8 @@ public class DefaultProcessStep extends
/**
* Returns the report generated by the process step.
+ *
+ * @return Report generated by the process step.
*/
@Override
@XmlElement(name = "report", namespace = Namespaces.GMI)
Modified: sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/lineage/DefaultProcessStepReport.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/lineage/DefaultProcessStepReport.java?rev=1500741&r1=1500740&r2=1500741&view=diff
==============================================================================
--- sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/lineage/DefaultProcessStepReport.java [UTF-8] (original)
+++ sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/lineage/DefaultProcessStepReport.java [UTF-8] Mon Jul 8 14:03:32 2013
@@ -113,6 +113,8 @@ public class DefaultProcessStepReport ex
/**
* Returns the name of the processing report.
+ *
+ * @return Name of the processing report, or {@code null}.
*/
@Override
@XmlElement(name = "name", namespace = Namespaces.GMI, required = true)
@@ -132,7 +134,8 @@ public class DefaultProcessStepReport ex
/**
* Returns the textual description of what occurred during the process step.
- * Returns {@code null} if unspecified.
+ *
+ * @return What occurred during the process step, or {@code null}.
*/
@Override
@XmlElement(name = "description", namespace = Namespaces.GMI)
@@ -151,7 +154,9 @@ public class DefaultProcessStepReport ex
}
/**
- * Returns the type of file that contains the processing report. {@code null} if unspecified.
+ * Returns the type of file that contains the processing report.
+ *
+ * @return Type of file that contains the processing report, or {@code null}.
*/
@Override
@XmlElement(name = "fileType", namespace = Namespaces.GMI)
Modified: sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/lineage/DefaultProcessing.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/lineage/DefaultProcessing.java?rev=1500741&r1=1500740&r2=1500741&view=diff
==============================================================================
--- sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/lineage/DefaultProcessing.java [UTF-8] (original)
+++ sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/lineage/DefaultProcessing.java [UTF-8] Mon Jul 8 14:03:32 2013
@@ -136,6 +136,8 @@ public class DefaultProcessing extends I
/**
* Returns the information to identify the processing package that produced the data.
+ *
+ * @return Identifier of the processing package that produced the data, or {@code null}.
*/
@Override
@XmlElement(name = "identifier", namespace = Namespaces.GMI, required = true)
@@ -156,6 +158,8 @@ public class DefaultProcessing extends I
/**
* Returns the reference to document describing processing software.
+ *
+ * @return Document describing processing software.
*/
@Override
@XmlElement(name = "softwareReference", namespace = Namespaces.GMI)
@@ -174,6 +178,8 @@ public class DefaultProcessing extends I
/**
* Returns the additional details about the processing procedures. {@code null} if unspecified.
+ *
+ * @return Processing procedures, or {@code null}.
*/
@Override
@XmlElement(name = "procedureDescription", namespace = Namespaces.GMI)
@@ -193,6 +199,8 @@ public class DefaultProcessing extends I
/**
* Returns the reference to documentation describing the processing.
+ *
+ * @return Documentation describing the processing.
*/
@Override
@XmlElement(name = "documentation", namespace = Namespaces.GMI)
@@ -211,7 +219,8 @@ public class DefaultProcessing extends I
/**
* Returns the parameters to control the processing operations, entered at run time.
- * {@code null} if unspecified.
+ *
+ * @return Parameters to control the processing operations, or {@code null}.
*/
@Override
@XmlElement(name = "runTimeParameters", namespace = Namespaces.GMI)
@@ -232,6 +241,8 @@ public class DefaultProcessing extends I
/**
* Returns the details of the methodology by which geographic information was derived from the
* instrument readings.
+ *
+ * @return Methodology by which geographic information was derived from the instrument readings.
*/
@Override
@XmlElement(name = "algorithm", namespace = Namespaces.GMI)
Modified: sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/lineage/DefaultSource.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/lineage/DefaultSource.java?rev=1500741&r1=1500740&r2=1500741&view=diff
==============================================================================
--- sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/lineage/DefaultSource.java [UTF-8] (original)
+++ sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/lineage/DefaultSource.java [UTF-8] Mon Jul 8 14:03:32 2013
@@ -172,6 +172,8 @@ public class DefaultSource extends ISOMe
/**
* Returns a detailed description of the level of the source data.
+ *
+ * @return Description of the level of the source data, or {@code null}.
*/
@Override
@XmlElement(name = "description")
@@ -191,6 +193,8 @@ public class DefaultSource extends ISOMe
/**
* Returns the denominator of the representative fraction on a source map.
+ *
+ * @return Representative fraction on a source map, or {@code null}.
*/
@Override
@XmlElement(name = "scaleDenominator")
@@ -211,7 +215,9 @@ public class DefaultSource extends ISOMe
/**
* Returns the spatial reference system used by the source data.
*
- * @todo needs to annotate the referencing module before.
+ * @return Spatial reference system used by the source data, or {@code null}.
+ *
+ * @todo We need to annotate the referencing module before we can annotate this method.
*/
@Override
public ReferenceSystem getSourceReferenceSystem() {
@@ -230,6 +236,8 @@ public class DefaultSource extends ISOMe
/**
* Returns the recommended reference to be used for the source data.
+ *
+ * @return Recommended reference to be used for the source data, or {@code null}.
*/
@Override
@XmlElement(name = "sourceCitation")
@@ -249,6 +257,8 @@ public class DefaultSource extends ISOMe
/**
* Returns the information about the spatial, vertical and temporal extent of the source data.
+ *
+ * @return Information about the extent of the source data.
*/
@Override
@XmlElement(name = "sourceExtent")
@@ -267,6 +277,8 @@ public class DefaultSource extends ISOMe
/**
* Returns information about an event in the creation process for the source data.
+ *
+ * @return Information about an event in the creation process.
*/
@Override
@XmlElement(name = "sourceStep")
@@ -285,6 +297,8 @@ public class DefaultSource extends ISOMe
/**
* Returns the processing level of the source data. {@code null} if unspecified.
+ *
+ * @return Processing level of the source data, or {@code null}.
*/
@Override
@XmlElement(name = "processedLevel", namespace = Namespaces.GMI)
@@ -303,8 +317,9 @@ public class DefaultSource extends ISOMe
}
/**
- * Returns the distance between consistent parts (centre, left side, right side) of
- * two adjacent pixels. {@code null} if unspecified.
+ * Returns the distance between consistent parts (centre, left side, right side) of two adjacent pixels.
+ *
+ * @return Distance between consistent parts of two adjacent pixels, or {@code null}.
*/
@Override
@XmlElement(name = "resolution", namespace = Namespaces.GMI)
@@ -313,8 +328,7 @@ public class DefaultSource extends ISOMe
}
/**
- * Sets the distance between consistent parts (centre, left side, right side) of
- * two adjacent pixels.
+ * Sets the distance between consistent parts (centre, left side, right side) of two adjacent pixels.
*
* @param newValue The new nominal resolution value.
*/
Modified: sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/maintenance/DefaultMaintenanceInformation.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/maintenance/DefaultMaintenanceInformation.java?rev=1500741&r1=1500740&r2=1500741&view=diff
==============================================================================
--- sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/maintenance/DefaultMaintenanceInformation.java [UTF-8] (original)
+++ sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/maintenance/DefaultMaintenanceInformation.java [UTF-8] Mon Jul 8 14:03:32 2013
@@ -166,6 +166,8 @@ public class DefaultMaintenanceInformati
/**
* Returns the frequency with which changes and additions are made to the resource
* after the initial resource is completed.
+ *
+ * @return Frequency with which changes and additions are made to the resource, or {@code null}.
*/
@Override
@XmlElement(name = "maintenanceAndUpdateFrequency", required = true)
@@ -186,6 +188,8 @@ public class DefaultMaintenanceInformati
/**
* Returns the scheduled revision date for resource.
+ *
+ * @return Scheduled revision date, or {@code null}.
*/
@Override
@XmlElement(name = "dateOfNextUpdate")
@@ -205,6 +209,8 @@ public class DefaultMaintenanceInformati
/**
* Returns the maintenance period other than those defined.
+ *
+ * @return The Maintenance period, or {@code null}.
*/
@Override
@XmlElement(name = "userDefinedMaintenanceFrequency")
@@ -224,6 +230,8 @@ public class DefaultMaintenanceInformati
/**
* Returns the scope of data to which maintenance is applied.
+ *
+ * @return Scope of data to which maintenance is applied.
*/
@Override
@XmlElement(name = "updateScope")
@@ -242,6 +250,8 @@ public class DefaultMaintenanceInformati
/**
* Returns additional information about the range or extent of the resource.
+ *
+ * @return Additional information about the range or extent of the resource.
*/
@Override
@XmlElement(name = "updateScopeDescription")
@@ -260,6 +270,8 @@ public class DefaultMaintenanceInformati
/**
* Returns information regarding specific requirements for maintaining the resource.
+ *
+ * @return Information regarding specific requirements for maintaining the resource.
*/
@Override
@XmlElement(name = "maintenanceNote")
@@ -279,6 +291,9 @@ public class DefaultMaintenanceInformati
/**
* Returns identification of, and means of communicating with,
* person(s) and organization(s) with responsibility for maintaining the metadata.
+ *
+ * @return Means of communicating with person(s) and organization(s) with responsibility
+ * for maintaining the metadata.
*/
@Override
@XmlElement(name = "contact")
Modified: sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/maintenance/DefaultScopeDescription.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/maintenance/DefaultScopeDescription.java?rev=1500741&r1=1500740&r2=1500741&view=diff
==============================================================================
--- sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/maintenance/DefaultScopeDescription.java [UTF-8] (original)
+++ sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/maintenance/DefaultScopeDescription.java [UTF-8] Mon Jul 8 14:03:32 2013
@@ -254,6 +254,8 @@ public class DefaultScopeDescription ext
/**
* Returns the attributes to which the information applies.
*
+ * @return Attributes to which the information applies.
+ *
* {@section Conditions}
* This method returns a modifiable collection only if no other property is set.
* Otherwise, this method returns an unmodifiable empty collection.
@@ -279,6 +281,8 @@ public class DefaultScopeDescription ext
/**
* Returns the features to which the information applies.
*
+ * @return Features to which the information applies.
+ *
* {@section Conditions}
* This method returns a modifiable collection only if no other property is set.
* Otherwise, this method returns an unmodifiable empty collection.
@@ -304,6 +308,8 @@ public class DefaultScopeDescription ext
/**
* Returns the feature instances to which the information applies.
*
+ * @return Feature instances to which the information applies.
+ *
* {@section Conditions}
* This method returns a modifiable collection only if no other property is set.
* Otherwise, this method returns an unmodifiable empty collection.
@@ -329,6 +335,8 @@ public class DefaultScopeDescription ext
/**
* Returns the attribute instances to which the information applies.
*
+ * @return Attribute instances to which the information applies.
+ *
* {@section Conditions}
* This method returns a modifiable collection only if no other property is set.
* Otherwise, this method returns an unmodifiable empty collection.
@@ -353,6 +361,8 @@ public class DefaultScopeDescription ext
/**
* Returns the dataset to which the information applies.
+ *
+ * @return Dataset to which the information applies, or {@code null}.
*/
@Override
@XmlElement(name = "dataset")
@@ -379,8 +389,9 @@ public class DefaultScopeDescription ext
}
/**
- * Returns the class of information that does not fall into the other categories to
- * which the information applies.
+ * Returns the class of information that does not fall into the other categories to which the information applies.
+ *
+ * @return Class of information that does not fall into the other categories, or {@code null}.
*/
@Override
@XmlElement(name = "other")
Modified: sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/quality/AbstractElement.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/quality/AbstractElement.java?rev=1500741&r1=1500740&r2=1500741&view=diff
==============================================================================
--- sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/quality/AbstractElement.java [UTF-8] (original)
+++ sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/quality/AbstractElement.java [UTF-8] Mon Jul 8 14:03:32 2013
@@ -375,6 +375,8 @@ public class AbstractElement extends ISO
/**
* Returns the name of the test applied to the data.
+ *
+ * @return Name of the test applied to the data.
*/
@Override
@XmlElement(name = "nameOfMeasure")
@@ -393,6 +395,8 @@ public class AbstractElement extends ISO
/**
* Returns the code identifying a registered standard procedure, or {@code null} if none.
+ *
+ * @return Code identifying a registered standard procedure, or {@code null}.
*/
@Override
@XmlElement(name = "measureIdentification")
@@ -412,6 +416,8 @@ public class AbstractElement extends ISO
/**
* Returns the description of the measure being determined.
+ *
+ * @return Description of the measure being determined, or {@code null}.
*/
@Override
@XmlElement(name = "measureDescription")
@@ -430,8 +436,9 @@ public class AbstractElement extends ISO
}
/**
- * Returns the type of method used to evaluate quality of the dataset,
- * or {@code null} if unspecified.
+ * Returns the type of method used to evaluate quality of the dataset.
+ *
+ * @return Type of method used to evaluate quality, or {@code null}.
*/
@Override
@XmlElement(name = "evaluationMethodType")
@@ -451,6 +458,8 @@ public class AbstractElement extends ISO
/**
* Returns the description of the evaluation method.
+ *
+ * @return Description of the evaluation method, or {@code null}.
*/
@Override
@XmlElement(name = "evaluationMethodDescription")
@@ -470,6 +479,8 @@ public class AbstractElement extends ISO
/**
* Returns the reference to the procedure information, or {@code null} if none.
+ *
+ * @return Reference to the procedure information, or {@code null}.
*/
@Override
@XmlElement(name = "evaluationProcedure")
@@ -491,6 +502,8 @@ public class AbstractElement extends ISO
* Returns the date or range of dates on which a data quality measure was applied.
* The collection size is 1 for a single date, or 2 for a range.
* Returns an empty collection if this information is not available.
+ *
+ * @return Date or range of dates on which a data quality measure was applied.
*/
@Override
@XmlElement(name = "dateTime")
@@ -536,6 +549,8 @@ public class AbstractElement extends ISO
* Returns the value (or set of values) obtained from applying a data quality measure or
* the out come of evaluating the obtained value (or set of values) against a specified
* acceptable conformance quality level.
+ *
+ * @return Set of values obtained from applying a data quality measure.
*/
@Override
@XmlElement(name = "result", required = true)
Modified: sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/quality/DefaultConformanceResult.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/quality/DefaultConformanceResult.java?rev=1500741&r1=1500740&r2=1500741&view=diff
==============================================================================
--- sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/quality/DefaultConformanceResult.java [UTF-8] (original)
+++ sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/quality/DefaultConformanceResult.java [UTF-8] Mon Jul 8 14:03:32 2013
@@ -133,8 +133,9 @@ public class DefaultConformanceResult ex
}
/**
- * Returns the citation of product specification or user
- * requirement against which data is being evaluated.
+ * Returns the citation of product specification or user requirement against which data is being evaluated.
+ *
+ * @return Citation of product specification or user requirement, or {@code null}.
*/
@Override
@XmlElement(name = "specification", required = true)
@@ -143,8 +144,7 @@ public class DefaultConformanceResult ex
}
/**
- * Sets the citation of product specification or user requirement against which data
- * is being evaluated.
+ * Sets the citation of product specification or user requirement against which data is being evaluated.
*
* @param newValue The new specification.
*/
@@ -155,6 +155,8 @@ public class DefaultConformanceResult ex
/**
* Returns the explanation of the meaning of conformance for this result.
+ *
+ * @return Explanation of the meaning of conformance, or {@code null}.
*/
@Override
@XmlElement(name = "explanation", required = true)
@@ -174,6 +176,8 @@ public class DefaultConformanceResult ex
/**
* Returns an indication of the conformance result.
+ *
+ * @return Indication of the conformance result, or {@code null}.
*/
@Override
public Boolean pass() {
Modified: sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/quality/DefaultCoverageResult.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/quality/DefaultCoverageResult.java?rev=1500741&r1=1500740&r2=1500741&view=diff
==============================================================================
--- sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/quality/DefaultCoverageResult.java [UTF-8] (original)
+++ sis/branches/JDK7/core/sis-metadata/src/main/java/org/apache/sis/metadata/iso/quality/DefaultCoverageResult.java [UTF-8] Mon Jul 8 14:03:32 2013
@@ -130,6 +130,8 @@ public class DefaultCoverageResult exten
/**
* Returns the method used to spatially represent the coverage result.
+ *
+ * @return Spatial representation of the coverage result, or {@code null}.
*/
@Override
@XmlElement(name = "spatialRepresentationType", namespace = Namespaces.GMI, required = true)
@@ -149,6 +151,8 @@ public class DefaultCoverageResult exten
/**
* Returns the digital representation of data quality measures composing the coverage result.
+ *
+ * @return Digital representation of data quality measures composing the coverage result, or {@code null}.
*/
@Override
@XmlElement(name = "resultSpatialRepresentation", namespace = Namespaces.GMI, required = true)
@@ -169,6 +173,8 @@ public class DefaultCoverageResult exten
/**
* Returns the description of the content of the result coverage, i.e. semantic definition
* of the data quality measures.
+ *
+ * @return Description of the content of the result coverage, or {@code null}.
*/
@Override
@XmlElement(name = "resultContentDescription", namespace = Namespaces.GMI, required = true)
@@ -189,6 +195,8 @@ public class DefaultCoverageResult exten
/**
* Returns the information about the format of the result coverage data.
+ *
+ * @return Format of the result coverage data, or {@code null}.
*/
@Override
@XmlElement(name = "resultFormat", namespace = Namespaces.GMI, required = true)
@@ -208,6 +216,8 @@ public class DefaultCoverageResult exten
/**
* Returns the information about the data file containing the result coverage data.
+ *
+ * @return Data file containing the result coverage data, or {@code null}.
*/
@Override
@XmlElement(name = "resultFile", namespace = Namespaces.GMX, required = true)