formulas.html

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

<DT><B>Specified by:</B><DD><CODE>getDisplayArgumentName</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.<DD><CODE>argument</CODE> - The index of the argument (0-based).
<DT><B>Returns:</B><DD>The user-visible name of the specified argument.</DL>
</DD>
</DL>
<HR>

<A NAME="getArgumentDescription(java.lang.String, int)"><!-- --></A><H3>
getArgumentDescription</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>getArgumentDescription</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 description of the specified argument. The argument description is
 shown to the user when prompting for arguments. 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>getArgumentDescription</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.<DD><CODE>argument</CODE> - The index of the argument (0-based).
<DT><B>Returns:</B><DD>The description of the specified argument.</DL>
</DD>
</DL>
<HR>

<A NAME="setTimeZone(java.lang.String)"><!-- --></A><H3>
setTimeZone</H3>
<PRE>
protected void <B>setTimeZone</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;timezone)</PRE>
<DL>
<DD>Sets the timezone for time values to be provided to <A HREF="../../../org/geotools/openoffice/Formulas.html#toDate(com.sun.star.beans.XPropertySet, double)"><CODE>toDate(com.sun.star.beans.XPropertySet, double)</CODE></A>.
 If this method is never invoked, then the default timezone is the locale one.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="getEpoch(com.sun.star.beans.XPropertySet)"><!-- --></A><H3>
getEpoch</H3>
<PRE>
protected <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/util/Date.html" title="class or interface in java.util">Date</A> <B>getEpoch</B>(XPropertySet&nbsp;xOptions)</PRE>
<DL>
<DD>Returns the spreadsheet epoch. The timezone is the one specified during the
 last invocation of <A HREF="../../../org/geotools/openoffice/Formulas.html#setTimeZone(java.lang.String)"><CODE>setTimeZone(java.lang.String)</CODE></A>. The epoch is used for date conversions
 as in <A HREF="../../../org/geotools/openoffice/Formulas.html#toDate(com.sun.star.beans.XPropertySet, double)"><CODE>toDate(com.sun.star.beans.XPropertySet, double)</CODE></A>.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>xOptions</CODE> - Provided by OpenOffice.
<DT><B>Returns:</B><DD>The spreedsheet epoch, always as a new Java Date object.</DL>
</DD>
</DL>
<HR>

<A NAME="toDate(com.sun.star.beans.XPropertySet, double)"><!-- --></A><H3>
toDate</H3>
<PRE>
protected <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/util/Date.html" title="class or interface in java.util">Date</A> <B>toDate</B>(XPropertySet&nbsp;xOptions,
                      double&nbsp;time)</PRE>
<DL>
<DD>Converts a date from a spreadsheet value to a Java <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/util/Date.html" title="class or interface in java.util"><CODE>Date</CODE></A> object.
 The timezone is the one specified during the last invocation of <A HREF="../../../org/geotools/openoffice/Formulas.html#setTimeZone(java.lang.String)"><CODE>setTimeZone(java.lang.String)</CODE></A>.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>xOptions</CODE> - Provided by OpenOffice.<DD><CODE>time</CODE> - The spreadsheet numerical value for a date, by default in the local timezone.
<DT><B>Returns:</B><DD>The date as a Java object.</DL>
</DD>
</DL>
<HR>

<A NAME="toDouble(com.sun.star.beans.XPropertySet, java.util.Date)"><!-- --></A><H3>
toDouble</H3>
<PRE>
protected double <B>toDouble</B>(XPropertySet&nbsp;xOptions,
                          <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/util/Date.html" title="class or interface in java.util">Date</A>&nbsp;time)</PRE>
<DL>
<DD>Converts a date from a Java <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/util/Date.html" title="class or interface in java.util"><CODE>Date</CODE></A> object to a spreadsheet value.
 The timezone is the one specified during the last invocation of <A HREF="../../../org/geotools/openoffice/Formulas.html#setTimeZone(java.lang.String)"><CODE>setTimeZone(java.lang.String)</CODE></A>.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="getLocalizedMessage(java.lang.Throwable)"><!-- --></A><H3>
getLocalizedMessage</H3>
<PRE>
protected static <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>getLocalizedMessage</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Throwable.html" title="class or interface in java.lang">Throwable</A>&nbsp;exception)</PRE>
<DL>
<DD>Returns the localized message from the specified exception. If no message is available,
 returns a default string. This method never returns a null value.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="getFailure(int, int)"><!-- --></A><H3>
getFailure</H3>
<PRE>
protected static double[][] <B>getFailure</B>(int&nbsp;rows,
                                       int&nbsp;cols)</PRE>
<DL>
<DD>Returns a table filled with <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Double.html#NaN" title="class or interface in java.lang"><CODE>NaN</CODE></A> values. This method is invoked when
 an operation failed for a whole table.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Since:</B></DT>
  <DD>2.3</DD>
</DL>
</DD>
</DL>
<HR>

<A NAME="reportException(java.lang.String, java.lang.Throwable)"><!-- --></A><H3>
reportException</H3>
<PRE>
protected void <B>reportException</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;method,
                               <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Throwable.html" title="class or interface in java.lang">Throwable</A>&nbsp;exception)</PRE>
<DL>
<DD>Reports an exception. This is used if an exception occured in a method which can't returns
 a <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang"><CODE>String</CODE></A> object. This method log the stack trace at the FINE level. We don't use
 the WARNING level since this is not a program disfunction; the failure is probably caused
 by wrong user-specified parameters.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="getLogger()"><!-- --></A><H3>
getLogger</H3>
<PRE>
protected <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/util/logging/Logger.html" title="class or interface in java.util.logging">Logger</A> <B>getLogger</B>()</PRE>
<DL>
<DD>Returns the logger to use for logging warnings. The default implementation returns the
 <A HREF="../../../org/geotools/openoffice/package-summary.html"><CODE>org.geotools.openoffice</CODE></A> logger. Subclasses should override this method if they
 want to use a different logger.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
</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>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/Formulas.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  </TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>

<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;PREV CLASS&nbsp;
&nbsp;<A HREF="../../../org/geotools/openoffice/MethodInfo.html" title="class in org.geotools.openoffice"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  <A HREF="../../../index.html" target="_top"><B>FRAMES</B></A>  &nbsp;
&nbsp;<A HREF="Formulas.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
&nbsp;<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:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->

<HR>
Copyright &copy; 1996-2007 <a href="http://www.geotools.org">Geotools</a>. All Rights Reserved.
</BODY>
</HTML>