FileDocCategorySizeDatePackage
HSSFRequest.javaAPI DocApache Poi 3.0.14976Mon Jan 01 12:39:36 GMT 2007org.apache.poi.hssf.eventusermodel

HSSFRequest

public class HSSFRequest extends Object
An HSSFRequest object should be constructed registering an instance or multiple instances of HSSFListener with each Record.sid you wish to listen for.
see
org.apache.poi.hssf.eventusermodel.HSSFEventFactory
see
org.apache.poi.hssf.eventusermodel.HSSFListener
see
org.apache.poi.hssf.dev.EFHSSF
see
org.apache.poi.hssf.eventusermodel.HSSFUserException
author
Andrew C. Oliver (acoliver at apache dot org)
author
Carey Sublette (careysub@earthling.net)

Fields Summary
private HashMap
records
Constructors Summary
public HSSFRequest()
Creates a new instance of HSSFRequest

        records =
            new HashMap(50);   // most folks won't listen for too many of these
Methods Summary
public voidaddListener(org.apache.poi.hssf.eventusermodel.HSSFListener lsnr, short sid)
add an event listener for a particular record type. The trick is you have to know what the records are for or just start with our examples and build on them. Alternatively, you CAN call addListenerForAllRecords and you'll recieve ALL record events in one listener, but if you like to squeeze every last byte of efficiency out of life you my not like this. (its sure as heck what I plan to do)

see
#addListenerForAllRecords(HSSFListener)
param
lsnr for the event
param
sid identifier for the record type this is the .sid static member on the individual records for example req.addListener(myListener, BOFRecord.sid)

        List   list = null;
        Object obj  = records.get(new Short(sid));

        if (obj != null)
        {
            list = ( List ) obj;
        }
        else
        {
            list = new ArrayList(
                1);   // probably most people will use one listener
            list.add(lsnr);
            records.put(new Short(sid), list);
        }
public voidaddListenerForAllRecords(org.apache.poi.hssf.eventusermodel.HSSFListener lsnr)
This is the equivilent of calling addListener(myListener, sid) for EVERY record in the org.apache.poi.hssf.record package. This is for lazy people like me. You can call this more than once with more than one listener, but that seems like a bad thing to do from a practice-perspective unless you have a compelling reason to do so (like maybe you send the event two places or log it or something?).

param
lsnr a single listener to associate with ALL records

        short[] rectypes = RecordFactory.getAllKnownRecordSIDs();

        for (int k = 0; k < rectypes.length; k++)
        {
            addListener(lsnr, rectypes[ k ]);
        }
protected shortprocessRecord(org.apache.poi.hssf.record.Record rec)
Called by HSSFEventFactory, passes the Record to each listener associated with a record.sid. Exception and return value added 2002-04-19 by Carey Sublette

return
numeric user-specified result code. If zero continue processing.
throws
HSSFUserException User exception condition

        Object obj = records.get(new Short(rec.getSid()));
        short userCode = 0;

        if (obj != null)
        {
            List listeners = ( List ) obj;

            for (int k = 0; k < listeners.size(); k++)
            {
                Object listenObj = listeners.get(k);
                if (listenObj instanceof AbortableHSSFListener)
                {
					AbortableHSSFListener listener = ( AbortableHSSFListener ) listenObj;
                	userCode = listener.abortableProcessRecord(rec);
                	if (userCode!=0) break;
				}
				else
				{ 
					HSSFListener listener = ( HSSFListener ) listenObj;
					listener.processRecord(rec);
				}
            }
        }
        return userCode;