001 /*
002 * GeoAPI - Java interfaces for OGC/ISO standards
003 * http://www.geoapi.org
004 *
005 * Copyright (C) 2008-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.style;
033
034 import java.util.List;
035 import org.opengis.annotation.UML;
036
037 import org.opengis.annotation.XmlElement;
038 import static org.opengis.annotation.Obligation.*;
039 import static org.opengis.annotation.Specification.*;
040
041 /**
042 * <p>A UserStyle is at the same semantic level as a NamedStyle used in the context of a
043 * WMS. In a sense, a named style can be thought of as a reference to a hidden UserStyle
044 * that is stored inside of a map server.</p>
045 *
046 *
047 * <p>A portrayal catalog consits of a set of feature portrayal objects. Many may
048 * exist for each feature type that may occur in the dataset. each feature object
049 * has assigned a set of portrayal rules.</p>
050 *
051 * This class is a merged between ISO 19117 Portrayal and OGC SLD 1.1.0
052 *
053 * @version <A HREF="http://www.opengeospatial.org/standards/sld">Implementation specification 1.1.0</A>
054 *
055 * @author Open Geospatial Consortium
056 * @author Johann Sorel (Geomatys)
057 * @since GeoAPI 2.2
058 */
059 @UML(identifier="PF_PortrayalCatalog", specification=ISO_19117)
060 @XmlElement("UserStyle")
061 public interface Style {
062
063 /**
064 * Style name (machine readable, don't show to users)
065 *
066 * @return String, identification name of this style
067 */
068 @XmlElement("UserStyle")
069 String getName();
070
071 /**
072 * Returns the description of this style.
073 *
074 * @return Description with usual informations used
075 * for user interfaces.
076 */
077 @XmlElement("Description")
078 Description getDescription();
079
080 /**
081 * The IsDefault element identifies whether a style is the default style of a layer, for use in
082 * SLD ‘library mode’ when rendering or for storing inside of a map server. IsDefault uses
083 * “1” or “true” for true and “0” or “false” for false. The default value is “0”.
084 */
085 @XmlElement("IsDefault")
086 boolean isDefault();
087
088 /**
089 * Returns a collection of feature type style.
090 *
091 */
092 @UML(identifier="featurePortrayal", obligation=MANDATORY, specification=ISO_19117)
093 @XmlElement("FeatureTypeStyle")
094 List<? extends FeatureTypeStyle> featureTypeStyles();
095
096 /**
097 * Returns the default specification used if no rule return true.
098 * This specification should not use any external functions.
099 * This specification should use at least one spatial attribut.
100 *
101 * @return PortrayalSpecification
102 */
103 @UML(identifier="defaultPortrayalSpec", obligation=MANDATORY, specification=ISO_19117)
104 Symbolizer getDefaultSpecification();
105
106 /**
107 * calls the visit method of a StyleVisitor
108 *
109 * @param visitor the style visitor
110 */
111 Object accept(StyleVisitor visitor, Object extraData);
112
113 }