Java Doc for PieceTable.java in  » Web-Crawler » heritrix » org » archive » util » ms » 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 » Web Crawler » heritrix » org.archive.util.ms 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   org.archive.util.ms.PieceTable

PieceTable
class PieceTable (Code)
The piece table of a .doc file.

The piece table maps logical character positions of a document's text stream to actual file stream positions. The piece table is stored as two parallel arrays. The first array contains 32-bit integers representing the logical character positions. The second array contains 64-bit data structures that are mostly mysterious to me, except that they contain a 32-bit subfile offset. The second array is stored immediately after the first array. I call the first array the charPos array and the second array the filePos array.

The arrays are preceded by a special tag byte (2), followed by the combined size of both arrays in bytes. The number of piece table entries must be deduced from this byte size.

Because of this bizarre structure, caching piece table entries is something of a challenge. A single piece table entry is actually located in two different file locations. If there are many piece table entries, then the charPos and filePos information may be separated by many bytes, potentially crossing block boundaries. The approach I took was to use two different buffered streams. Up to n charPos offsets and n filePos structures can be buffered in the two streams, preventing any file seeking from occurring when looking up piece information. (File seeking must still occur to jump from one piece to the next.)

Note that the vast majority of .doc files in the world will have exactly 1 piece table entry, representing the complete text of the document. Only those documents that were "fast-saved" should have multiple pieces.

Finally, the text contained in a .doc file can either contain 16-bit unicode characters (charset UTF-16LE) or 8-bit CP1252 characters. One .doc file can contain both kinds of pieces. Whether or not a piece is Cp1252 is stored as a flag in the filePos value, bizarrely enough. If the flag is set, then the actual file position is the filePos with the flag cleared, then divided by 2.
author:
   pjack



Field Summary
final static  intCP1252_INDICATOR
     The bit that indicates if a piece uses Cp1252 or unicode.
final static  intCP1252_MASK
     The mask to use to clear the Cp1252 flag bit.
final static  LoggerLOGGER
    

Constructor Summary
public  PieceTable(SeekInputStream tableStream, int offset, int maxCharPos, int cachedRecords)
     Constructor.

Method Summary
public  intgetMaxCharPos()
     Returns the maximum character position.
public  Piecenext()
     Returns the next piece in the piece table.
public  PiecepieceFor(int charPos)
     Returns the piece containing the given character position.

Field Detail
CP1252_INDICATOR
final static int CP1252_INDICATOR(Code)
The bit that indicates if a piece uses Cp1252 or unicode.



CP1252_MASK
final static int CP1252_MASK(Code)
The mask to use to clear the Cp1252 flag bit.



LOGGER
final static Logger LOGGER(Code)




Constructor Detail
PieceTable
public PieceTable(SeekInputStream tableStream, int offset, int maxCharPos, int cachedRecords) throws IOException(Code)
Constructor.
Parameters:
  tableStream - the stream containing the piece table
Parameters:
  offset - the starting offset of the piece table
Parameters:
  maxCharPos - the total number of characters in the document
Parameters:
  cachedRecords - the number of piece table entries to cache
throws:
  IOException - if an IO error occurs




Method Detail
getMaxCharPos
public int getMaxCharPos()(Code)
Returns the maximum character position. Put another way, returns the total number of characters in the document. the maximum character position



next
public Piece next() throws IOException(Code)
Returns the next piece in the piece table. the next piece in the piece table, or null if there is no next piece
throws:
  IOException - if an IO error occurs



pieceFor
public Piece pieceFor(int charPos) throws IOException(Code)
Returns the piece containing the given character position.
Parameters:
  charPos - the character position whose piece to return that piece, or null if no such piece exists (if charPos is greater than getMaxCharPos())
throws:
  IOException - if an IO error occurs



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.