001    /*
002     *    GeoAPI - Java interfaces for OGC/ISO standards
003     *    http://www.geoapi.org
004     *
005     *    Copyright (C) 2004-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.content;
033    
034    import java.util.Collection;
035    import java.util.Locale;
036    import org.opengis.util.GenericName;
037    import org.opengis.metadata.citation.Citation;
038    import org.opengis.annotation.UML;
039    
040    import static org.opengis.annotation.Obligation.*;
041    import static org.opengis.annotation.Specification.*;
042    
043    
044    /**
045     * Information identifying the feature catalogue.
046     *
047     * @author  Martin Desruisseaux (IRD)
048     * @version 3.0
049     * @since   2.0
050     *
051     * @navassoc - - - GenericName
052     * @navassoc - - - Citation
053     */
054    @UML(identifier="MD_FeatureCatalogueDescription", specification=ISO_19115)
055    public interface FeatureCatalogueDescription extends ContentInformation {
056        /**
057         * Indication of whether or not the cited feature catalogue complies with ISO 19110.
058         * This value is optional, and therefore may be null.
059         *
060         * @return Whether or not the cited feature catalogue complies with ISO 19110, or {@code null}.
061         */
062        @UML(identifier="complianceCode", obligation=OPTIONAL, specification=ISO_19115)
063        Boolean isCompliant();
064    
065        /**
066         * Language(s) used within the catalogue.
067         *
068         * @return Language(s) used within the catalogue.
069         */
070        @UML(identifier="language", obligation=OPTIONAL, specification=ISO_19115)
071        Collection<Locale> getLanguages();
072    
073        /**
074         * Indication of whether or not the feature catalogue is included with the dataset.
075         *
076         * @return whether or not the feature catalogue is included with the dataset.
077         */
078        @UML(identifier="includedWithDataset", obligation=MANDATORY, specification=ISO_19115)
079        boolean isIncludedWithDataset();
080    
081        /**
082         * Subset of feature types from cited feature catalogue occurring in dataset.
083         *
084         * @return Subset of feature types occurring in dataset.
085         */
086        @UML(identifier="featureTypes", obligation=OPTIONAL, specification=ISO_19115)
087        Collection<? extends GenericName> getFeatureTypes();
088    
089        /**
090         * Complete bibliographic reference to one or more external feature catalogues.
091         *
092         * @return Bibliographic reference to one or more external feature catalogues.
093         */
094        @UML(identifier="featureCatalogueCitation", obligation=MANDATORY, specification=ISO_19115)
095        Collection<? extends Citation> getFeatureCatalogueCitations();
096    }