Source Code Cross Referenced for NamedStyle.java in  » GIS » GeoTools-2.4.1 » org » geotools » styling » Java Source Code / Java DocumentationJava Source Code and Java Documentation

001:        /*
002:         *    GeoTools - OpenSource mapping toolkit
003:         *    http://geotools.org
004:         *    (C) 2003-2006, GeoTools Project Managment Committee (PMC)
005:         *
006:         *    This library is free software; you can redistribute it and/or
007:         *    modify it under the terms of the GNU Lesser General Public
008:         *    License as published by the Free Software Foundation;
009:         *    version 2.1 of the License.
010:         *
011:         *    This library is distributed in the hope that it will be useful,
012:         *    but WITHOUT ANY WARRANTY; without even the implied warranty of
013:         *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
014:         *    Lesser General Public License for more details.
015:         */
016:        package org.geotools.styling;
017:
018:        /**
019:         * A NamedStyle is used to refer to a style that has a name in a WMS.
020:         *
021:         * <p>
022:         * A NamedStyle is a Style that has only Name, so all setters other than
023:         * setName will throw an <code>UnsupportedOperationException</code>
024:         * </p>
025:         * The details of this object are taken from the <a
026:         * href="https://portal.opengeospatial.org/files/?artifact_id=1188"> OGC
027:         * Styled-Layer Descriptor Report (OGC 02-070) version 1.0.0.</a>:
028:         * <pre><code>
029:         * &lt;xsd:element name="NamedStyle"&gt;
030:         *   &lt;xsd:annotation&gt;
031:         *     &lt;xsd:documentation&gt;
032:         *       A NamedStyle is used to refer to a style that has a name in a WMS.
033:         *     &lt;/xsd:documentation&gt;
034:         *   &lt;/xsd:annotation&gt;
035:         *   &lt;xsd:complexType&gt;
036:         *     &lt;xsd:sequence&gt;
037:         *       &lt;xsd:element ref="sld:Name"/&gt;
038:         *     &lt;/xsd:sequence&gt;
039:         *   &lt;/xsd:complexType&gt;
040:         * &lt;/xsd:element&gt;
041:         * </code></pre>
042:         *
043:         * @author James Macgill
044:         * @source $URL: http://svn.geotools.org/geotools/tags/2.4.1/modules/library/api/src/main/java/org/geotools/styling/NamedStyle.java $
045:         */
046:        public interface NamedStyle extends Style {
047:            public String getName();
048:
049:            public void setName(String name);
050:
051:            /**
052:             * DOCUMENT ME!
053:             *
054:             * @return DOCUMENT ME!
055:             *
056:             * @deprecated Not supported
057:             */
058:            public String getTitle();
059:
060:            /**
061:             * DOCUMENT ME!
062:             *
063:             * @param title DOCUMENT ME!
064:             *
065:             * @deprecated Not supported
066:             */
067:            public void setTitle(String title);
068:
069:            /**
070:             * DOCUMENT ME!
071:             *
072:             * @return DOCUMENT ME!
073:             *
074:             * @deprecated Not supported
075:             */
076:            public String getAbstract();
077:
078:            /**
079:             * DOCUMENT ME!
080:             *
081:             * @param abstractStr DOCUMENT ME!
082:             *
083:             * @deprecated Not supported
084:             */
085:            public void setAbstract(String abstractStr);
086:
087:            /**
088:             * DOCUMENT ME!
089:             *
090:             * @return DOCUMENT ME!
091:             *
092:             * @deprecated Not supported
093:             */
094:            public boolean isDefault();
095:
096:            /**
097:             * DOCUMENT ME!
098:             *
099:             * @param isDefault DOCUMENT ME!
100:             *
101:             * @deprecated Not supported
102:             */
103:            public void setDefault(boolean isDefault);
104:
105:            /**
106:             * DOCUMENT ME!
107:             *
108:             * @return DOCUMENT ME!
109:             *
110:             * @deprecated Not supported
111:             */
112:            public FeatureTypeStyle[] getFeatureTypeStyles();
113:
114:            /**
115:             * DOCUMENT ME!
116:             *
117:             * @param types DOCUMENT ME!
118:             *
119:             * @deprecated Not supported
120:             */
121:            public void setFeatureTypeStyles(FeatureTypeStyle[] types);
122:
123:            /**
124:             * DOCUMENT ME!
125:             *
126:             * @param type DOCUMENT ME!
127:             *
128:             * @deprecated Not supported
129:             */
130:            public void addFeatureTypeStyle(FeatureTypeStyle type);
131:
132:            public void accept(StyleVisitor visitor);
133:        }