001    /*
002     *    GeoAPI - Java interfaces for OGC/ISO standards
003     *    http://www.geoapi.org
004     *
005     *    Copyright (C) 2007-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.metadata.identification;
033    
034    import org.opengis.metadata.Identifier;
035    import org.opengis.metadata.citation.Citation;
036    import org.opengis.annotation.UML;
037    
038    import static org.opengis.annotation.Obligation.*;
039    import static org.opengis.annotation.Specification.ISO_19115;
040    
041    
042    /**
043     * Aggregate dataset information.
044     *
045     * @author  Ely Conn (Leica Geosystems Geospatial Imaging, LLC)
046     * @version 3.0
047     * @since   2.1
048     *
049     * @navassoc 1 - - Citation
050     * @navassoc 1 - - Identifier
051     * @navassoc 1 - - AssociationType
052     * @navassoc 1 - - InitiativeType
053     */
054    @UML(identifier="MD_AggregateInformation", specification=ISO_19115)
055    public interface AggregateInformation {
056        /**
057         * Citation information about the aggregate dataset.
058         *
059         * @return Citation information about the aggregate dataset, or {@code null}.
060         *
061         * @condition {@linkplain #getAggregateDataSetIdentifier()} Aggregate data set identifier}
062         *            not documented.
063         */
064        @UML(identifier="aggregateDataSetName", obligation=CONDITIONAL, specification=ISO_19115)
065        Citation getAggregateDataSetName();
066    
067        /**
068         * Identification information about aggregate dataset.
069         *
070         * @return Identification information about aggregate dataset, or {@code null}.
071         *
072         * @condition {@linkplain #getAggregateDataSetName() Aggregate data set name} not documented.
073         */
074        @UML(identifier="aggregateDataSetIdentifier", obligation=CONDITIONAL, specification=ISO_19115)
075        Identifier getAggregateDataSetIdentifier();
076    
077        /**
078         * Association type of the aggregate dataset.
079         *
080         * @return Association type of the aggregate dataset.
081         */
082        @UML(identifier="associationType", obligation=MANDATORY, specification=ISO_19115)
083        AssociationType getAssociationType();
084    
085        /**
086         * Type of initiative under which the aggregate dataset was produced.
087         *
088         * @return Type of initiative under which the aggregate dataset was produced, or {@code null}.
089         */
090        @UML(identifier="initiativeType", obligation=OPTIONAL, specification=ISO_19115)
091        InitiativeType getInitiativeType();
092    }