Apache
/
poi
mirror of https://github.com/apache/poi.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

change package.html to package-info.java 

git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@1870655 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Andreas Beeker 2019-12-01 00:07:48 +00:00
parent b4b661acc1
commit 5f28881a35
30 changed files with 364 additions and 683 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
src/java/org/apache/poi/ss/format/package.html → src/examples/src/org/apache/poi/hssf/view/brush/package-info.java
View File

@ -1,6 +1,4 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN"> /* ====================================================================
<!--
====================================================================
Licensed to the Apache Software Foundation (ASF) under one or more Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with contributor license agreements. See the NOTICE file distributed with
this work for additional information regarding copyright ownership. this work for additional information regarding copyright ownership.
@ -15,12 +13,9 @@
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and See the License for the specific language governing permissions and
limitations under the License. limitations under the License.
==================================================================== ==================================================================== */
-->
<html> /**
<head> * This package contains some brushes that are used when drawing borders for Excel cells.
</head> */
<body> package org.apache.poi.hssf.view.brush;
This package contains classes that implement cell formatting
</body>
</html>

21
src/ooxml/java/org/apache/poi/xwpf/package.html → src/examples/src/org/apache/poi/ss/examples/html/package-info.java
View File

@ -1,6 +1,4 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN"> /* ====================================================================
<!--
====================================================================
Licensed to the Apache Software Foundation (ASF) under one or more Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with contributor license agreements. See the NOTICE file distributed with
this work for additional information regarding copyright ownership. this work for additional information regarding copyright ownership.
@ -15,13 +13,10 @@
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and See the License for the specific language governing permissions and
limitations under the License. limitations under the License.
==================================================================== ==================================================================== */
-->
<html> /**
<body> * This package contains an example that uses POI to convert a workbook into
<p>This package contains classes for handling Microsoft .docx * an HTML representation of the data. It can use both XSSF and HSSF workbooks.
Word Processing files, known in POI as XWPF (XML Word Processing */
Format). package org.apache.poi.ss.examples.html;
</p>
</body>
</html>

22
src/java/org/apache/poi/ddf/package-info.java Normal file
View File

@ -0,0 +1,22 @@
/* ====================================================================
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.
==================================================================== */
/**
* This package contains classes for decoding the Microsoft Office Drawing format otherwise
* known as escher henceforth known in POI as the Dreadful Drawing Format.
*/
package org.apache.poi.ddf;

62
src/java/org/apache/poi/hpsf/package-info.java Normal file
View File

@ -0,0 +1,62 @@
/* ====================================================================
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.
==================================================================== */
/**
* Processes streams in the Horrible Property Set Format (HPSF) in POI filesystems.
* Microsoft Office documents, i.e. POI filesystems, usually contain meta data like author, title,
* last saving time etc. These items are called <strong>properties</strong> and stored in
* <strong>property set streams</strong> along with the document itself.
* These streams are commonly named {@code \005SummaryInformation} and {@code \005DocumentSummaryInformation}.
* However, a POI filesystem may contain further property sets of other names or types.
* <p>
* In order to extract the properties from a POI filesystem, a property set stream's contents must be parsed into a
* {@link org.apache.poi.hpsf.PropertySet} instance. Its subclasses {@link org.apache.poi.hpsf.SummaryInformation}
* and {@link org.apache.poi.hpsf.DocumentSummaryInformation} deal with the well-known property set streams
* {@code \005SummaryInformation} and {@code \005DocumentSummaryInformation}.
* (However, the streams' names are irrelevant. What counts is the property set's first section's format ID - see below.)
* <p>
* The factory method {@link org.apache.poi.hpsf.PropertySetFactory#create} creates a PropertySet instance.
* This method always returns the <strong>most specific property set</strong>:
* If it identifies the stream data as a Summary Information or as a Document Summary Information it returns an
* instance of the corresponding class, else the general PropertySet.
* <p>
* A PropertySet contains a list of {@link org.apache.poi.hpsf.Section Sections} which can be
* retrieved with {@link org.apache.poi.hpsf.PropertySet#getSections}. Each Section contains a
* {@link org.apache.poi.hpsf.Property} array which can be retrieved with
* {@link org.apache.poi.hpsf.Section#getProperties}. Since the vast majority of PropertySets contains only a single Section,
* the convenience method {@link org.apache.poi.hpsf.PropertySet#getProperties} returns the properties of a
* PropertySets Section (throwing a {@link org.apache.poi.hpsf.NoSingleSectionException} if the PropertySet contains
* more (or less) than exactly one Section).
* <p>
* Each Property has an <strong>ID</strong>, a <strong>type</strong>, and a <strong>value</strong> which can be
* retrieved with {@link org.apache.poi.hpsf.Property#getID}, {@link org.apache.poi.hpsf.Property#getType},
* and {@link org.apache.poi.hpsf.Property#getValue}, respectively. The value's class depends on the property's type.
* <!-- FIXME: --> The current implementation does not yet support all property types and restricts the values' classes
* to String, Integer and Date. A value of a yet unknown type is returned as a byte array containing the values
* origin bytes from the property set stream.
* <p>
* To retrieve the value of a specific Property, use {@link org.apache.poi.hpsf.Section#getProperty} or
* {@link org.apache.poi.hpsf.Section#getPropertyIntValue}.
* <p>
* The SummaryInformation and DocumentSummaryInformation classes provide convenience methods for retrieving well-known
* properties. For example, an application that wants to retrieve a document's title string just calls
* {@link org.apache.poi.hpsf.SummaryInformation#getTitle} instead of going through the hassle of first finding out
* what the title's property ID is and then using this ID to get the property's value.
*
* @see <a href="https://docs.microsoft.com/en-us/openspecs/windows_protocols/ms-oleps/bf7aeae8-c47a-4939-9f45-700158dac3bc">[MS-OLEPS] Object Linking and Embedding (OLE) Property Set Data Structures</a>
*/
package org.apache.poi.hpsf;

159
src/java/org/apache/poi/hpsf/package.html
View File

@ -1,159 +0,0 @@
<!doctype html public "-//W3C//DTD HTML 4.0//EN//">
<!--
====================================================================
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.
====================================================================
-->
<html>
<head>
<title>HPSF</title>
</head>
<body>
<div>
<p>Processes streams in the Horrible Property Set Format (HPSF) in POI
filesystems. Microsoft Office documents, i.e. POI filesystems, usually
contain meta data like author, title, last saving time etc. These items
are called <strong>properties</strong> and stored in
<strong>property set streams</strong> along with the document itself. These
streams are commonly named <tt>\005SummaryInformation</tt> and
<tt>\005DocumentSummaryInformation</tt>. However, a POI filesystem may
contain further property sets of other names or types.</p>
<p>In order to extract the properties from a POI filesystem, a property set
stream's contents must be parsed into a {@link
org.apache.poi.hpsf.PropertySet} instance. Its subclasses {@link
org.apache.poi.hpsf.SummaryInformation} and {@link
org.apache.poi.hpsf.DocumentSummaryInformation} deal with the well-known
property set streams <tt>\005SummaryInformation</tt> and
<tt>\005DocumentSummaryInformation</tt>. (However, the streams' names are
irrelevant. What counts is the property set's first section's format ID -
see below.)</p>
<p>The factory method {@link org.apache.poi.hpsf.PropertySetFactory#create}
creates a {@link org.apache.poi.hpsf.PropertySet} instance. This method
always returns the <strong>most specific property set</strong>: If it
identifies the stream data as a Summary Information or as a Document
Summary Information it returns an instance of the corresponding class, else
the general {@link org.apache.poi.hpsf.PropertySet}.</p>
<p>A {@link org.apache.poi.hpsf.PropertySet} contains a list of {@link
org.apache.poi.hpsf.Section}s which can be retrieved with {@link
org.apache.poi.hpsf.PropertySet#getSections}. Each {@link
org.apache.poi.hpsf.Section} contains a {@link
org.apache.poi.hpsf.Property} array which can be retrieved with {@link
org.apache.poi.hpsf.Section#getProperties}. Since the vast majority of
{@link org.apache.poi.hpsf.PropertySet}s contains only a single {@link
org.apache.poi.hpsf.Section}, the convenience method {@link
org.apache.poi.hpsf.PropertySet#getProperties} returns the properties of a
{@link org.apache.poi.hpsf.PropertySet}'s {@link
org.apache.poi.hpsf.Section} (throwing a {@link
org.apache.poi.hpsf.NoSingleSectionException} if the {@link
org.apache.poi.hpsf.PropertySet} contains more (or less) than exactly one
{@link org.apache.poi.hpsf.Section}).</p>
<p>Each {@link org.apache.poi.hpsf.Property} has an <strong>ID</strong>, a
<strong>type</strong>, and a <strong>value</strong> which can be retrieved
with {@link org.apache.poi.hpsf.Property#getID}, {@link
org.apache.poi.hpsf.Property#getType}, and {@link
org.apache.poi.hpsf.Property#getValue}, respectively. The value's class
depends on the property's type. <!-- FIXME: --> The current implementation
does not yet support all property types and restricts the values' classes
to {@link java.lang.String}, {@link java.lang.Integer} and {@link
java.util.Date}. A value of a yet unknown type is returned as a byte array
containing the value's origin bytes from the property set stream.</p>
<p>To retrieve the value of a specific {@link org.apache.poi.hpsf.Property},
use {@link org.apache.poi.hpsf.Section#getProperty} or {@link
org.apache.poi.hpsf.Section#getPropertyIntValue}.</p>
<p>The {@link org.apache.poi.hpsf.SummaryInformation} and {@link
org.apache.poi.hpsf.DocumentSummaryInformation} classes provide convenience
methods for retrieving well-known properties. For example, an application
that wants to retrieve a document's title string just calls {@link
org.apache.poi.hpsf.SummaryInformation#getTitle} instead of going through
the hassle of first finding out what the title's property ID is and then
using this ID to get the property's value.</p>
<p>Public documentation from Microsoft can be found in the <a
href="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/stg/stg/properties_and_property_sets.asp"
target="_blank">appropriate section of the MSDN Library</a>.</p>
<div>
<h2>History</h2>
<dl>
<dt>2003-09-11:</dt>
<dd>
<p>{@link org.apache.poi.hpsf.PropertySetFactory#create(InputStream)} no
longer throws an
{@link org.apache.poi.hpsf.UnexpectedPropertySetTypeException}.</p></dd>
</dl>
</div>
<div>
<h2>To Do</h2>
<p>The following is still left to be implemented. Sponsering could foster
these issues considerably.</p>
<ul>
<li>
<p>Convenience methods for setting summary information and document
summary information properties</p>
</li>
<li>
<p>Better codepage support</p>
</li>
<li>
<p>Support for more property (variant) types</p>
</li>
</ul>
</div>
<p>
@author Rainer Klute (klute@rainer-klute.de)
</p>
</div>
</body>
</html>
<!-- Keep this comment at the end of the file
Local variables:
sgml-default-dtd-file:"HTML_4.0_Strict.ced"
mode: html
sgml-omittag:t
sgml-shorttag:nil
sgml-namecase-general:t
sgml-general-insert-case:lower
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
sgml-parent-document:nil
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
-->

32
src/java/org/apache/poi/hssf/package.html → src/java/org/apache/poi/hpsf/wellknown/package-info.java
View File

@ -1,6 +1,4 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN"> /* ====================================================================
<!--
====================================================================
Licensed to the Apache Software Foundation (ASF) under one or more Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with contributor license agreements. See the NOTICE file distributed with
this work for additional information regarding copyright ownership. this work for additional information regarding copyright ownership.
@ -15,21 +13,15 @@
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and See the License for the specific language governing permissions and
limitations under the License. limitations under the License.
==================================================================== ==================================================================== */
-->
<html>
<head>
</head>
<body bgcolor="white">
Horrible SpreadSheet Format API's for reading/writting Excel files using pure Java. /**
* Specific support for DocumentSummaryInformation, SummaryInformation types.
<h2>Related Documentation</h2> * <p>
* Support classes for "well-known" section format IDs and property IDs. The
For overviews, tutorials, examples, guides, and tool documentation, please see: * streams {@code \005DocumentSummaryInformation} and
<ul> * {@code \005SummaryInformation} (or any streams with the same section
<li><a href="http://poi.apache.org">Apache POI Project</a> * format IDs as the aforementioned) are considered well-known. So are most
</ul> * property IDs in these streams.
*/
</body> package org.apache.poi.hpsf.wellknown;
</html>

59
src/java/org/apache/poi/hpsf/wellknown/package.html
View File

@ -1,59 +0,0 @@
<!doctype html public "-//W3C//DTD HTML 4.0//EN//">
<!--
====================================================================
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.
====================================================================
-->
<html>
<head>
<title></title>
</head>
<body>
<div>
Specific support for DocumentSummaryInformation, SummaryInformation types.
<p>Support classes for "well-known" section format IDs and property IDs. The
streams <tt>\005DocumentSummaryInformation</tt> and
<tt>\005SummaryInformation</tt> (or any streams with the same section
format IDs as the aforementioned) are considered well-known. So are most
property IDs in these streams.</p>
<p>
@author Rainer Klute (klute@rainer-klute.de)
</p>
</div>
</body>
</html>
<!-- Keep this comment at the end of the file
Local variables:
sgml-default-dtd-file:"HTML_4.0_Strict.ced"
mode: html
sgml-omittag:t
sgml-shorttag:nil
sgml-namecase-general:t
sgml-general-insert-case:lower
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
sgml-parent-document:nil
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
-->

21
src/examples/src/org/apache/poi/hssf/view/brush/package.html → src/java/org/apache/poi/hssf/dev/package-info.java
View File

@ -1,6 +1,4 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN"> /* ====================================================================
<!--
====================================================================
Licensed to the Apache Software Foundation (ASF) under one or more Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with contributor license agreements. See the NOTICE file distributed with
this work for additional information regarding copyright ownership. this work for additional information regarding copyright ownership.
@ -15,12 +13,13 @@
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and See the License for the specific language governing permissions and
limitations under the License. limitations under the License.
==================================================================== ==================================================================== */
-->
<html>
<body> /**
This package contains some brushes that are used when drawing borders for Excel * DEV package serves two purposes:
cells. * <ol>
</body> * <li>Examples for how to use HSSF
</html> * <li>tools for developing and validating HSSF
* </ol>
*/
package org.apache.poi.hssf.dev;

36
src/java/org/apache/poi/hssf/dev/package.html
View File

@ -1,36 +0,0 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
<!--
====================================================================
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.
====================================================================
-->
<html>
<head>
</head>
<body bgcolor="white">
DEV package serves two purposes. 1. Examples for how to use HSSF and 2. tools for developing
and validating HSSF.
<h2>Related Documentation</h2>
For overviews, tutorials, examples, guides, and tool documentation, please see:
<ul>
<li><a href="http://poi.apache.org">Apache POI Project</a>
</ul>
</body>
</html>

25
src/java/org/apache/poi/hssf/eventusermodel/package-info.java Normal file
View File

@ -0,0 +1,25 @@
/* ====================================================================
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.
==================================================================== */
/**
* HSSF eventmodel Package provides an event-based API for reading HSSF files.
* <p>
* The event model can read XLS files with a very small memory footprint. For
* writing you still have to use the usermodel. The eventmodel is to the usermodel
* what SAX is to DOM.
*/
package org.apache.poi.hssf.eventusermodel;

41
src/java/org/apache/poi/hssf/eventusermodel/package.html
View File

@ -1,41 +0,0 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
<!--
====================================================================
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.
====================================================================
-->
<html>
<head>
</head>
<body bgcolor="white">
HSSF eventmodel Package provides an event-based API for reading HSSF files.
<h2>Related Documentation</h2>
The event model can reald XLS files with a very small memory footprint. For
writing you still have to use the usermodel. The eventmodel is to the usermodel
what SAX is to DOM.
For overviews, tutorials, examples, guides, and tool documentation, please see:
<ul>
<li><a href="http://poi.apache.org">Apache POI Project</a>
</ul>
<!-- Put @see and @since tags down here. -->
@see org.apache.poi.hssf.usermodel
@see org.apache.poi.hssf.record
</body>
</html>

23
src/java/org/apache/poi/hssf/model/package-info.java Normal file
View File

@ -0,0 +1,23 @@
/* ====================================================================
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.
==================================================================== */
/**
* Provides low level API structures for reading, writing, modifying XLS files.
*
* @see org.apache.poi.hssf.usermodel
*/
package org.apache.poi.hssf.model;

22
src/java/org/apache/poi/ss/formula/package.html → src/java/org/apache/poi/hssf/package-info.java
View File

@ -1,6 +1,4 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN"> /* ====================================================================
<!--
====================================================================
Licensed to the Apache Software Foundation (ASF) under one or more Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with contributor license agreements. See the NOTICE file distributed with
this work for additional information regarding copyright ownership. this work for additional information regarding copyright ownership.
@ -15,15 +13,11 @@
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and See the License for the specific language governing permissions and
limitations under the License. limitations under the License.
==================================================================== ==================================================================== */
-->
<html>
<head>
</head>
<body bgcolor="white">
This package contains common internal POI code for manipulating formulas. /**
Client applications should not refer to these classes directly. * Horrible SpreadSheet Format API's for reading/writting Excel files using pure Java.
*
</body> * @see <a href="http://poi.apache.org/components/spreadsheet/index.html">Overview, tutorials, examples, guides, and tool documentation</a>
</html> */
package org.apache.poi.hssf;

25
src/java/org/apache/poi/ddf/package.html → src/java/org/apache/poi/hssf/record/aggregates/package-info.java
View File

@ -1,6 +1,4 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN"> /* ====================================================================
<!--
====================================================================
Licensed to the Apache Software Foundation (ASF) under one or more Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with contributor license agreements. See the NOTICE file distributed with
this work for additional information regarding copyright ownership. this work for additional information regarding copyright ownership.
@ -15,15 +13,14 @@
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and See the License for the specific language governing permissions and
limitations under the License. limitations under the License.
==================================================================== ==================================================================== */
-->
<html>
<body>
<p>This package contains classes for decoding the Microsoft Office /**
Drawing format otherwise known as escher henceforth known in POI * The record aggregates are not real "records" but collections of records that act as a single record.
as the Dreadful Drawing Format. * This is an optimization basically.
</p> *
* @see org.apache.poi.hssf.record
</body> * @see org.apache.poi.hssf.eventmodel
</html> * @see org.apache.poi.hssf.record.RecordFactory
*/
package org.apache.poi.hssf.record.aggregates;

40
src/java/org/apache/poi/hssf/record/aggregates/package.html
View File

@ -1,40 +0,0 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
<!--
====================================================================
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.
====================================================================
-->
<html>
<head>
</head>
<body bgcolor="white">
record aggregates are not real "records" but collections of records that act as a single record.
This is an optimization basically.
<h2>Related Documentation</h2>
For overviews, tutorials, examples, guides, and tool documentation, please see:
<ul>
<li><a href="http://poi.apache.org">Apache POI Project</a>
</ul>
<!-- Put @see and @since tags down here. -->
@see org.apache.poi.hssf.record
@see org.apache.poi.hssf.eventmodel
@see org.apache.poi.hssf.record.RecordFactory
</body>
</html>

23
src/examples/src/org/apache/poi/ss/examples/html/package.html → src/java/org/apache/poi/hssf/record/package-info.java
View File

@ -1,6 +1,4 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN"> /* ====================================================================
<!--
====================================================================
Licensed to the Apache Software Foundation (ASF) under one or more Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with contributor license agreements. See the NOTICE file distributed with
this work for additional information regarding copyright ownership. this work for additional information regarding copyright ownership.
@ -15,13 +13,12 @@
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and See the License for the specific language governing permissions and
limitations under the License. limitations under the License.
==================================================================== ==================================================================== */
-->
<html> /**
<head> * Record package contains class representations for XLS binary strutures. Its very low level.
</head> *
<body> * @see org.apache.poi.hssf.eventmodel
This package contains an example that uses POI to convert a workbook into * @see org.apache.poi.hssf.record.RecordFactory
an HTML representation of the data. It can use both XSSF and HSSF workbooks. */
</body> package org.apache.poi.hssf.record;
</html>

39
src/java/org/apache/poi/hssf/record/package.html
View File

@ -1,39 +0,0 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
<!--
====================================================================
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.
====================================================================
-->
<html>
<head>
</head>
<body bgcolor="white">
Record package contains class representations for XLS binary strutures. Its very
low level.
<h2>Related Documentation</h2>
For overviews, tutorials, examples, guides, and tool documentation, please see:
<ul>
<li><a href="http://poi.apache.org">Apache POI Project</a>
</ul>
<!-- Put @see and @since tags down here. -->
@see org.apache.poi.hssf.eventmodel
@see org.apache.poi.hssf.record.RecordFactory
</body>
</html>

21
src/java/org/apache/poi/hssf/usermodel/package-info.java Normal file
View File

@ -0,0 +1,21 @@
/* ====================================================================
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.
==================================================================== */
/**
* The usermodel package maps HSSF low level structures to familiar workbook/sheet model
*/
package org.apache.poi.hssf.usermodel;

35
src/java/org/apache/poi/hssf/usermodel/package.html
View File

@ -1,35 +0,0 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
<!--
====================================================================
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.
====================================================================
-->
<html>
<head>
</head>
<body bgcolor="white">
usermodel package maps HSSF low level strutures to familiar workbook/sheet model
<h2>Related Documentation</h2>
For overviews, tutorials, examples, guides, and tool documentation, please see:
<ul>
<li><a href="http://poi.apache.org">Apache POI Project</a>
</ul>
</body>
</html>

21
src/java/org/apache/poi/hssf/util/package-info.java Normal file
View File

@ -0,0 +1,21 @@
/* ====================================================================
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.
==================================================================== */
/**
* The util package contains tools needed for writing HSSF files that are not necesarily "real" HSSF concepts.
*/
package org.apache.poi.hssf.util;

36
src/java/org/apache/poi/hssf/util/package.html
View File

@ -1,36 +0,0 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
<!--
====================================================================
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.
====================================================================
-->
<html>
<head>
</head>
<body bgcolor="white">
util package contains tools needed for writing HSSF files that are not necesarily "real"
HSSF concepts.
<h2>Related Documentation</h2>
For overviews, tutorials, examples, guides, and tool documentation, please see:
<ul>
<li><a href="http://poi.apache.org">Apache POI Project</a>
</ul>
</body>
</html>

21
src/java/org/apache/poi/ss/format/package-info.java Normal file
View File

@ -0,0 +1,21 @@
/* ====================================================================
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.
==================================================================== */
/**
* This package contains classes that implement cell formatting
*/
package org.apache.poi.ss.format;

22
src/java/org/apache/poi/ss/formula/package-info.java Normal file
View File

@ -0,0 +1,22 @@
/* ====================================================================
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.
==================================================================== */
/**
* This package contains common internal POI code for manipulating formulas.
* Client applications should not refer to these classes directly.
*/
package org.apache.poi.ss.formula;

24
src/java/org/apache/poi/ss/formula/ptg/package-info.java Normal file
View File

@ -0,0 +1,24 @@
/* ====================================================================
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.
==================================================================== */
/**
* The formula package contains binary PTG structures used in Formulas
*
* @see org.apache.poi.hssf.record
* @see org.apache.poi.hssf.record.FormulaRecord
*/
package org.apache.poi.ss.formula.ptg;

38
src/java/org/apache/poi/ss/formula/ptg/package.html
View File

@ -1,38 +0,0 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
<!--
====================================================================
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.
====================================================================
-->
<html>
<head>
</head>
<body bgcolor="white">
formula package contains binary PTG structures used in Formulas
<h2>Related Documentation</h2>
For overviews, tutorials, examples, guides, and tool documentation, please see:
<ul>
<li><a href="http://poi.apache.org">Apache POI Project</a>
</ul>
<!-- Put @see and @since tags down here. -->
@see org.apache.poi.hssf.record
@see org.apache.poi.hssf.record.FormulaRecord
</body>
</html>

22
src/java/org/apache/poi/util/package-info.java Normal file
View File

@ -0,0 +1,22 @@
/* ====================================================================
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.
==================================================================== */
/**
* Top-level util package are classes that are useful throughout the project. These classes are
* generally generic enough to be useful in any project and should be contributed elsewhere!
*/
package org.apache.poi.util;

36
src/java/org/apache/poi/util/package.html
View File

@ -1,36 +0,0 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
<!--
====================================================================
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.
====================================================================
-->
<html>
<head>
</head>
<body bgcolor="white">
Top-level util package are classes that are useful throughout the project. These classes are
generally generic enough to be useful in any project and should be contributed elsewhere!
<h2>Related Documentation</h2>
For overviews, tutorials, examples, guides, and tool documentation, please see:
<ul>
<li><a href="http://poi.apache.org">Apache POI Project</a>
</ul>
</body>
</html>

36
src/java/org/apache/poi/hssf/model/package.html → src/ooxml/java/org/apache/poi/xssf/binary/package-info.java
View File

@ -1,6 +1,4 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN"> /* ====================================================================
<!--
====================================================================
Licensed to the Apache Software Foundation (ASF) under one or more Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with contributor license agreements. See the NOTICE file distributed with
this work for additional information regarding copyright ownership. this work for additional information regarding copyright ownership.
@ -15,24 +13,16 @@
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and See the License for the specific language governing permissions and
limitations under the License. limitations under the License.
==================================================================== ==================================================================== */
-->
<html>
<head>
</head>
<body bgcolor="white">
Provides low level API structures for reading, writing, modifying XLS files. /**
* The org.apache.poi.xssf.binary package includes necessary underlying components
<h2>Related Documentation</h2> * for streaming/read-only processing of xlsb files.
* <p>
For overviews, tutorials, examples, guides, and tool documentation, please see: * POI does not yet support opening .xlsb files with XSSFWorkbook, but you can read files with XSSFBReader
<ul> * in org.apache.poi.xssf.eventusermodel.
<li><a href="http://poi.apache.org">Apache POI Project</a> * <p>
</ul> * This feature was added in poi-3.16-beta3 and should be considered experimental.
* Most classes have been marked @Internal and the API is subject to change.
<!-- Put @see and @since tags down here. --> */
@see org.apache.poi.hssf.usermodel package org.apache.poi.xssf.binary;
</body>
</html>

44
src/ooxml/java/org/apache/poi/xssf/binary/package.html
View File

@ -1,44 +0,0 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
<!--
====================================================================
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.
====================================================================
-->
<html>
<head>
</head>
<body bgcolor="white">
<p>The org.apache.poi.xssf.binary package includes necessary underlying components
for streaming/read-only processing of xlsb files.
</p>
<p>
POI does not yet support opening .xlsb files with XSSFWorkbook, but you can read files with XSSFBReader
in org.apache.poi.xssf.eventusermodel.
</p>
<p>
This feature was added in poi-3.16-beta3 and should be considered experimental. Most classes
have been marked @Internal and the API is subject to change.
</p>
<h2>Related Documentation</h2>
For overviews, tutorials, examples, guides, and tool documentation, please see:
<ul>
<li><a href="https://poi.apache.org">Apache POI Project</a>
</ul>
</body>
</html>

22
src/ooxml/java/org/apache/poi/xwpf/package-info.java Normal file
View File

@ -0,0 +1,22 @@
/* ====================================================================
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.
==================================================================== */
/**
* This package contains classes for handling Microsoft .docx Word Processing files, known in POI as
* XWPF (XML Word Processing Format).
*/
package org.apache.poi.xwpf;