org.deegree_impl.graphics.sld
Class UserStyle_Impl

java.lang.Object
  extended byorg.deegree_impl.graphics.sld.Style_Impl
      extended byorg.deegree_impl.graphics.sld.UserStyle_Impl
All Implemented Interfaces:
Marshallable, Style, UserStyle

public class UserStyle_Impl
extends Style_Impl
implements UserStyle, Marshallable

A user-defined allows map styling to be defined externally from a system and to be passed around in an interoperable format.

A UserStyle is at the same semantic level as a NamedStyle used in the context of a WMS. In a sense, a named style can be thought of as a reference to a hidden UserStyle that is stored inside of a map server.

----------------------------------------------------------------------

Version:
$Revision: 1.7 $ $Date: 2004/02/19 10:08:56 $
Author:
Katharina Lupp

Field Summary
private  java.lang.String abstract_
           
private  boolean default_
           
private  java.util.ArrayList featureTypeStyles
           
protected  java.lang.String name
           
private  java.lang.String title
           
 
Constructor Summary
(package private) UserStyle_Impl(java.lang.String name, java.lang.String title, java.lang.String abstract_, boolean default_, FeatureTypeStyle[] featureTypeStyles)
          constructor initializing the class with the
 
Method Summary
 void addFeatureTypeStyle(FeatureTypeStyle featureTypeStyle)
          Adds a
 java.lang.String exportAsXML()
          exports the content of the UserStyle as XML formated String
 java.lang.String getAbstract()
          the Abstract is a more exact description that may be a few paragraphs long.
 FeatureTypeStyle[] getFeatureTypeStyles()
          A UserStyle can contain one or more FeatureTypeStyles which allow the rendering of features of specific types.
 java.lang.String getName()
          The given Name is equivalent to the name of a WMS named style and is used to reference the style externally when an SLD is used in library mode and identifies the named style to redefine when an SLD is inserted into a WMS.
 java.lang.String getTitle()
          The Title is a human-readable short description for the style that might be displayed in a GUI pick list.
 boolean isDefault()
          The IsDefault element identifies whether a style is the default style of a layer, for use in SLD library mode when rendering or for storing inside of a map server.
 void removeFeatureTypeStyle(FeatureTypeStyle featureTypeStyle)
          Removes a
 void setAbstract(java.lang.String abstract_)
          sets the
 void setDefault(boolean default_)
          sets the
 void setFeatureTypeStyles(FeatureTypeStyle[] featureTypeStyles)
          sets the
 void setName(java.lang.String name)
          Sets the name attribute's value of the Style.
 void setTitle(java.lang.String title)
          sets the </TD> </TR> </TABLE>  <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> <TD><B>Methods inherited from class java.lang.Object</B></TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD> </TR> </TABLE>  <A NAME="methods_inherited_from_class_org.deegree.graphics.sld.Style"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> <TD><B>Methods inherited from interface org.deegree.graphics.sld.<A HREF="../../../../org/deegree/graphics/sld/Style.html" title="interface in org.deegree.graphics.sld">Style</A></B></TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> <TD><CODE><A HREF="../../../../org/deegree/graphics/sld/Style.html#getName()">getName</A>, <A HREF="../../../../org/deegree/graphics/sld/Style.html#setName(java.lang.String)">setName</A></CODE></TD> </TR> </TABLE>   <P> <!-- ============ FIELD DETAIL =========== --> <A NAME="field_detail"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> <TD COLSPAN=1><FONT SIZE="+2"> <B>Field Detail</B></FONT></TD> </TR> </TABLE> <A NAME="featureTypeStyles"><!-- --></A><H3> featureTypeStyles</H3> <PRE> private java.util.ArrayList <B>featureTypeStyles</B></PRE> <DL> <DL> </DL> </DL> <HR> <A NAME="abstract_"><!-- --></A><H3> abstract_</H3> <PRE> private java.lang.String <B>abstract_</B></PRE> <DL> <DL> </DL> </DL> <HR> <A NAME="title"><!-- --></A><H3> title</H3> <PRE> private java.lang.String <B>title</B></PRE> <DL> <DL> </DL> </DL> <HR> <A NAME="default_"><!-- --></A><H3> default_</H3> <PRE> private boolean <B>default_</B></PRE> <DL> <DL> </DL> </DL> <HR> <A NAME="name"><!-- --></A><H3> name</H3> <PRE> protected java.lang.String <B>name</B></PRE> <DL> <DL> </DL> </DL> <!-- ========= CONSTRUCTOR DETAIL ======== --> <A NAME="constructor_detail"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> <TD COLSPAN=1><FONT SIZE="+2"> <B>Constructor Detail</B></FONT></TD> </TR> </TABLE> <A NAME="UserStyle_Impl(java.lang.String, java.lang.String, java.lang.String, boolean, org.deegree.graphics.sld.FeatureTypeStyle[])"><!-- --></A><H3> UserStyle_Impl</H3> <PRE> <B>UserStyle_Impl</B>(java.lang.String name, java.lang.String title, java.lang.String abstract_, boolean default_, <A HREF="../../../../org/deegree/graphics/sld/FeatureTypeStyle.html" title="interface in org.deegree.graphics.sld">FeatureTypeStyle</A>[] featureTypeStyles)</PRE> <DL> <DD>constructor initializing the class with the <UserStyle> <P> </DL> <!-- ============ METHOD DETAIL ========== --> <A NAME="method_detail"><!-- --></A> <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> <TD COLSPAN=1><FONT SIZE="+2"> <B>Method Detail</B></FONT></TD> </TR> </TABLE> <A NAME="getTitle()"><!-- --></A><H3> getTitle</H3> <PRE> public java.lang.String <B>getTitle</B>()</PRE> <DL> <DD>The Title is a human-readable short description for the style that might be displayed in a GUI pick list. <P> <DD><DL> <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/deegree/graphics/sld/UserStyle.html#getTitle()">getTitle</A></CODE> in interface <CODE><A HREF="../../../../org/deegree/graphics/sld/UserStyle.html" title="interface in org.deegree.graphics.sld">UserStyle</A></CODE></DL> </DD> <DD><DL> <DT><B>Returns:</B><DD>the title of the User-Style</DL> </DD> </DL> <HR> <A NAME="setTitle(java.lang.String)"><!-- --></A><H3> setTitle</H3> <PRE> public void <B>setTitle</B>(java.lang.String title)</PRE> <DL> <DD>sets the <Title> <P> <DD><DL> <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/deegree/graphics/sld/UserStyle.html#setTitle(java.lang.String)">setTitle</A></CODE> in interface <CODE><A HREF="../../../../org/deegree/graphics/sld/UserStyle.html" title="interface in org.deegree.graphics.sld">UserStyle</A></CODE></DL> </DD> <DD><DL> <DT><B>Parameters:</B><DD><CODE>title</CODE> - the title of the User-Style</DL> </DD> </DL> <HR> <A NAME="getAbstract()"><!-- --></A><H3> getAbstract</H3> <PRE> public java.lang.String <B>getAbstract</B>()</PRE> <DL> <DD>the Abstract is a more exact description that may be a few paragraphs long. <P> <DD><DL> <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/deegree/graphics/sld/UserStyle.html#getAbstract()">getAbstract</A></CODE> in interface <CODE><A HREF="../../../../org/deegree/graphics/sld/UserStyle.html" title="interface in org.deegree.graphics.sld">UserStyle</A></CODE></DL> </DD> <DD><DL> <DT><B>Returns:</B><DD>the abstract of the User-Style</DL> </DD> </DL> <HR> <A NAME="setAbstract(java.lang.String)"><!-- --></A><H3> setAbstract</H3> <PRE> public void <B>setAbstract</B>(java.lang.String abstract_)</PRE> <DL> <DD>sets the <Abstract> <P> <DD><DL> <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/deegree/graphics/sld/UserStyle.html#setAbstract(java.lang.String)">setAbstract</A></CODE> in interface <CODE><A HREF="../../../../org/deegree/graphics/sld/UserStyle.html" title="interface in org.deegree.graphics.sld">UserStyle</A></CODE></DL> </DD> <DD><DL> <DT><B>Parameters:</B><DD><CODE>abstract_</CODE> - the abstract of the User-Style</DL> </DD> </DL> <HR> <A NAME="isDefault()"><!-- --></A><H3> isDefault</H3> <PRE> public boolean <B>isDefault</B>()</PRE> <DL> <DD>The IsDefault element identifies whether a style is the default style of a layer, for use in SLD library mode when rendering or for storing inside of a map server. The default value is <tt>false</tt>. <P> <DD><DL> <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/deegree/graphics/sld/UserStyle.html#isDefault()">isDefault</A></CODE> in interface <CODE><A HREF="../../../../org/deegree/graphics/sld/UserStyle.html" title="interface in org.deegree.graphics.sld">UserStyle</A></CODE></DL> </DD> <DD><DL> <DT><B>Returns:</B><DD>true if the style ist the default style</DL> </DD> </DL> <HR> <A NAME="setDefault(boolean)"><!-- --></A><H3> setDefault</H3> <PRE> public void <B>setDefault</B>(boolean default_)</PRE> <DL> <DD>sets the <Default> <P> <DD><DL> <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/deegree/graphics/sld/UserStyle.html#setDefault(boolean)">setDefault</A></CODE> in interface <CODE><A HREF="../../../../org/deegree/graphics/sld/UserStyle.html" title="interface in org.deegree.graphics.sld">UserStyle</A></CODE></DL> </DD> <DD><DL> <DT><B>Parameters:</B><DD><CODE>default_</CODE> - </DL> </DD> </DL> <HR> <A NAME="getFeatureTypeStyles()"><!-- --></A><H3> getFeatureTypeStyles</H3> <PRE> public <A HREF="../../../../org/deegree/graphics/sld/FeatureTypeStyle.html" title="interface in org.deegree.graphics.sld">FeatureTypeStyle</A>[] <B>getFeatureTypeStyles</B>()</PRE> <DL> <DD>A UserStyle can contain one or more FeatureTypeStyles which allow the rendering of features of specific types. <p></p> The FeatureTypeStyle defines the styling that is to be applied to a single feature type of a layer.<p></p> The FeatureTypeStyle element identifies that explicit separation in SLD between the handling of layers and the handling of features of specific feature types. The layer concept is unique to WMS and SLD, but features are used more generally, such as in WFS and GML, so this explicit separation is important. <P> <DD><DL> <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/deegree/graphics/sld/UserStyle.html#getFeatureTypeStyles()">getFeatureTypeStyles</A></CODE> in interface <CODE><A HREF="../../../../org/deegree/graphics/sld/UserStyle.html" title="interface in org.deegree.graphics.sld">UserStyle</A></CODE></DL> </DD> <DD><DL> <DT><B>Returns:</B><DD>the FeatureTypeStyles of a User-Style</DL> </DD> </DL> <HR> <A NAME="setFeatureTypeStyles(org.deegree.graphics.sld.FeatureTypeStyle[])"><!-- --></A><H3> setFeatureTypeStyles</H3> <PRE> public void <B>setFeatureTypeStyles</B>(<A HREF="../../../../org/deegree/graphics/sld/FeatureTypeStyle.html" title="interface in org.deegree.graphics.sld">FeatureTypeStyle</A>[] featureTypeStyles)</PRE> <DL> <DD>sets the <FeatureTypeStyle> <P> <DD><DL> <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/deegree/graphics/sld/UserStyle.html#setFeatureTypeStyles(org.deegree.graphics.sld.FeatureTypeStyle[])">setFeatureTypeStyles</A></CODE> in interface <CODE><A HREF="../../../../org/deegree/graphics/sld/UserStyle.html" title="interface in org.deegree.graphics.sld">UserStyle</A></CODE></DL> </DD> <DD><DL> <DT><B>Parameters:</B><DD><CODE>featureTypeStyles</CODE> - the FeatureTypeStyles of a User-Style</DL> </DD> </DL> <HR> <A NAME="addFeatureTypeStyle(org.deegree.graphics.sld.FeatureTypeStyle)"><!-- --></A><H3> addFeatureTypeStyle</H3> <PRE> public void <B>addFeatureTypeStyle</B>(<A HREF="../../../../org/deegree/graphics/sld/FeatureTypeStyle.html" title="interface in org.deegree.graphics.sld">FeatureTypeStyle</A> featureTypeStyle)</PRE> <DL> <DD>Adds a <FeatureTypeStyle> <P> <DD><DL> <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/deegree/graphics/sld/UserStyle.html#addFeatureTypeStyle(org.deegree.graphics.sld.FeatureTypeStyle)">addFeatureTypeStyle</A></CODE> in interface <CODE><A HREF="../../../../org/deegree/graphics/sld/UserStyle.html" title="interface in org.deegree.graphics.sld">UserStyle</A></CODE></DL> </DD> <DD><DL> <DT><B>Parameters:</B><DD><CODE>featureTypeStyle</CODE> - a FeatureTypeStyle to add</DL> </DD> </DL> <HR> <A NAME="removeFeatureTypeStyle(org.deegree.graphics.sld.FeatureTypeStyle)"><!-- --></A><H3> removeFeatureTypeStyle</H3> <PRE> public void <B>removeFeatureTypeStyle</B>(<A HREF="../../../../org/deegree/graphics/sld/FeatureTypeStyle.html" title="interface in org.deegree.graphics.sld">FeatureTypeStyle</A> featureTypeStyle)</PRE> <DL> <DD>Removes a <FeatureTypeStyle> <P> <DD><DL> <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/deegree/graphics/sld/UserStyle.html#removeFeatureTypeStyle(org.deegree.graphics.sld.FeatureTypeStyle)">removeFeatureTypeStyle</A></CODE> in interface <CODE><A HREF="../../../../org/deegree/graphics/sld/UserStyle.html" title="interface in org.deegree.graphics.sld">UserStyle</A></CODE></DL> </DD> <DD><DL> <DT><B>Parameters:</B><DD><CODE>featureTypeStyle</CODE> - a FeatureTypeStyle to remove</DL> </DD> </DL> <HR> <A NAME="exportAsXML()"><!-- --></A><H3> exportAsXML</H3> <PRE> public java.lang.String <B>exportAsXML</B>()</PRE> <DL> <DD>exports the content of the UserStyle as XML formated String <P> <DD><DL> <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/deegree/xml/Marshallable.html#exportAsXML()">exportAsXML</A></CODE> in interface <CODE><A HREF="../../../../org/deegree/xml/Marshallable.html" title="interface in org.deegree.xml">Marshallable</A></CODE></DL> </DD> <DD><DL> <DT><B>Returns:</B><DD>xml representation of the UserStyle</DL> </DD> </DL> <HR> <A NAME="getName()"><!-- --></A><H3> getName</H3> <PRE> public java.lang.String <B>getName</B>()</PRE> <DL> <DD>The given Name is equivalent to the name of a WMS named style and is used to reference the style externally when an SLD is used in library mode and identifies the named style to redefine when an SLD is inserted into a WMS. <P> <DD><DL> <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/deegree/graphics/sld/Style.html#getName()">getName</A></CODE> in interface <CODE><A HREF="../../../../org/deegree/graphics/sld/Style.html" title="interface in org.deegree.graphics.sld">Style</A></CODE></DL> </DD> <DD><DL> <DT><B>Returns:</B><DD>the name</DL> </DD> </DL> <HR> <A NAME="setName(java.lang.String)"><!-- --></A><H3> setName</H3> <PRE> public void <B>setName</B>(java.lang.String name)</PRE> <DL> <DD>Sets the name attribute's value of the Style. <P> <DD><DL> <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/deegree/graphics/sld/Style.html#setName(java.lang.String)">setName</A></CODE> in interface <CODE><A HREF="../../../../org/deegree/graphics/sld/Style.html" title="interface in org.deegree.graphics.sld">Style</A></CODE></DL> </DD> <DD><DL> <DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the style <p></DL> </DD> </DL> <!-- ========= END OF CLASS DATA ========= --> <HR> <!-- ======= START OF BOTTOM NAVBAR ====== --> <A NAME="navbar_bottom"><!-- --></A> <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> <TR> <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A NAME="navbar_bottom_firstrow"><!-- --></A> <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> <TR ALIGN="center" VALIGN="top"> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev">  <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/UserStyle_Impl.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> </TR> </TABLE> </TD> <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> </EM> </TD> </TR> <TR> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">  <A HREF="../../../../org/deegree_impl/graphics/sld/UserLayer_Impl.html" title="class in org.deegree_impl.graphics.sld"><B>PREV CLASS</B></A>   NEXT CLASS</FONT></TD> <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../../index.html" target="_top"><B>FRAMES</B></A>    <A HREF="UserStyle_Impl.html" target="_top"><B>NO FRAMES</B></A>    <SCRIPT type="text/javascript"> <!-- if(window==top) { document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); } //--> </SCRIPT> <NOSCRIPT> <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> </NOSCRIPT> </FONT></TD> </TR> <TR> <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> </TR> </TABLE> <A NAME="skip-navbar_bottom"></A> <!-- ======== END OF BOTTOM NAVBAR ======= --> <HR> </BODY> </HTML>