2008-04-05 12:04:53 -04:00
|
|
|
<?xml version="1.0" encoding="UTF-8"?>
|
|
|
|
|
<!--
|
|
|
|
|
====================================================================
|
|
|
|
|
Licensed to the Apache Software Foundation (ASF) under one or more
|
|
|
|
|
contributor license agreements. See the NOTICE file distributed with
|
|
|
|
|
this work for additional information regarding copyright ownership.
|
|
|
|
|
The ASF licenses this file to You under the Apache License, Version 2.0
|
|
|
|
|
(the "License"); you may not use this file except in compliance with
|
|
|
|
|
the License. You may obtain a copy of the License at
|
|
|
|
|
|
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
|
|
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
|
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
|
|
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
|
|
|
See the License for the specific language governing permissions and
|
|
|
|
|
limitations under the License.
|
|
|
|
|
====================================================================
|
|
|
|
|
-->
|
|
|
|
|
<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.1//EN" "../dtd/document-v11.dtd">
|
|
|
|
|
|
|
|
|
|
<document>
|
|
|
|
|
<header>
|
2008-07-12 14:53:47 -04:00
|
|
|
<title>Upgrading to POI 3.5, including converting existing HSSF Usermodel code to SS Usermodel (for XSSF and HSSF)</title>
|
2008-04-05 12:04:53 -04:00
|
|
|
<authors>
|
|
|
|
|
<person email="nick@apache.org" name="Nick Burch" id="NB"/>
|
|
|
|
|
</authors>
|
|
|
|
|
</header>
|
|
|
|
|
<body>
|
Merged revisions 638786-638802,638805-638811,638813-638814,638816-639230,639233-639241,639243-639253,639255-639486,639488-639601,639603-639835,639837-639917,639919-640056,640058-640710,640712-641156,641158-641184,641186-641795,641797-641798,641800-641933,641935-641963,641965-641966,641968-641995,641997-642230,642232-642562,642564-642565,642568-642570,642572-642573,642576-642736,642739-642877,642879,642881-642890,642892-642903,642905-642945,642947-643624,643626-643653,643655-643669,643671,643673-643830,643832-643833,643835-644342,644344-644472,644474-644508,644510-645347,645349-645351,645353-645559,645561-645565,645568-645951,645953-646193,646195-646311,646313-646404,646406-646665,646667-646853,646855-646869,646871-647151,647153-647185,647187-647277,647279-647566,647568-647573,647575,647578-647711,647714-647737,647739-647823,647825-648155,648157-648202,648204-648273,648275,648277-648302,648304-648333,648335-648588,648590-648622,648625-648673,648675-649141,649144,649146-649556,649558-649795,649799,649801-649910,649912-649913,649915-650128,650131-650132,650134-650137,650140-650914,650916-651991,651993-652284,652286-652287,652289,652291,652293-652297,652299-652328,652330-652425,652427-652445,652447-652560,652562-652933,652935,652937-652993,652995-653116,653118-653124,653126-653483,653487-653519,653522-653550,653552-653607,653609-653667,653669-653674,653676-653814,653817-653830,653832-653891,653893-653944,653946-654055,654057-654355,654357-654365,654367-654648,654651-655215,655217-655277,655279-655281,655283-655911,655913-656212,656214,656216-656251,656253-656698,656700-656756,656758-656892,656894-657135,657137-657165,657168-657179,657181-657354,657356-657357,657359-657701,657703-657874,657876-658032,658034-658284,658286,658288-658301,658303-658307,658309-658321,658323-658335,658337-658348,658351,658353-658832,658834-658983,658985,658987-659066,659068-659402,659404-659428,659430-659451,659453-659454,659456-659461,659463-659477,659479-659524,659526-659571,659574,659576-660255,660257-660262,660264-660279,660281-660343,660345-660473,660475-660827,660829-660833,660835-660888,660890-663321,663323-663435,663437-663764,663766-663854,663856-664219,664221-664489,664494-664514,664516-668013,668015-668142,668144-668152,668154,668156-668256,668258,668260-669139,669141-669455,669457-669657,669659-669808,669810-670189,670191-671321,671323-672229,672231-672549,672551-672552,672554-672561,672563-672566,672568,672571-673049,673051-673852,673854-673862,673864-673986,673988-673996,673998-674347,674349-674890,674892-674910,674912-674936,674938-674952,674954-675078,675080-675085,675087-675217,675219-675660,675662-675670,675672-675716,675718-675726,675728-675733,675735-675775,675777-675782,675784,675786-675791,675794-676205 via svnmerge from
https://svn.apache.org:443/repos/asf/poi/trunk
........
r675853 | josh | 2008-07-11 08:59:44 +0100 (Fri, 11 Jul 2008) | 1 line
Patch 45289 - finished support for special comparison operators in COUNTIF
........
r676201 | nick | 2008-07-12 17:56:55 +0100 (Sat, 12 Jul 2008) | 1 line
Support for cloning one font record onto another, plus tests
........
r676203 | nick | 2008-07-12 18:21:54 +0100 (Sat, 12 Jul 2008) | 1 line
Support for cloning one extended format record onto another, plus tests
........
r676205 | nick | 2008-07-12 18:38:10 +0100 (Sat, 12 Jul 2008) | 1 line
Allow the cloning of one HSSFCellStyle onto another, including cloning styles from one HSSFWorkbook onto another
........
git-svn-id: https://svn.apache.org/repos/asf/poi/branches/ooxml@676209 13f79535-47bb-0310-9956-ffa450edef68
2008-07-12 14:17:16 -04:00
|
|
|
<section><title>Things that have to be changed when upgrading to POI 3.5</title>
|
|
|
|
|
<p>Wherever possible, we have tried to ensure that you can use your
|
|
|
|
|
existing POI code with POI 3.5 without requiring any changes. However,
|
|
|
|
|
Java doesn't always make that easy, and unfortunately there are a
|
|
|
|
|
few changes that may be required for some users.</p>
|
|
|
|
|
<section><title>org.apache.poi.hssf.usermodel.HSSFFormulaEvaluator.CellValue</title>
|
|
|
|
|
<p>Annoyingly, java will not let you access a static inner class via
|
|
|
|
|
a child of the parent one. So, all references to
|
|
|
|
|
<em>org.apache.poi.hssf.usermodel.HSSFFormulaEvaluator.CellValue</em>
|
|
|
|
|
will need to be changed to
|
|
|
|
|
<em>org.apache.poi.ss.usermodel.FormulaEvaluator.CellValue</em>
|
|
|
|
|
</p>
|
|
|
|
|
</section>
|
2008-07-12 14:53:47 -04:00
|
|
|
<section><title>org.apache.poi.hssf.usermodel.HSSFRow.MissingCellPolicy</title>
|
2008-07-12 14:28:59 -04:00
|
|
|
<p>Annoyingly, java will not let you access a static inner class via
|
|
|
|
|
a child of the parent one. So, all references to
|
|
|
|
|
<em>org.apache.poi.hssf.usermodel.HSSFRow.MissingCellPolicy</em>
|
|
|
|
|
will need to be changed to
|
|
|
|
|
<em>org.apache.poi.ss.usermodel.Row.MissingCellPolicy</em>
|
|
|
|
|
</p>
|
|
|
|
|
</section>
|
2008-07-12 14:53:47 -04:00
|
|
|
</section>
|
|
|
|
|
<section><title>Converting existing HSSF Usermodel code to SS Usermodel (for XSSF and HSSF)</title>
|
2008-04-05 12:04:53 -04:00
|
|
|
|
|
|
|
|
<section><title>Why change?</title>
|
|
|
|
|
<p>If you have existing HSSF usermodel code that works just
|
|
|
|
|
fine, and you don't want to use the new OOXML XSSF support,
|
|
|
|
|
then you probably don't need to. Your existing HSSF only code
|
|
|
|
|
will continue to work just fine.</p>
|
|
|
|
|
<p>However, if you want to be able to work with both HSSF for
|
|
|
|
|
your .xls files, and also XSSF for .xslx files, then you will
|
|
|
|
|
need to make some slight tweaks to your code.</p>
|
|
|
|
|
</section>
|
|
|
|
|
<section><title>org.apache.poi.ss.usermodel</title>
|
|
|
|
|
<p>The new SS usermodel (org.apache.poi.ss.usermodel) is very
|
|
|
|
|
heavily based on the old HSSF usermodel
|
|
|
|
|
(org.apache.poi.hssf.usermodel). The main difference is that
|
|
|
|
|
the package name and class names have been tweaked to remove
|
|
|
|
|
HSSF from them. Otherwise, the new SS Usermodel interfaces
|
|
|
|
|
should provide the same functionality.</p>
|
|
|
|
|
</section>
|
|
|
|
|
<section><title>Constructors</title>
|
|
|
|
|
<p>Calling the empty HSSFWorkbook remains as the way to
|
|
|
|
|
create a new, empty Workbook object. To open an existing
|
|
|
|
|
Worbook, you should now call WorkbookFactory.create(inp).</p>
|
|
|
|
|
<p>For all other cases when you would have called a
|
|
|
|
|
Usermodel constructor, such as 'new HSSFRichTextString()' or
|
|
|
|
|
'new HSSFDataFormat', you should instead use a CreationHelper.
|
|
|
|
|
There's a method on the Workbook to get a CreationHelper, and
|
|
|
|
|
the CreationHelper will then handle constructing new objects
|
|
|
|
|
for you.</p>
|
|
|
|
|
</section>
|
|
|
|
|
<section><title>Other Code</title>
|
|
|
|
|
<p>For all other code, generally change a reference from
|
|
|
|
|
org.apache.poi.hssf.usermodel.HSSFFoo to a reference to
|
|
|
|
|
org.apache.poi.ss.usermodel.Foo. Method signatures should
|
|
|
|
|
otherwise remain the same, and it should all then work for
|
|
|
|
|
both XSSF and HSSF.</p>
|
|
|
|
|
</section>
|
2008-07-12 14:53:47 -04:00
|
|
|
</section>
|
|
|
|
|
<section><title>Worked Examples</title>
|
|
|
|
|
<section><title>Old HSSF Code</title>
|
2008-04-05 12:04:53 -04:00
|
|
|
<source><![CDATA[
|
|
|
|
|
// import org.apache.poi.hssf.usermodel.*;
|
|
|
|
|
|
|
|
|
|
HSSFWorkbook wb = new HSSFWorkbook();
|
|
|
|
|
// create a new sheet
|
|
|
|
|
HSSFSheet s = wb.createSheet();
|
|
|
|
|
// declare a row object reference
|
|
|
|
|
HSSFRow r = null;
|
|
|
|
|
// declare a cell object reference
|
|
|
|
|
HSSFCell c = null;
|
|
|
|
|
// create 2 cell styles
|
|
|
|
|
HSSFCellStyle cs = wb.createCellStyle();
|
|
|
|
|
HSSFCellStyle cs2 = wb.createCellStyle();
|
|
|
|
|
HSSFDataFormat df = wb.createDataFormat();
|
|
|
|
|
|
|
|
|
|
// create 2 fonts objects
|
|
|
|
|
HSSFFont f = wb.createFont();
|
|
|
|
|
HSSFFont f2 = wb.createFont();
|
|
|
|
|
|
|
|
|
|
// Set font 1 to 12 point type, blue and bold
|
|
|
|
|
f.setFontHeightInPoints((short) 12);
|
|
|
|
|
f.setColor( (short)0xc );
|
|
|
|
|
f.setBoldweight(HSSFFont.BOLDWEIGHT_BOLD);
|
|
|
|
|
|
|
|
|
|
// Set font 2 to 10 point type, red and bold
|
|
|
|
|
f2.setFontHeightInPoints((short) 10);
|
|
|
|
|
f2.setColor( (short)HSSFFont.COLOR_RED );
|
|
|
|
|
f2.setBoldweight(HSSFFont.BOLDWEIGHT_BOLD);
|
|
|
|
|
|
|
|
|
|
// Set cell style and formatting
|
|
|
|
|
cs.setFont(f);
|
|
|
|
|
cs.setDataFormat(df.getFormat("#,##0.0"));
|
|
|
|
|
|
|
|
|
|
// Set the other cell style and formatting
|
|
|
|
|
cs2.setBorderBottom(cs2.BORDER_THIN);
|
|
|
|
|
cs2.setDataFormat(HSSFDataFormat.getBuiltinFormat("text"));
|
|
|
|
|
cs2.setFont(f2);
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
// Define a few rows
|
|
|
|
|
for(short rownum = (short)0; rownum < 30; rownum++) {
|
|
|
|
|
HSSFRow r = s.createRow(rownum);
|
|
|
|
|
for(short cellnum = (short)0; cellnum < 10; cellnum += 2) {
|
|
|
|
|
HSSFCell c = r.createCell(cellnum);
|
|
|
|
|
HSSFCell c2 = r.createCell(cellnum+1);
|
|
|
|
|
|
|
|
|
|
c.setCellValue((double)rownum + (cellnum/10));
|
|
|
|
|
c2.setCellValue(new HSSFRichTextString("Hello! " + cellnum);
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// Save
|
|
|
|
|
FileOutputStream out = new FileOutputStream("workbook.xls");
|
|
|
|
|
wb.write(out);
|
|
|
|
|
out.close();
|
|
|
|
|
]]></source>
|
|
|
|
|
</section>
|
|
|
|
|
<section><title>New, generic SS Usermodel Code</title>
|
|
|
|
|
<source><![CDATA[
|
|
|
|
|
// import org.apache.poi.ss.usermodel.*;
|
|
|
|
|
|
|
|
|
|
Workbook[] wbs = new Workbook[] { new HSSFWorkbook(), new XSSFWorkbook() };
|
|
|
|
|
for(int i=0; i<wbs.length; i++) {
|
|
|
|
|
Workbook wb = wbs[i];
|
|
|
|
|
CreationHelper createHelper = wb.getCreationHelper();
|
|
|
|
|
|
|
|
|
|
// create a new sheet
|
|
|
|
|
Sheet s = wb.createSheet();
|
|
|
|
|
// declare a row object reference
|
|
|
|
|
Row r = null;
|
|
|
|
|
// declare a cell object reference
|
|
|
|
|
Cell c = null;
|
|
|
|
|
// create 2 cell styles
|
|
|
|
|
CellStyle cs = wb.createCellStyle();
|
|
|
|
|
CellStyle cs2 = wb.createCellStyle();
|
|
|
|
|
DataFormat df = wb.createDataFormat();
|
|
|
|
|
|
|
|
|
|
// create 2 fonts objects
|
|
|
|
|
Font f = wb.createFont();
|
|
|
|
|
Font f2 = wb.createFont();
|
|
|
|
|
|
|
|
|
|
// Set font 1 to 12 point type, blue and bold
|
|
|
|
|
f.setFontHeightInPoints((short) 12);
|
|
|
|
|
f.setColor( (short)0xc );
|
|
|
|
|
f.setBoldweight(Font.BOLDWEIGHT_BOLD);
|
|
|
|
|
|
|
|
|
|
// Set font 2 to 10 point type, red and bold
|
|
|
|
|
f2.setFontHeightInPoints((short) 10);
|
|
|
|
|
f2.setColor( (short)Font.COLOR_RED );
|
|
|
|
|
f2.setBoldweight(Font.BOLDWEIGHT_BOLD);
|
|
|
|
|
|
|
|
|
|
// Set cell style and formatting
|
|
|
|
|
cs.setFont(f);
|
|
|
|
|
cs.setDataFormat(df.getFormat("#,##0.0"));
|
|
|
|
|
|
|
|
|
|
// Set the other cell style and formatting
|
|
|
|
|
cs2.setBorderBottom(cs2.BORDER_THIN);
|
|
|
|
|
cs2.setDataFormat(df.getFormat("text"));
|
|
|
|
|
cs2.setFont(f2);
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
// Define a few rows
|
|
|
|
|
for(int rownum = 0; rownum < 30; rownum++) {
|
|
|
|
|
Row r = s.createRow(rownum);
|
|
|
|
|
for(int cellnum = 0; cellnum < 10; cellnum += 2) {
|
|
|
|
|
Cell c = r.createCell(cellnum);
|
|
|
|
|
Cell c2 = r.createCell(cellnum+1);
|
|
|
|
|
|
|
|
|
|
c.setCellValue((double)rownum + (cellnum/10));
|
|
|
|
|
c2.setCellValue(
|
|
|
|
|
createHelper.createRichTextString("Hello! " + cellnum)
|
|
|
|
|
);
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// Save
|
|
|
|
|
String filename = "workbook.xls";
|
|
|
|
|
if(wb instanceof XSSFWorkbook) {
|
|
|
|
|
filename = filename + "x";
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
FileOutputStream out = new FileOutputStream(filename);
|
|
|
|
|
wb.write(out);
|
|
|
|
|
out.close();
|
|
|
|
|
}
|
|
|
|
|
]]></source>
|
|
|
|
|
</section>
|
|
|
|
|
</section>
|
|
|
|
|
</body>
|
|
|
|
|
</document>
|