001    /*
002     *    GeoAPI - Java interfaces for OGC/ISO standards
003     *    http://www.geoapi.org
004     *
005     *    Copyright (C) 2004-2013 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 java.util.Collection;
035    import org.opengis.util.InternationalString;
036    import org.opengis.metadata.citation.Citation;
037    import org.opengis.annotation.UML;
038    
039    import static org.opengis.annotation.Obligation.*;
040    import static org.opengis.annotation.Specification.*;
041    
042    
043    /**
044     * Keywords, their type and reference source.
045     *
046     * @author  Martin Desruisseaux (IRD)
047     * @version 3.0
048     * @since   2.0
049     *
050     * @navassoc 1 - - KeywordType
051     * @navassoc 1 - - Citation
052     */
053    @UML(identifier="MD_Keywords", specification=ISO_19115)
054    public interface Keywords {
055        /**
056         * Commonly used word(s) or formalised word(s) or phrase(s) used to describe the subject.
057         *
058         * @return Word(s) or phrase(s) used to describe the subject.
059         */
060        @UML(identifier="keyword", obligation=MANDATORY, specification=ISO_19115)
061        Collection<? extends InternationalString> getKeywords();
062    
063        /**
064         * Subject matter used to group similar keywords.
065         *
066         * @return Subject matter used to group similar keywords, or {@code null}.
067         */
068        @UML(identifier="type", obligation=OPTIONAL, specification=ISO_19115)
069        KeywordType getType();
070    
071        /**
072         * Name of the formally registered thesaurus or a similar authoritative source of keywords.
073         *
074         * @return Name of registered thesaurus or similar authoritative source of keywords, or {@code null}.
075         */
076        @UML(identifier="thesaurusName", obligation=OPTIONAL, specification=ISO_19115)
077        Citation getThesaurusName();
078    }