001    /*
002     *    GeoAPI - Java interfaces for OGC/ISO standards
003     *    http://www.geoapi.org
004     *
005     *    Copyright (C) 2009-2012 Open Geospatial Consortium, Inc.
006     *    All Rights Reserved. http://www.opengeospatial.org/ogc/legal
007     *
008     *    Permission to use, copy, and modify this software and its documentation, with
009     *    or without modification, for any purpose and without fee or royalty is hereby
010     *    granted, provided that you include the following on ALL copies of the software
011     *    and documentation or portions thereof, including modifications, that you make:
012     *
013     *    1. The full text of this NOTICE in a location viewable to users of the
014     *       redistributed or derivative work.
015     *    2. Notice of any changes or modifications to the OGC files, including the
016     *       date changes were made.
017     *
018     *    THIS SOFTWARE AND DOCUMENTATION IS PROVIDED "AS IS," AND COPYRIGHT HOLDERS MAKE
019     *    NO REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
020     *    TO, WARRANTIES OF MERCHANTABILITY OR FITNESS FOR ANY PARTICULAR PURPOSE OR THAT
021     *    THE USE OF THE SOFTWARE OR DOCUMENTATION WILL NOT INFRINGE ANY THIRD PARTY
022     *    PATENTS, COPYRIGHTS, TRADEMARKS OR OTHER RIGHTS.
023     *
024     *    COPYRIGHT HOLDERS WILL NOT BE LIABLE FOR ANY DIRECT, INDIRECT, SPECIAL OR
025     *    CONSEQUENTIAL DAMAGES ARISING OUT OF ANY USE OF THE SOFTWARE OR DOCUMENTATION.
026     *
027     *    The name and trademarks of copyright holders may NOT be used in advertising or
028     *    publicity pertaining to the software without specific, written prior permission.
029     *    Title to copyright in this software and any associated documentation will at all
030     *    times remain with copyright holders.
031     */
032    package org.opengis.observation.sampling;
033    
034    import org.opengis.observation.Measure;
035    import org.opengis.observation.ProcessModel;
036    import org.opengis.temporal.TemporalGeometricPrimitive;
037    import org.opengis.util.GenericName;
038    import org.opengis.annotation.UML;
039    
040    import static org.opengis.annotation.Specification.*;
041    import static org.opengis.annotation.Obligation.*;
042    
043    /**
044     * A located object on which measurements may be made.
045     *
046     * A basic material classification is provided using the "material" property.
047     * Its value may be relatively generic (rock, pulp) or may reflect a detailed classification (calcrete, adamellite, biotite-schist).
048     * In the latter case it is wise to use the codeSpace attribute to provide a link to the classification scheme/vocabulary used.
049     *
050     * Note that if this specimen is a "processed" version of another (e.g. by grinding, sieving, etc) then
051     * the predecessor (if known) may be recorded as a relatedSamplingFeature.
052     *
053     * @version <A HREF="http://www.opengeospatial.org/standards/om">Implementation specification 1.0</A>
054     * @author Open Geospatial Consortium
055     * @author Guilhem Legal (Geomatys)
056     * @since GeoAPI 2.3
057     */
058    @UML(identifier="Specimen", specification=OGC_07022)
059    public interface Specimen extends SamplingFeature {
060    
061        /**
062         * Material type, usually taken from a controlled vocabulary.
063         * Specialised domains may choose to fix the vocabulary to be used.
064         */
065        @UML(identifier="materialClass", obligation=MANDATORY, specification=OGC_07022)
066        GenericName getMaterialClass();
067    
068        /**
069         * Storage location of specimen if it still exists.
070         * If destroyed in analysis, then either omit or use xlink:href to point to a suitable URN, e.g. urn:cgi:def:nil:destroyed.
071         */
072        @UML(identifier="currentLocation", obligation=OPTIONAL, specification=OGC_07022)
073        Location getCurrentLocation();
074    
075        /**
076         * Method used when retrieving specimen from host sampledFeature
077         */
078        @UML(identifier="samplingMethod", obligation=OPTIONAL, specification=OGC_07022)
079        ProcessModel getSamplingMethod();
080    
081        /**
082         * Time and date when the specimen was initially retrieved
083         */
084        @UML(identifier="samplingTime", obligation=MANDATORY, specification=OGC_07022)
085        TemporalGeometricPrimitive getSamplingTime();
086    
087        /**
088         * The size of the specimen: mass, length, volume, etc.
089         */
090        @UML(identifier="size", obligation=OPTIONAL, specification=OGC_07022)
091        Measure getSize();
092        
093    }