org.apache.poi.hssf.eventusermodel
Class HSSFEventFactory
java.lang.Object
|
+--org.apache.poi.hssf.eventusermodel.HSSFEventFactory
- public class HSSFEventFactory
- extends java.lang.Object
Low level event based HSSF reader. Pass either a DocumentInputStream to
process events along with a request object or pass a POIFS POIFSFileSystem to
processWorkbookEvents along with a request.
This will cause your file to be processed a record at a time. Each record with
a static id matching one that you have registed in your HSSFRequest will be passed
to your associated HSSFListener.
- Author:
- Andrew C. Oliver (acoliver at apache dot org), Carey Sublette (careysub@earthling.net)
- See Also:
EFHSSF
Constructor Summary |
HSSFEventFactory()
Creates a new instance of HSSFEventFactory |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
HSSFEventFactory
public HSSFEventFactory()
- Creates a new instance of HSSFEventFactory
processWorkbookEvents
public void processWorkbookEvents(HSSFRequest req,
POIFSFileSystem fs)
throws java.io.IOException
- Processes a file into essentially record events.
- Parameters:
req
- an Instance of HSSFRequest which has your registered listenersfs
- a POIFS filesystem containing your workbook
abortableProcessWorkbookEvents
public short abortableProcessWorkbookEvents(HSSFRequest req,
POIFSFileSystem fs)
throws java.io.IOException,
HSSFUserException
- Processes a file into essentially record events.
- Parameters:
req
- an Instance of HSSFRequest which has your registered listenersfs
- a POIFS filesystem containing your workbook- Returns:
- numeric user-specified result code.
processEvents
public void processEvents(HSSFRequest req,
java.io.InputStream in)
throws java.io.IOException
- Processes a DocumentInputStream into essentially Record events.
If an
AbortableHSSFListener
causes a halt to processing during this call
the method will return just as with abortableProcessEvents
, but no
user code or HSSFUserException
will be passed back.
- Parameters:
req
- an Instance of HSSFRequest which has your registered listenersin
- a DocumentInputStream obtained from POIFS's POIFSFileSystem object- See Also:
POIFSFileSystem.createDocumentInputStream(String)
abortableProcessEvents
public short abortableProcessEvents(HSSFRequest req,
java.io.InputStream in)
throws java.io.IOException,
HSSFUserException
- Processes a DocumentInputStream into essentially Record events.
- Parameters:
req
- an Instance of HSSFRequest which has your registered listenersin
- a DocumentInputStream obtained from POIFS's POIFSFileSystem object- Returns:
- numeric user-specified result code.
- See Also:
POIFSFileSystem.createDocumentInputStream(String)
genericProcessEvents
protected short genericProcessEvents(HSSFRequest req,
java.io.InputStream in)
throws java.io.IOException,
HSSFUserException
- Processes a DocumentInputStream into essentially Record events.
- Parameters:
req
- an Instance of HSSFRequest which has your registered listenersin
- a DocumentInputStream obtained from POIFS's POIFSFileSystem objectin
- a DocumentInputStream obtained from POIFS's POIFSFileSystem object- Returns:
- numeric user-specified result code.
- See Also:
POIFSFileSystem.createDocumentInputStream(String)
Copyright © 2003 Apache jakarta-poi project. All Rights Reserved.