org.apache.poi.poifs.eventfilesystem

Class POIFSReader

java.lang.Object

org.apache.poi.poifs.eventfilesystem.POIFSReader

public class POIFSReader
extends java.lang.Object

An event-driven reader for POIFS file systems. Users of this class first create an instance of it, then use the registerListener methods to register POIFSReaderListener instances for specific documents. Once all the listeners have been registered, the read() method is called, which results in the listeners being notified as their documents are read. (POIFS 文件系统的事件驱动阅读器。该类的用户首先创建它的一个实例，然后使用 registerListener 方法为特定文档注册 POIFSReaderListener 实例。一旦注册了所有监听器，就会调用 read() 方法，这会导致在读取其文档时通知监听器。)

Constructor Summary

Constructors

Constructor and Description
POIFSReader()

Method Summary

Modifier and Type	Method and Description
static void	main(java.lang.String[] args) read in files (读入文件)
void	read(java.io.File poifsFile) Read from a File and process the documents we get (从文件中读取并处理我们得到的文件)
void	read(java.io.InputStream stream) Read from an InputStream and process the documents we get (从 InputStream 中读取并处理我们得到的文档)
void	read(POIFSFileSystem poifs) Read from a POIFSFileSystem and process the documents we get (从 POIFSFileSystem 读取并处理我们得到的文档)
void	registerListener(POIFSReaderListener listener) Register a POIFSReaderListener for all documents (为所有文档注册一个 POIFSReaderListener)
void	registerListener(POIFSReaderListener listener, POIFSDocumentPath path, java.lang.String name) Register a POIFSReaderListener for a document in the specified directory (为指定目录中的文档注册 POIFSReaderListener)
void	registerListener(POIFSReaderListener listener, java.lang.String name) Register a POIFSReaderListener for a document in the root directory (为根目录中的文档注册一个 POIFSReaderListener)
void	setNotifyEmptyDirectories(boolean notifyEmptyDirectories) Activates the notification of empty directories. (激活空目录的通知。)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

POIFSReader

public POIFSReader()

Method Detail

read

public void read(java.io.InputStream stream)
          throws java.io.IOException

Read from an InputStream and process the documents we get (从 InputStream 中读取并处理我们得到的文档)

Parameters:

stream - the InputStream from which to read the data (stream - 从中读取数据的 InputStream)

Throws:

java.io.IOException - on errors reading, or on invalid data (java.io.IOException - 读取错误或无效数据)

read

public void read(java.io.File poifsFile)
          throws java.io.IOException

Read from a File and process the documents we get (从文件中读取并处理我们得到的文件)

Parameters:

poifsFile - the file from which to read the data (poifsFile - 从中读取数据的文件)

Throws:

java.io.IOException - on errors reading, or on invalid data (java.io.IOException - 读取错误或无效数据)

read

public void read(POIFSFileSystem poifs)
          throws java.io.IOException

Read from a POIFSFileSystem and process the documents we get (从 POIFSFileSystem 读取并处理我们得到的文档)

Parameters:

poifs - the POIFSFileSystem from which to read the data (poifs - 从中读取数据的 POIFSFileSystem)

Throws:

java.io.IOException - on errors reading, or on invalid data (java.io.IOException - 读取错误或无效数据)

registerListener

public void registerListener(POIFSReaderListener listener)

Register a POIFSReaderListener for all documents (为所有文档注册一个 POIFSReaderListener)

Parameters:

listener - the listener to be registered (listener - 要注册的侦听器)

Throws:

java.lang.NullPointerException - if listener is null (java.lang.NullPointerException - 如果监听器为空)

java.lang.IllegalStateException - if read() has already been called (java.lang.IllegalStateException - 如果 read() 已经被调用)

registerListener

public void registerListener(POIFSReaderListener listener,
                             java.lang.String name)

Register a POIFSReaderListener for a document in the root directory (为根目录中的文档注册一个 POIFSReaderListener)

Parameters:

listener - the listener to be registered (listener - 要注册的侦听器)

name - the document name (name - 文档名称)

Throws:

java.lang.NullPointerException - if listener is null or name is null or empty (java.lang.NullPointerException - 如果 listener 为 null 或 name 为 null 或为空)

java.lang.IllegalStateException - if read() has already been called (java.lang.IllegalStateException - 如果 read() 已经被调用)

registerListener

public void registerListener(POIFSReaderListener listener,
                             POIFSDocumentPath path,
                             java.lang.String name)

Register a POIFSReaderListener for a document in the specified directory (为指定目录中的文档注册 POIFSReaderListener)

Parameters:

listener - the listener to be registered (listener - 要注册的侦听器)

path - the document path; if null, the root directory is assumed (path - 文档路径；如果为 null，则假定为根目录)

name - the document name (name - 文档名称)

Throws:

java.lang.NullPointerException - if listener is null or name is null or empty (java.lang.NullPointerException - 如果 listener 为 null 或 name 为 null 或为空)

java.lang.IllegalStateException - if read() has already been called (java.lang.IllegalStateException - 如果 read() 已经被调用)

setNotifyEmptyDirectories

public void setNotifyEmptyDirectories(boolean notifyEmptyDirectories)

Activates the notification of empty directories.

If this flag is activated, the listener receives POIFSReaderEvents with nulled name and stream

(激活空目录的通知。如果激活此标志，侦听器将接收名称和流为空的 POIFSReaderEvents)

Parameters:

notifyEmptyDirectories - if true, empty directories will be notified (notifyEmptyDirectories - 如果为 true，将通知空目录)

main

public static void main(java.lang.String[] args)
                 throws java.io.IOException

read in files (读入文件)

Parameters:

args - names of the files (args - 文件名)

Throws:

java.io.IOException - if the files can't be read or have invalid content (java.io.IOException - 如果文件无法读取或内容无效)