Package loci.poi.hssf.eventusermodel
Class HSSFEventFactory
- java.lang.Object
-
- loci.poi.hssf.eventusermodel.HSSFEventFactory
-
public class HSSFEventFactory extends 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:
loci.poi.hssf.dev.EFHSSF
-
-
Constructor Summary
Constructors Constructor Description HSSFEventFactory()
Creates a new instance of HSSFEventFactory
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description short
abortableProcessEvents(HSSFRequest req, InputStream in)
Processes a DocumentInputStream into essentially Record events.short
abortableProcessWorkbookEvents(HSSFRequest req, POIFSFileSystem fs)
Processes a file into essentially record events.protected short
genericProcessEvents(HSSFRequest req, RecordInputStream in)
Processes a DocumentInputStream into essentially Record events.void
processEvents(HSSFRequest req, InputStream in)
Processes a DocumentInputStream into essentially Record events.void
processWorkbookEvents(HSSFRequest req, POIFSFileSystem fs)
Processes a file into essentially record events.
-
-
-
Method Detail
-
processWorkbookEvents
public void processWorkbookEvents(HSSFRequest req, POIFSFileSystem fs) throws 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- Throws:
IOException
-
abortableProcessWorkbookEvents
public short abortableProcessWorkbookEvents(HSSFRequest req, POIFSFileSystem fs) throws 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.
- Throws:
IOException
HSSFUserException
-
processEvents
public void processEvents(HSSFRequest req, InputStream in) throws IOException
Processes a DocumentInputStream into essentially Record events. If anAbortableHSSFListener
causes a halt to processing during this call the method will return just as withabortableProcessEvents
, but no user code orHSSFUserException
will be passed back.- Parameters:
req
- an Instance of HSSFRequest which has your registered listenersin
- a DocumentInputStream obtained from POIFS's POIFSFileSystem object- Throws:
IOException
- See Also:
POIFSFileSystem.createDocumentInputStream(String)
-
abortableProcessEvents
public short abortableProcessEvents(HSSFRequest req, InputStream in) throws 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.
- Throws:
IOException
HSSFUserException
- See Also:
POIFSFileSystem.createDocumentInputStream(String)
-
genericProcessEvents
protected short genericProcessEvents(HSSFRequest req, RecordInputStream in) throws 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.
- Throws:
IOException
HSSFUserException
- See Also:
POIFSFileSystem.createDocumentInputStream(String)
-
-