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