You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@poi.apache.org by bu...@apache.org on 2011/01/14 19:32:56 UTC

DO NOT REPLY [Bug 50587] New: User Defined Function Documentation/Example

https://issues.apache.org/bugzilla/show_bug.cgi?id=50587

           Summary: User Defined Function Documentation/Example
           Product: POI
           Version: 3.8-dev
          Platform: All
        OS/Version: All
            Status: NEW
          Severity: enhancement
          Priority: P2
         Component: HSSF
        AssignedTo: dev@poi.apache.org
        ReportedBy: jsvede@yahoo.com


Created an attachment (id=26490)
 --> (https://issues.apache.org/bugzilla/attachment.cgi?id=26490)
A patch containing the documentation, images and code samples.

Attached you will find some documentation and a small sample of a User Defined
Function.  The documentation follows the sample code.

-- 
Configure bugmail: https://issues.apache.org/bugzilla/userprefs.cgi?tab=email
------- You are receiving this mail because: -------
You are the assignee for the bug.

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@poi.apache.org
For additional commands, e-mail: dev-help@poi.apache.org

DO NOT REPLY [Bug 50587] User Defined Function Documentation/Example

Posted by bu...@apache.org.
https://issues.apache.org/bugzilla/show_bug.cgi?id=50587

--- Comment #8 from Jon Svede <js...@yahoo.com> 2011-01-18 11:58:33 EST ---
Created an attachment (id=26509)
 --> (https://issues.apache.org/bugzilla/attachment.cgi?id=26509)
the actual patch for the previous submission

This is the actual patch for the previous attachment.

-- 
Configure bugmail: https://issues.apache.org/bugzilla/userprefs.cgi?tab=email
------- You are receiving this mail because: -------
You are the assignee for the bug.

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@poi.apache.org
For additional commands, e-mail: dev-help@poi.apache.org

DO NOT REPLY [Bug 50587] User Defined Function Documentation/Example

Posted by bu...@apache.org.
https://issues.apache.org/bugzilla/show_bug.cgi?id=50587

Yegor Kozlov <ye...@dinom.ru> changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
             Status|NEW                         |RESOLVED
         Resolution|                            |FIXED

--- Comment #9 from Yegor Kozlov <ye...@dinom.ru> 2011-01-19 04:22:48 EST ---
Applied in r1060724

Yegor

-- 
Configure bugmail: https://issues.apache.org/bugzilla/userprefs.cgi?tab=email
------- You are receiving this mail because: -------
You are the assignee for the bug.

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@poi.apache.org
For additional commands, e-mail: dev-help@poi.apache.org

DO NOT REPLY [Bug 50587] User Defined Function Documentation/Example

Posted by bu...@apache.org.
https://issues.apache.org/bugzilla/show_bug.cgi?id=50587

--- Comment #4 from Jon Svede <js...@yahoo.com> 2011-01-17 09:46:51 EST ---
Created an attachment (id=26499)
 --> (https://issues.apache.org/bugzilla/attachment.cgi?id=26499)
archive that contains the new files

Sorry for that, I misread the docs.  Attached is an archive file with all the
new .xml, .xls, .jpg and .java files.

Thanks,

Jon

-- 
Configure bugmail: https://issues.apache.org/bugzilla/userprefs.cgi?tab=email
------- You are receiving this mail because: -------
You are the assignee for the bug.

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@poi.apache.org
For additional commands, e-mail: dev-help@poi.apache.org

DO NOT REPLY [Bug 50587] User Defined Function Documentation/Example

Posted by bu...@apache.org.
https://issues.apache.org/bugzilla/show_bug.cgi?id=50587

--- Comment #5 from Yegor Kozlov <ye...@dinom.ru> 2011-01-18 10:18:40 EST ---
I made some tweaks, please review the updated patch.

Summary of my changes:

(1) added ASF licence header to CalculateMortgage.java and
UserDefinedFunctionExample.java. This is a must in Apache projects.
(2) repackaged CalculateMortgage.java and UserDefinedFunctionExample.java from
poi.tests to org.apache.poi.ss.examples.formula
(3) removed @Override from implemented interfaces, this is a JDK-1.6 feature.
POI's language level is JDK-1.5 and it supports @Override only in sub-classes,
not in interface implementatations. 
(4) Removed explicit instantiation of HSSFFormulaEvaluator. POI can work with
UDFs in terms of common Spreadsheet interfaces:


  UDFFinder udfToolpack = new DefaultUDFFinder( functionNames, functionImpls )
;

  // register the user-defined function in the workbook
  workbook.addToolPack(udfToolpack);

  FormulaEvaluator evaluator =
workbook.getCreationHelper().createFormulaEvaluator();

The code above transparently works with HSSF and XSSF. 

Other than that, very cool! Thanks for the excellent patch.

The compiled documentation is available here:

http://people.apache.org/~yegor/50587/site/spreadsheet/user-defined-functions.html

If there are no questions / objections, I will apply it later this week.

Regards,
Yegor

-- 
Configure bugmail: https://issues.apache.org/bugzilla/userprefs.cgi?tab=email
------- You are receiving this mail because: -------
You are the assignee for the bug.

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@poi.apache.org
For additional commands, e-mail: dev-help@poi.apache.org

DO NOT REPLY [Bug 50587] User Defined Function Documentation/Example

Posted by bu...@apache.org.
https://issues.apache.org/bugzilla/show_bug.cgi?id=50587

--- Comment #1 from Yegor Kozlov <ye...@dinom.ru> 2011-01-16 14:06:58 EST ---
The images and .xls files are missing. Please re-attach.

Yegor

-- 
Configure bugmail: https://issues.apache.org/bugzilla/userprefs.cgi?tab=email
------- You are receiving this mail because: -------
You are the assignee for the bug.

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@poi.apache.org
For additional commands, e-mail: dev-help@poi.apache.org

DO NOT REPLY [Bug 50587] User Defined Function Documentation/Example

Posted by bu...@apache.org.
https://issues.apache.org/bugzilla/show_bug.cgi?id=50587

--- Comment #2 from Jon Svede <js...@yahoo.com> 2011-01-17 01:09:04 EST ---
Forgive me, but do these get attached to this ticket or are they somehow
included in the patch?

Sincerely,

Jon

-- 
Configure bugmail: https://issues.apache.org/bugzilla/userprefs.cgi?tab=email
------- You are receiving this mail because: -------
You are the assignee for the bug.

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@poi.apache.org
For additional commands, e-mail: dev-help@poi.apache.org

DO NOT REPLY [Bug 50587] User Defined Function Documentation/Example

Posted by bu...@apache.org.
https://issues.apache.org/bugzilla/show_bug.cgi?id=50587

--- Comment #6 from Yegor Kozlov <ye...@dinom.ru> 2011-01-18 10:19:16 EST ---
Created an attachment (id=26507)
 --> (https://issues.apache.org/bugzilla/attachment.cgi?id=26507)
updated patch

-- 
Configure bugmail: https://issues.apache.org/bugzilla/userprefs.cgi?tab=email
------- You are receiving this mail because: -------
You are the assignee for the bug.

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@poi.apache.org
For additional commands, e-mail: dev-help@poi.apache.org

DO NOT REPLY [Bug 50587] User Defined Function Documentation/Example

Posted by bu...@apache.org.
https://issues.apache.org/bugzilla/show_bug.cgi?id=50587

--- Comment #3 from Yegor Kozlov <ye...@dinom.ru> 2011-01-17 05:26:00 EST ---
The attached patch only contains textual changes and does not include binary
data.  You need to put all binary files (images, .xls, etc.) in a .zip archive
and attach it to this ticket. 

Some useful commands how to capture new files can be found here:
http://poi.apache.org/guidelines.html

See the "Submitting Patches" section.

Regards,
Yegor

-- 
Configure bugmail: https://issues.apache.org/bugzilla/userprefs.cgi?tab=email
------- You are receiving this mail because: -------
You are the assignee for the bug.

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@poi.apache.org
For additional commands, e-mail: dev-help@poi.apache.org

DO NOT REPLY [Bug 50587] User Defined Function Documentation/Example

Posted by bu...@apache.org.
https://issues.apache.org/bugzilla/show_bug.cgi?id=50587

--- Comment #7 from Jon Svede <js...@yahoo.com> 2011-01-18 11:56:12 EST ---
Created an attachment (id=26508)
 --> (https://issues.apache.org/bugzilla/attachment.cgi?id=26508)
new patch file with changes to documentation text and code samples

Thanks, Yegor!  Sorry for the silly packaging mistakes.

I am adding some small changes:

(1) added a missing word in the opening sentence of "Defining You Function".
(2) changed some example code: there was an in correct snipped in the
CalculateMortgage file.
(3) removed superfluous commented out code and System.out lines.
(4) added class comments and changed the @author tags appropriately.

Otherwise it's great.  I look forward to seeing it in the next release!

Jon

-- 
Configure bugmail: https://issues.apache.org/bugzilla/userprefs.cgi?tab=email
------- You are receiving this mail because: -------
You are the assignee for the bug.

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@poi.apache.org
For additional commands, e-mail: dev-help@poi.apache.org