Java Doc for RecordInputStream.java in  » Collaboration » poi-3.0.2-beta2 » org » apache » poi » hssf » record » 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.record 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   java.io.InputStream
      org.apache.poi.hssf.record.RecordInputStream

All known Subclasses:   org.apache.poi.hssf.record.TestcaseRecordInputStream,
RecordInputStream
public class RecordInputStream extends InputStream (Code)
Title: Record Input Stream

Description: Wraps a stream and provides helper methods for the construction of records.


author:
   Jason Height (jheight @ apache dot org)



Field Summary
final public static  shortMAX_RECORD_DATA_SIZE
    
 byte[]NAN_data
    
protected  shortcurrentLength
    
protected  shortcurrentSid
    
protected  byte[]data
    
protected  shortnextSid
    
protected  longpos
    
protected  shortrecordOffset
    

Constructor Summary
public  RecordInputStream(InputStream in)
    

Method Summary
protected  voidcheckRecordPosition()
    
public  booleangetAutoContinue()
    
public  shortgetLength()
    
public  byte[]getNANData()
    
public  longgetPos()
    
public  shortgetRecordOffset()
    
public  shortgetSid()
    
public  booleanhasNextRecord()
    
public  booleanisContinueNext()
    
public  voidnextRecord()
     Moves to the next record in the stream.
public  intread()
    
public  byte[]readAllContinuedRemainder()
     Reads all byte data for the current record, including any that overlaps into any following continue records.
public  bytereadByte()
    
public  StringreadCompressedUnicode(int length)
    
public  doublereadDouble()
    
public  intreadInt()
    
public  longreadLong()
    
public  byte[]readRemainder()
     Returns the remaining bytes for the current record.
public  shortreadShort()
    
public  short[]readShortArray()
    
public  intreadUShort()
    
public  StringreadUnicodeLEString(int length)
    
public  UnicodeStringreadUnicodeString()
     Returns an excel style unicode string from the bytes reminaing in the record.
public  intremaining()
     The remaining number of bytes in the current record.
public  voidsetAutoContinue(boolean enable)
    

Field Detail
MAX_RECORD_DATA_SIZE
final public static short MAX_RECORD_DATA_SIZE(Code)
Maximum size of a single record (minus the 4 byte header) without a continue



NAN_data
byte[] NAN_data(Code)



currentLength
protected short currentLength(Code)



currentSid
protected short currentSid(Code)



data
protected byte[] data(Code)



nextSid
protected short nextSid(Code)



pos
protected long pos(Code)



recordOffset
protected short recordOffset(Code)




Constructor Detail
RecordInputStream
public RecordInputStream(InputStream in) throws RecordFormatException(Code)




Method Detail
checkRecordPosition
protected void checkRecordPosition()(Code)



getAutoContinue
public boolean getAutoContinue()(Code)



getLength
public short getLength()(Code)



getNANData
public byte[] getNANData()(Code)



getPos
public long getPos()(Code)



getRecordOffset
public short getRecordOffset()(Code)



getSid
public short getSid()(Code)



hasNextRecord
public boolean hasNextRecord()(Code)



isContinueNext
public boolean isContinueNext()(Code)
Returns true iif a Continue record is next in the excel stream True when a ContinueRecord is next.



nextRecord
public void nextRecord() throws RecordFormatException(Code)
Moves to the next record in the stream. Note: The auto continue flag is reset to true



read
public int read() throws IOException(Code)
This method will read a byte from the current record



readAllContinuedRemainder
public byte[] readAllContinuedRemainder()(Code)
Reads all byte data for the current record, including any that overlaps into any following continue records.



readByte
public byte readByte()(Code)



readCompressedUnicode
public String readCompressedUnicode(int length)(Code)



readDouble
public double readDouble()(Code)



readInt
public int readInt()(Code)



readLong
public long readLong()(Code)



readRemainder
public byte[] readRemainder()(Code)
Returns the remaining bytes for the current record. The remaining bytes of the current record.



readShort
public short readShort()(Code)



readShortArray
public short[] readShortArray()(Code)



readUShort
public int readUShort()(Code)



readUnicodeLEString
public String readUnicodeLEString(int length)(Code)
given a byte array of 16-bit unicode characters, compress to 8-bit and return a string { 0x16, 0x00 } -0x16
Parameters:
  length - the length of the final string the converted string
exception:
  IllegalArgumentException - if len is too large (i.e.,there is not enough data in string to create a String of that length)



readUnicodeString
public UnicodeString readUnicodeString()(Code)
Returns an excel style unicode string from the bytes reminaing in the record. Note: Unicode strings differ from normal strings due to the addition of formatting information. The unicode string representation of the remaining bytes.



remaining
public int remaining()(Code)
The remaining number of bytes in the current record. The number of bytes remaining in the current record



setAutoContinue
public void setAutoContinue(boolean enable)(Code)



Methods inherited from java.io.InputStream
public int available() throws IOException(Code)(Java Doc)
public void close() throws IOException(Code)(Java Doc)
public synchronized void mark(int readlimit)(Code)(Java Doc)
public boolean markSupported()(Code)(Java Doc)
abstract public int read() throws IOException(Code)(Java Doc)
public int read(byte b) throws IOException(Code)(Java Doc)
public int read(byte b, int off, int len) throws IOException(Code)(Java Doc)
public synchronized void reset() throws IOException(Code)(Java Doc)
public long skip(long n) throws IOException(Code)(Java Doc)

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.