The event API is newer than the Use

The event API is newer than the User API. It is intended for intermediate developers who are willing to learn a little bit of the low level API structures. Its relatively simple to use, but requires a basic understanding of the parts of an Excel file (or willingness to learn). The advantage provided is that you can read an XLS with a relatively small memory footprint.

One important thing to note with the basic Event API is that it triggers events only for things actually stored within the file. With the XLS file format, it is quite common for things that have yet to be edited to simply not exist in the file. This means there may well be apparent "gaps" in the record stream, which you either need to work around, or use the Record Aware extension to the Event API.

To use this API you construct an instance of org.apache.poi.hssf.eventmodel.HSSFRequest. Register a class you create that supports the org.apache.poi.hssf.eventmodel.HSSFListener interface using the HSSFRequest.addListener(yourlistener, recordsid). The recordsid should be a static reference number (such as BOFRecord.sid) contained in the classes in org.apache.poi.hssf.record. The trick is you have to know what these records are. Alternatively you can call HSSFRequest.addListenerForAllRecords(mylistener). In order to learn about these records you can either read all of the javadoc in the org.apache.poi.hssf.record package or you can just hack up a copy of org.apache.poi.hssf.dev.EFHSSF and adapt it to your needs. TODO: better documentation on records.

Once you've registered your listeners in the HSSFRequest object you can construct an instance of org.apache.poi.poifs.filesystem.FileSystem (see POIFS howto) and pass it your XLS file inputstream. You can either pass this, along with the request you constructed, to an instance of HSSFEventFactory via the HSSFEventFactory.processWorkbookEvents(request, Filesystem) method, or you can get an instance of DocumentInputStream from Filesystem.createDocumentInputStream("Workbook") and pass it to HSSFEventFactory.processEvents(request, inputStream). Once you make this call, the listeners that you constructed receive calls to their processRecord(Record) methods with each Record they are registered to listen for until the file has been completely read.

A code excerpt from org.apache.poi.hssf.dev.EFHSSF (which is in CVS or the source distribution) is reprinted below with excessive comments:

ผลลัพธ์ (ไทย) 1:

เหตุการณ์ API ใหม่กว่า API ผู้ใช้ได้ มีวัตถุประสงค์สำหรับนักพัฒนาระดับกลางที่ยินดีที่จะเรียนรู้โครงสร้าง API สูงเล็กน้อย มันค่อนข้างง่ายที่จะใช้ แต่ต้องเข้าใจพื้นฐานของส่วนประกอบต่าง ๆ ของ Excel แฟ้ม (หรือความตั้งใจในการเรียนรู้) ประโยชน์ให้คือ คุณสามารถอ่านการ XLS ด้วยรอยเท้าเล็กจำ

เรื่องสำคัญอย่างหนึ่งเพื่อทราบ ด้วย API เหตุการณ์พื้นฐานคือ ที่จะทริกเกอร์เหตุการณ์แต่สิ่งที่จริง เก็บไว้ในแฟ้ม ด้วยรูปแบบไฟล์ XLS ได้ค่อนข้างทั่วไปสำหรับสิ่งที่ยังไม่ได้แก้ไขก็ไม่มีอยู่ในแฟ้ม นี้หมายความ ดีไม่ปรากฏ "ช่องว่าง" ในบันทึกกระแสข้อมูล ที่คุณอาจต้องการทำงาน หรือใช้นามสกุลทราบบันทึกเหตุการณ์ API

ใช้ API นี้ คุณสร้างอินสแตนซ์ของ org.apache.poi.hssf.eventmodel.HSSFRequest ลงทะเบียนเรียนที่คุณสร้างที่สนับสนุนอินเทอร์เฟซสำหรับ org.apache.poi.hssf.eventmodel.HSSFListener ใช้ HSSFRequest.addListener (yourlistener, recordsid) Recordsid ควรเป็นตัวเลขอ้างอิงคงที่ (เช่น BOFRecordsid) ที่อยู่ในชั้นเรียนใน org.apache.poi.hssf.record เคล็ดลับคือ คุณต้องทราบว่าระเบียนเหล่านี้คืออะไร อีกวิธีหนึ่งคือ คุณสามารถโทร HSSFRequest.addListenerForAllRecords(mylistener) เพื่อเรียนรู้เกี่ยวกับเรกคอร์ดเหล่านี้คุณสามารถ อ่าน javadoc ในแพคเกจ org.apache.poi.hssf.record ทั้งหมด หรือคุณสามารถสับเพียงค่าสำเนาของ org.apache.poi.hssf.devEFHSSF และปรับให้เข้ากับความต้องการของคุณ TODO: ดีเอกสารบนระเบียน

เมื่อคุณได้ลงทะเบียนของคุณผู้ฟังในวัตถุ HSSFRequest คุณสามารถสร้างอินสแตนซ์ของ org.apache.poi.poifs.filesystem.FileSystem (ดู POIFS howto) และส่งต่อให้คุณ inputstream ไฟล์ XLS คุณสามารถอย่างใดอย่างหนึ่งส่งนี้ กับคำที่คุณสร้าง อินสแตนซ์ของ HSSFEventFactory ผ่าน HSSFEventFactoryprocessWorkbookEvents (ขอ ระบบแฟ้ม) วิธีการ หรือคุณสามารถรับอินสแตนซ์ของ DocumentInputStream จาก Filesystem.createDocumentInputStream("Workbook") และผ่านการ HSSFEventFactory.processEvents (ขอ inputStream) เมื่อคุณทำการเรียกนี้ ฟังที่คุณสร้างขึ้นได้รับการเรียกวิธีการ processRecord(Record) กับแต่ละระเบียนการลงทะเบียนให้ฟังจนกว่าแฟ้มได้อย่างสมบูรณ์แบบอ่าน

ตัดรหัสจาก org.apache.poi.hssf.dev.EFHSSF (ซึ่งอยู่ใน CVS หรือแหล่งกระจาย) จะ reprinted ด้านล่างกับความคิดเห็นมากเกินไป:

ผลลัพธ์ (ไทย) 2:

API เหตุการณ์ใหม่กว่า API ผู้ใช้ มันมีไว้สำหรับนักพัฒนาระดับกลางที่มีความเต็มใจที่จะเรียนรู้นิด ๆ หน่อย ๆ ของโครงสร้าง API ระดับต่ำ มันค่อนข้างง่ายที่จะใช้ แต่ต้องมีความเข้าใจพื้นฐานของส่วนของแฟ้ม (หรือความตั้งใจที่จะเรียนรู้) ข้อได้เปรียบที่มีให้คือการที่คุณสามารถอ่าน XLS มีรอยหน่วยความจำขนาดเล็กสิ่งหนึ่งที่สำคัญที่จะต้องทราบด้วย API กิจกรรมพื้นฐานที่จะเรียกเหตุการณ์ที่เกิดขึ้นเพียงเพื่อสิ่งที่ถูกจัดเก็บจริงภายในแฟ้ม ด้วยรูปแบบไฟล์ XLS มันค่อนข้างทั่วไปสำหรับสิ่งที่ยังไม่ได้รับการแก้ไขก็ไม่ได้อยู่ในแฟ้ม ซึ่งหมายความว่ามีดีอาจเป็น "ช่องว่าง" ที่ปรากฏอยู่ในกระแสการบันทึกซึ่งคุณอาจต้องหลีกเลี่ยงหรือใช้นามสกุล Aware Record เพื่อ API เหตุการณ์ในการใช้ API นี้คุณสร้างตัวอย่างของ org.apache.poi.hssf . eventmodel.HSSFRequest ลงทะเบียนเรียนให้คุณสร้างอินเตอร์เฟซที่รองรับการใช้ org.apache.poi.hssf.eventmodel.HSSFListener HSSFRequest.addListener (yourlistener, recordsid) recordsid ควรจะเป็นจำนวนคงที่อ้างอิง (เช่น BOFRecord.sid) ที่มีอยู่ในชั้นเรียนใน org.apache.poi.hssf.record เคล็ดลับคือการที่คุณต้องรู้ว่าสิ่งที่บันทึกเหล่านี้ หรือคุณสามารถโทร HSSFRequest.addListenerForAllRecords (mylistener) เพื่อที่จะเรียนรู้เกี่ยวกับข้อมูลเหล่านี้คุณสามารถอ่านทั้งหมดของ javadoc ในแพคเกจ org.apache.poi.hssf.record หรือคุณก็สามารถตัดสำเนาของ org.apache.poi.hssf.dev.EFHSSF และปรับตัวเข้ากับมัน ความต้องการของคุณ สิ่งที่ต้องทำ: เอกสารที่ดีขึ้นในการบันทึกเมื่อคุณได้ลงทะเบียนผู้ฟังของคุณในวัตถุ HSSFRequest คุณสามารถสร้างตัวอย่างของ org.apache.poi.poifs.filesystem.FileSystem (ดู POIFS HOWTO) และผ่านมัน InputStream ไฟล์ XLS ของคุณ คุณสามารถผ่านนี้พร้อมกับคำขอของคุณสร้างขึ้นเพื่อเป็นตัวอย่างของ HSSFEventFactory ผ่าน HSSFEventFactory.processWorkbookEvents (ขอระบบแฟ้ม) วิธีการหรือคุณจะได้รับตัวอย่างของ DocumentInputStream จาก Filesystem.createDocumentInputStream ("สมุด") และผ่านมัน การ HSSFEventFactory.processEvents (ขอ InputStream) เมื่อคุณโทรนี้ผู้ฟังที่คุณสร้างขึ้นได้รับการเรียกร้องให้ processRecord (Record) วิธีการของพวกเขาที่มีการบันทึกพวกเขาจะลงทะเบียนเพื่อฟังจนไฟล์ที่ได้รับอย่างสมบูรณ์อ่านแต่ละข้อความที่ตัดตอนมาจากรหัส org.apache.poi.hssf.dev . EFHSSF (ซึ่งเป็นใน CVS หรือการกระจายแหล่งที่มา) จะพิมพ์ซ้ำด้านล่างมีความคิดเห็นมากเกินไป:

ผลลัพธ์ (ไทย) 3:

เหตุการณ์ API ใหม่กว่าผู้ใช้ API มันมีไว้สำหรับนักพัฒนาระดับกลางที่เต็มใจที่จะเรียนรู้นิด ๆหน่อย ๆของโครงสร้างระดับต่ำ API มันค่อนข้างง่ายที่จะใช้ แต่ต้องมีความเข้าใจพื้นฐานของชิ้นส่วนของไฟล์ Excel ( หรือเต็มใจที่จะเรียนรู้ ) ประโยชน์ให้คุณสามารถอ่านไฟล์ XLS กับรอยหน่วยความจำขนาดเล็ก .

สิ่งหนึ่งที่สำคัญที่จะต้องทราบกับเหตุการณ์พื้นฐาน API ที่จะทริกเกอร์เหตุการณ์เฉพาะสำหรับสิ่งที่จริงเก็บไว้ภายในไฟล์ กับไฟล์ XLS รูปแบบ มันค่อนข้างทั่วไปสำหรับสิ่งต่างๆ ที่ยังต้องแก้ไข เพียงแค่ไม่ได้อยู่ในไฟล์ นี่หมายความว่ามันอาจจะปรากฏ " ช่องว่าง " ในบันทึกกระแส ซึ่งคุณอาจต้องทำงานอยู่หรือใช้บันทึกรับรู้การส่งเสริมเหตุการณ์ API

ใช้ API นี้จะสร้างอินสแตนซ์ของ org.apache.poi.hssf.eventmodel.hssfrequest . ลงทะเบียน เรียน คุณสร้างอินเตอร์เฟซที่รองรับ org.apache.poi.hssf.eventmodel.hssflistener ใช้ hssfrequest . addlistener ( yourlistener recordsid , ) การ recordsid ควรเป็นหมายเลขอ้างอิงแบบคงที่ ( เช่น bofrecord .ซิด ) ที่มีอยู่ในชั้นเรียนใน org.apache.poi.hssf.record . เคล็ดลับคือ คุณต้องรู้ว่าสิ่งที่บันทึกเหล่านี้ อีกวิธีหนึ่งคือ คุณสามารถเรียก hssfrequest . addlistenerforallrecords ( mylistener ) เพื่อที่จะเรียนรู้เกี่ยวกับประวัติเหล่านี้ คุณสามารถอ่านทั้งหมดของเอกสารจาวา ( Javadoc ) Language ใน org.apache.poi.hssf.record แพคเกจ หรือคุณสามารถสับขึ้นสำเนาของ org.apache.poi.hssf.dev .efhssf และปรับแก้ให้เข้ากับความต้องการของคุณ สิ่งที่ต้องทำ : เอกสารที่ดีในการบันทึก

เมื่อคุณได้ลงทะเบียนของคุณผู้ฟังในวัตถุ hssfrequest คุณสามารถสร้างอินสแตนซ์ของ org.apache.poi.poifs.filesystem.filesystem ( ดู poifs HOWTO ) และผ่านมันของคุณ นพุต รีม xls ไฟล์ คุณสามารถผ่านการทดสอบนี้ พร้อมกับขอให้คุณสร้างกับอินสแตนซ์ของ hssfeventfactory ผ่าน hssfeventfactory .processworkbookevents ( ขอวิธีหรือระบบแฟ้ม ) คุณจะได้รับตัวอย่างของ documentinputstream จากระบบแฟ้ม . createdocumentinputstream ( " สมุด " ) และผ่านการ hssfeventfactory . processevents ( ขอ นพุต รีม ) เมื่อคุณโทรนี้ผู้ฟังที่คุณสร้างขึ้นรับสายเพื่อ processrecord ( บันทึก ) วิธีการกับแต่ละระเบียน พวกเขาจะลงทะเบียนเพื่อฟังจนกว่าไฟล์ได้สมบูรณ์อ่าน

รหัสข้อความที่ตัดตอนมาจาก org.apache.poi.hssf.dev.efhssf ( ซึ่งอยู่ใน CVS หรือการกระจายแหล่งที่มา ) เป็นพิมพ์ด้านล่างที่มีความคิดเห็นมากเกินไป :