formulas.html

Geotools是一个开源的Java GIS工具包,可利用它来开发符合标准的地理信息系统。Geotools提供了OGC(Open Geospatial Consortium)规范的一个实现来作为他们的

<HR>

<A NAME="methods"><!-- --></A><H3>
methods</H3>
<PRE>
protected final <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/util/Map.html" title="class or interface in java.util">Map</A> <B>methods</B></PRE>
<DL>
<DD>Informations about exported methods.
<P>
<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="Formulas()"><!-- --></A><H3>
Formulas</H3>
<PRE>
protected <B>Formulas</B>()</PRE>
<DL>
<DD>Default constructor. Subclass constructors need to add entries in the <A HREF="../../../org/geotools/openoffice/Formulas.html#methods"><CODE>methods</CODE></A> map.
<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="setLocale(com.sun.star.lang.Locale)"><!-- --></A><H3>
setLocale</H3>
<PRE>
public void <B>setLocale</B>(Locale&nbsp;locale)</PRE>
<DL>
<DD>Sets the locale to be used by this object.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>setLocale</CODE> in interface <CODE>XLocalizable</CODE></DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="getLocale()"><!-- --></A><H3>
getLocale</H3>
<PRE>
public Locale <B>getLocale</B>()</PRE>
<DL>
<DD>Returns the locale, which is used by this object.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>getLocale</CODE> in interface <CODE>XLocalizable</CODE></DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="getJavaLocale()"><!-- --></A><H3>
getJavaLocale</H3>
<PRE>
protected final <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/util/Locale.html" title="class or interface in java.util">Locale</A> <B>getJavaLocale</B>()</PRE>
<DL>
<DD>Returns the locale as an object from the Java standard SDK.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="getServiceName()"><!-- --></A><H3>
getServiceName</H3>
<PRE>
public abstract <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>getServiceName</B>()</PRE>
<DL>
<DD>The service name that can be used to create such an object by a factory.
 This is defined as a field in the subclass with exactly the following signature:

 <blockquote><code>
 private static final String __serviceName;
 </code></blockquote>
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>getServiceName</CODE> in interface <CODE>XServiceName</CODE></DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="getImplementationName()"><!-- --></A><H3>
getImplementationName</H3>
<PRE>
public <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>getImplementationName</B>()</PRE>
<DL>
<DD>Provides the implementation name of the service implementation.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>getImplementationName</CODE> in interface <CODE>XServiceInfo</CODE></DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>Unique name of the implementation.</DL>
</DD>
</DL>
<HR>

<A NAME="getProgrammaticCategoryName(java.lang.String)"><!-- --></A><H3>
getProgrammaticCategoryName</H3>
<PRE>
public <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>getProgrammaticCategoryName</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;function)</PRE>
<DL>
<DD>Returns the programmatic name of the category the function belongs to. 
 The category name is used to group similar functions together. The programmatic
 category name should always be in English, it is never shown to the user. It
 is usually one of the names listed in  interface.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>getProgrammaticCategoryName</CODE> in interface <CODE>XAddIn</CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>function</CODE> - The exact name of a method within its interface.
<DT><B>Returns:</B><DD>The category name the specified function belongs to.</DL>
</DD>
</DL>
<HR>

<A NAME="getDisplayCategoryName(java.lang.String)"><!-- --></A><H3>
getDisplayCategoryName</H3>
<PRE>
public <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>getDisplayCategoryName</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;function)</PRE>
<DL>
<DD>Returns the user-visible name of the category the function belongs to. 
 This is used when category names are shown to the user.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>getDisplayCategoryName</CODE> in interface <CODE>XAddIn</CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>function</CODE> - The exact name of a method within its interface.
<DT><B>Returns:</B><DD>The user-visible category name the specified function belongs to.</DL>
</DD>
</DL>
<HR>

<A NAME="getProgrammaticFuntionName(java.lang.String)"><!-- --></A><H3>
getProgrammaticFuntionName</H3>
<PRE>
public <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>getProgrammaticFuntionName</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;display)</PRE>
<DL>
<DD>Returns the internal function name for an user-visible name. The user-visible
 name of a function is the name shown to the user. It may be translated to the
 <A HREF="../../../org/geotools/openoffice/Formulas.html#getLocale()">current language</A>, so it is never stored in files. It
 should be a single word and is used when entering or displaying formulas.
 <p>
 Attention: The method name contains a spelling error. Due to compatibility
 reasons the name cannot be changed.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>getProgrammaticFuntionName</CODE> in interface <CODE>XAddIn</CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>display</CODE> - The user-visible name of a function.
<DT><B>Returns:</B><DD>The exact name of the method within its interface.</DL>
</DD>
</DL>
<HR>

<A NAME="getDisplayFunctionName(java.lang.String)"><!-- --></A><H3>
getDisplayFunctionName</H3>
<PRE>
public <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>getDisplayFunctionName</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;function)</PRE>
<DL>
<DD>Returns the user-visible function name for an internal name. 
 The user-visible name of a function is the name shown to the user.
 It may be translated to the <A HREF="../../../org/geotools/openoffice/Formulas.html#getLocale()">current language</A>,
 so it is never stored in files. It should be a single word and is used
 when entering or displaying formulas.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>getDisplayFunctionName</CODE> in interface <CODE>XAddIn</CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>function</CODE> - The exact name of a method within its interface.
<DT><B>Returns:</B><DD>The user-visible name of the specified function.</DL>
</DD>
</DL>
<HR>

<A NAME="getFunctionDescription(java.lang.String)"><!-- --></A><H3>
getFunctionDescription</H3>
<PRE>
public <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>getFunctionDescription</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;function)</PRE>
<DL>
<DD>Returns the description of a function. The description is shown to the user
 when selecting functions. It may be translated to the <A HREF="../../../org/geotools/openoffice/Formulas.html#getLocale()">current language</A>.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>getFunctionDescription</CODE> in interface <CODE>XAddIn</CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>function</CODE> - The exact name of a method within its interface.
<DT><B>Returns:</B><DD>The description of the specified function.</DL>
</DD>
</DL>
<HR>

<A NAME="getDisplayArgumentName(java.lang.String, int)"><!-- --></A><H3>
getDisplayArgumentName</H3>
<PRE>
public <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>getDisplayArgumentName</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;function,
                                     int&nbsp;argument)</PRE>
<DL>
<DD>Returns the user-visible name of the specified argument. The argument name is
 shown to the user when prompting for arguments. It should be a single word and
 may be translated to the <A HREF="../../../org/geotools/openoffice/Formulas.html#getLocale()">current language</A>.
<P>
<DD><DL>