Java Doc for Formulas.java in » GIS » GeoTools-2.4.1 » org » geotools » openoffice » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation

1.	6.0 JDK Core
2.	6.0 JDK Modules
3.	6.0 JDK Modules com.sun
4.	6.0 JDK Modules com.sun.java
5.	6.0 JDK Modules sun
6.	6.0 JDK Platform
7.	Ajax
8.	Apache Harmony Java SE
9.	Aspect oriented
10.	Authentication Authorization
11.	Blogger System
12.	Build
13.	Byte Code
14.	Cache
15.	Chart
16.	Chat
17.	Code Analyzer
18.	Collaboration
19.	Content Management System
20.	Database Client
21.	Database DBMS
22.	Database JDBC Connection Pool
23.	Database ORM
24.	Development
25.	EJB Server geronimo
26.	EJB Server GlassFish
27.	EJB Server JBoss 4.2.1
28.	EJB Server resin 3.1.5
29.	ERP CRM Financial
30.	ESB
31.	Forum
32.	GIS
33.	Graphic Library
34.	Groupware
35.	HTML Parser
36.	IDE
37.	IDE Eclipse
38.	IDE Netbeans
39.	Installer
40.	Internationalization Localization
41.	Inversion of Control
42.	Issue Tracking
43.	J2EE
44.	JBoss
45.	JMS
46.	JMX
47.	Library
48.	Mail Clients
49.	Net
50.	Parser
51.	PDF
52.	Portal
53.	Profiler
54.	Project Management
55.	Report
56.	RSS RDF
57.	Rule Engine
58.	Science
59.	Scripting
60.	Search Engine
61.	Security
62.	Sevlet Container
63.	Source Control
64.	Swing Library
65.	Template Engine
66.	Test Coverage
67.	Testing
68.	UML
69.	Web Crawler
70.	Web Framework
71.	Web Mail
72.	Web Server
73.	Web Services
74.	Web Services apache cxf 2.0.1
75.	Web Services AXIS2
76.	Wiki Engine
77.	Workflow Engines
78.	XML
79.	XML UI

Java

Java Tutorial

Illustrator Tutorials

GIMP Tutorials

C# / C Sharp

C# / CSharp Tutorial

C# / CSharp Open Source

SQL Server / T-SQL Tutorial

Oracle PL / SQL

Oracle PL/SQL Tutorial

Flash / Flex / ActionScript

VBA / Excel / Access / Word

XML

XML Tutorial

Microsoft Office PowerPoint 2007 Tutorial

Microsoft Office Excel 2007 Tutorial

Microsoft Office Word 2007 Tutorial

Java Source Code / Java Documentation » GIS » GeoTools 2.4.1 » org.geotools.openoffice

Source Cross Reference Class Diagram Java Document (Java Doc)

org.geotools.openoffice .Formulas

All known Subclasses:   org.geotools.openoffice .Referencing,  org.geotools.openoffice .Nature,
Formulas
abstract public class Formulas extends WeakBase implements XAddIn,XServiceName,XServiceInfo(Code)
Base class for methods to export as formulas in the OpenOffice spread sheet.
since:
   2.2
version:
   $Id: Formulas.java 27862 2007-11-12 19:51:19Z desruisseaux $
author:
   Martin Desruisseaux

Field Summary
final protected static long DAY_TO_MILLIS
     Factor for conversions of days to milliseconds.
final protected Map methods
     Informations about exported methods.

Constructor Summary
protected Formulas()
     Default constructor.

Method Summary
static String emptyString()
     The string to returns when a formula don't have any value to return.
public String getArgumentDescription(String function, int argument)
     Returns the description of the specified argument.
public String getDisplayArgumentName(String function, int argument)
     Returns the user-visible name of the specified argument.
public String getDisplayCategoryName(String function)
     Returns the user-visible name of the category the function belongs to.
public String getDisplayFunctionName(String function)
     Returns the user-visible function name for an internal name.
protected java.util.Date getEpoch(XPropertySet xOptions)
     Returns the spreadsheet epoch.
protected static double[][] getFailure(int rows, int cols)
     Returns a table filled with Double.NaN NaN values.
public String getFunctionDescription(String function)
     Returns the description of a function.
public String getImplementationName()
     Provides the implementation name of the service implementation.
final protected java.util.Locale getJavaLocale()
     Returns the locale as an object from the Java standard SDK.
static int getLength(Object[] array1, Object[] array2)
     Returns the minimal length of the specified arrays.
public Locale getLocale()
     Returns the locale, which is used by this object.
protected static String getLocalizedMessage(Throwable exception)
     Returns the localized message from the specified exception.
protected Logger getLogger()
     Returns the logger to use for logging warnings.
public String getProgrammaticCategoryName(String function)
     Returns the programmatic name of the category the function belongs to.
public String getProgrammaticFuntionName(String display)
     Returns the internal function name for an user-visible name.
abstract public String getServiceName()
     The service name that can be used to create such an object by a factory.
protected void reportException(String method, Throwable exception)
     Reports an exception.
public void setLocale(Locale locale)
     Sets the locale to be used by this object.
protected void setTimeZone(String timezone)
     Sets the timezone for time values to be provided to Formulas.toDate .
protected java.util.Date toDate(XPropertySet xOptions, double time)
     Converts a date from a spreadsheet value to a Java java.util.Date object. The timezone is the one specified during the last invocation of Formulas.setTimeZone .
Parameters:
  xOptions - Provided by OpenOffice.
Parameters:
  time - The spreadsheet numerical value for a date, by default in the local timezone.
protected double toDouble(XPropertySet xOptions, java.util.Date time)
     Converts a date from a Java java.util.Date object to a spreadsheet value.

Field Detail
DAY_TO_MILLIS
final protected static long DAY_TO_MILLIS(Code)
Factor for conversions of days to milliseconds. Used for date conversions as in Formulas.toDate .

methods
final protected Map methods(Code)
Informations about exported methods.

Constructor Detail
Formulas
protected Formulas()(Code)
Default constructor. Subclass constructors need to add entries in the Formulas.methods map.

Method Detail
emptyString
static String emptyString()(Code)
The string to returns when a formula don't have any value to return.

getArgumentDescription
public String getArgumentDescription(String function, int argument)(Code)
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 .
Parameters:
  function - The exact name of a method within its interface.
Parameters:
  argument - The index of the argument (0-based). The description of the specified argument.

getDisplayArgumentName
public String getDisplayArgumentName(String function, int argument)(Code)
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 .
Parameters:
  function - The exact name of a method within its interface.
Parameters:
  argument - The index of the argument (0-based). The user-visible name of the specified argument.

getDisplayCategoryName
public String getDisplayCategoryName(String function)(Code)
Returns the user-visible name of the category the function belongs to. This is used when category names are shown to the user.
Parameters:
  function - The exact name of a method within its interface. The user-visible category name the specified function belongs to.

getDisplayFunctionName
public String getDisplayFunctionName(String function)(Code)
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 , so it is never stored in files. It should be a single word and is used when entering or displaying formulas.
Parameters:
  function - The exact name of a method within its interface. The user-visible name of the specified function.

getEpoch
protected java.util.Date getEpoch(XPropertySet xOptions)(Code)
Returns the spreadsheet epoch. The timezone is the one specified during the last invocation of Formulas.setTimeZone . The epoch is used for date conversions as in Formulas.toDate .
Parameters:
  xOptions - Provided by OpenOffice. The spreedsheet epoch, always as a new Java Date object.

getFailure
protected static double[][] getFailure(int rows, int cols)(Code)
Returns a table filled with Double.NaN NaN values. This method is invoked when an operation failed for a whole table.
since:
   2.3

getFunctionDescription
public String getFunctionDescription(String function)(Code)
Returns the description of a function. The description is shown to the user when selecting functions. It may be translated to the .
Parameters:
  function - The exact name of a method within its interface. The description of the specified function.

getImplementationName
public String getImplementationName()(Code)
Provides the implementation name of the service implementation. Unique name of the implementation.

getJavaLocale
final protected java.util.Locale getJavaLocale()(Code)
Returns the locale as an object from the Java standard SDK.

getLength
static int getLength(Object[] array1, Object[] array2)(Code)
Returns the minimal length of the specified arrays. In the special case where one array has a length of 1, we assume that this single element will be repeated for all elements in the other array.

getLocale
public Locale getLocale()(Code)
Returns the locale, which is used by this object.

getLocalizedMessage
protected static String getLocalizedMessage(Throwable exception)(Code)
Returns the localized message from the specified exception. If no message is available, returns a default string. This method never returns a null value.

getLogger
protected Logger getLogger()(Code)
Returns the logger to use for logging warnings. The default implementation returns the org.geotools.openoffice logger. Subclasses should override this method if they want to use a different logger.

getProgrammaticCategoryName
public String getProgrammaticCategoryName(String function)(Code)
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 com.sun.star.sheet.XAddIn interface.
Parameters:
  function - The exact name of a method within its interface. The category name the specified function belongs to.

getProgrammaticFuntionName
public String getProgrammaticFuntionName(String display)(Code)
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 , so it is never stored in files. It should be a single word and is used when entering or displaying formulas.
Attention: The method name contains a spelling error. Due to compatibility reasons the name cannot be changed.
Parameters:
  display - The user-visible name of a function. The exact name of the method within its interface.

getServiceName
abstract public String getServiceName()(Code)
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:
private static final String __serviceName;

reportException
protected void reportException(String method, Throwable exception)(Code)
Reports an exception. This is used if an exception occured in a method which can't returns a String 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.

setLocale
public void setLocale(Locale locale)(Code)
Sets the locale to be used by this object.

setTimeZone
protected void setTimeZone(String timezone)(Code)
Sets the timezone for time values to be provided to Formulas.toDate . If this method is never invoked, then the default timezone is the locale one.

toDate
protected java.util.Date toDate(XPropertySet xOptions, double time)(Code)
Converts a date from a spreadsheet value to a Java java.util.Date object. The timezone is the one specified during the last invocation of Formulas.setTimeZone .
Parameters:
  xOptions - Provided by OpenOffice.
Parameters:
  time - The spreadsheet numerical value for a date, by default in the local timezone. The date as a Java object.

toDouble
protected double toDouble(XPropertySet xOptions, java.util.Date time)(Code)
Converts a date from a Java java.util.Date object to a spreadsheet value. The timezone is the one specified during the last invocation of Formulas.setTimeZone .

www.java2java.com | Contact Us

All other trademarks are property of their respective owners.