001    /*
002     *    GeoAPI - Java interfaces for OGC/ISO standards
003     *    http://www.geoapi.org
004     *
005     *    Copyright (C) 2008-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.style;
033    
034    import org.opengis.annotation.Extension;
035    import org.opengis.annotation.XmlElement;
036    import org.opengis.util.InternationalString;
037    
038    /**
039     * A Description is used to store various informations
040     * who describe an element. Description values are mostly used
041     * in User Interfaces (Lists, trees, ...).
042     *
043     * @version <A HREF="http://www.opengeospatial.org/standards/symbol">Symbology Encoding Implementation Specification 1.1.0</A>
044     * @author Open Geospatial Consortium
045     * @author Johann Sorel (Geomatys)
046     * @since GeoAPI 2.2
047     */
048    @XmlElement("Description")
049    public interface Description {
050    
051        /**
052         * Returns the human readable title of this style.
053         * This can be any string, but should be fairly short as it is intended to
054         * be used in list boxes or drop down menus or other selection interfaces.
055         * @return the human readable title of this style.
056         */
057        @XmlElement("Title")
058        InternationalString getTitle();
059    
060        /**
061         * Returns a human readable, prose description of this style.
062         * This can be any string and can consist of any amount of text.
063         * @return a human readable, prose description of this style.
064         */
065        @XmlElement("Abstract")
066        InternationalString getAbstract();
067    
068        /**
069         * calls the visit method of a StyleVisitor
070         *
071         * @param visitor the style visitor
072         */
073        @Extension
074        Object accept(StyleVisitor visitor, Object extraData);
075        
076    }
077