Java Doc for HSSFRequest.java in  » Collaboration » poi-3.0.2-beta2 » org » apache » poi » hssf » eventusermodel » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » Collaboration » poi 3.0.2 beta2 » org.apache.poi.hssf.eventusermodel 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   org.apache.poi.hssf.eventusermodel.HSSFRequest

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



Constructor Summary
public  HSSFRequest()
    

Method Summary
public  voidaddListener(HSSFListener lsnr, short sid)
     add an event listener for a particular record type.
public  voidaddListenerForAllRecords(HSSFListener lsnr)
     This is the equivilent of calling addListener(myListener, sid) for EVERY record in the org.apache.poi.hssf.record package.
protected  shortprocessRecord(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 numeric user-specified result code.


Constructor Detail
HSSFRequest
public HSSFRequest()(Code)
Creates a new instance of HSSFRequest




Method Detail
addListener
public void addListener(HSSFListener lsnr, short sid)(Code)
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 Also:   HSSFRequest.addListenerForAllRecords(HSSFListener)
Parameters:
  lsnr - for the event
Parameters:
  sid - identifier for the record type this is the .sid static member on the individual recordsfor example req.addListener(myListener, BOFRecord.sid)



addListenerForAllRecords
public void addListenerForAllRecords(HSSFListener lsnr)(Code)
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?).
Parameters:
  lsnr - a single listener to associate with ALL records



processRecord
protected short processRecord(Record rec) throws HSSFUserException(Code)
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 numeric user-specified result code. If zero continue processing.
throws:
  HSSFUserException - User exception condition



Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.