loci.poi.poifs.eventfilesystem

Class POIFSReader

java.lang.Object

loci.poi.poifs.eventfilesystem.POIFSReader

public class POIFSReader
extends 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.

Author:

Marc Johnson (mjohnson at apache dot org)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	POIFSReader.SampleListener

Field Summary

Fields

Modifier and Type	Field and Description
private int	bigBlockSize
private POIFSReaderRegistry	registry
private boolean	registryClosed
private RandomAccessInputStream	stream

Constructor Summary

Constructors

Constructor and Description
POIFSReader() Create a POIFSReader

Method Summary

Methods

Modifier and Type	Method and Description
static void	main(String[] args) read in files
private void	processProperties(BlockList small_blocks, BlockList big_blocks, Iterator properties, POIFSDocumentPath path)
void	read(RandomAccessInputStream stream, int size) Read from an InputStream and process the documents we get
void	registerListener(POIFSReaderListener listener) Register a POIFSReaderListener for all documents
void	registerListener(POIFSReaderListener listener, POIFSDocumentPath path, String name) Register a POIFSReaderListener for a document in the specified directory
void	registerListener(POIFSReaderListener listener, String name) Register a POIFSReaderListener for a document in the root directory

Methods inherited from class java.lang.Object

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

Field Detail

registry

private POIFSReaderRegistry registry

registryClosed

private boolean registryClosed

bigBlockSize

private int bigBlockSize

stream

private RandomAccessInputStream stream

Constructor Detail

POIFSReader

public POIFSReader()

Create a POIFSReader

Method Detail

read

public void read(RandomAccessInputStream stream,
        int size)
          throws IOException

Read from an InputStream and process the documents we get

Parameters:

stream - the InputStream from which to read the data

Throws:

IOException - on errors reading, or on invalid data

registerListener

public void registerListener(POIFSReaderListener listener)

Register a POIFSReaderListener for all documents

Parameters:

listener - the listener to be registered

Throws:

NullPointerException - if listener is null

IllegalStateException - if read() has already been called

registerListener

public void registerListener(POIFSReaderListener listener,
                    String name)

Register a POIFSReaderListener for a document in the root directory

Parameters:

listener - the listener to be registered

name - the document name

Throws:

NullPointerException - if listener is null or name is null or empty

IllegalStateException - if read() has already been called

registerListener

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

Register a POIFSReaderListener for a document in the specified directory

Parameters:

listener - the listener to be registered

path - the document path; if null, the root directory is assumed

name - the document name

Throws:

NullPointerException - if listener is null or name is null or empty

IllegalStateException - if read() has already been called

main

public static void main(String[] args)
                 throws IOException

read in files

Parameters:

args - names of the files

Throws:

IOException

processProperties

private void processProperties(BlockList small_blocks,
                     BlockList big_blocks,
                     Iterator properties,
                     POIFSDocumentPath path)
                        throws IOException

Throws:

IOException