Skip to main content

Notice: This Wiki is now read only and edits are no longer possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.

Jump to: navigation, search

Difference between revisions of "User:Rick.barkhouse.oracle.com/VTD"

(Removing all content from page)
 
(5 intermediate revisions by the same user not shown)
Line 1: Line 1:
=VTD-XML Investigation=
 
  
VTD-XML ([http://vtd-xml.sourceforge.net/ http://vtd-xml.sourceforge.net/]) is a high-performance XML processing model that deals with XML in a binary form, instead of the traditional text form.  VTD stands for '''V'''irtual '''T'''oken '''D'''escriptor.
 
 
VTD-XML parses an XML document and builds an internal data structure representing the entire XML document in <tt>byte[]</tt> form.  Each "token" of the XML document is represented as the following 64-bit integer:
 
 
[[Image:Vtd_layout.jpg]]
 
* Big endian
 
* Starting offset: 30 bits  (b29 ~ b0)  maximum value is 2^30 -1 = 1G -1
 
* Length: 20 bits (b51 ~ b32) maximum value is 2^20-1 = 1M -1
 
** For some token type
 
*** Prefix length: 9 bits (b51~ b43)  max value 511
 
*** Q-name length: 11 bits (b42 ~ b 32)  max value 1023
 
* Depth: 8 bits (b59~b52) max value is 2^8-1 = 255
 
* Token type: 4 bits (b63~b60)
 
* Reserved bit: 2 bits (b31: b30)
 
 
 
==VTD-XML Core Concepts==
 
 
 
===Generating a VTD-XML Representation of the XML Document (Unmarshal)===
 
 
Instantiate a new <tt>VTDGen</tt> object, and parse a <tt>byte[]</tt>:
 
 
<div style="width:900px">
 
<source lang="java">
 
VTDGen vg = new VTDGen();
 
 
// from existing byte[]
 
// could be either VTD-XML bytes, or bytes from a regular File, etc. (?)
 
// true indicates namespace aware
 
byte[] bytes = ...
 
vg.setDoc(bytes);
 
vg.parse(true);
 
 
// - or -
 
 
// from file
 
vg.parseFile("old.xml", false);
 
</source>
 
</div>
 
 
 
===Navigating a VTD-XML Document===
 
 
* <tt>VTDNav</tt>
 
** Obtained from <tt>VTDGen</tt> instance
 
** Allows for basic "walking" through elements
 
** Maintains a single cursor into the <tt>byte[]</tt> representation of XML
 
 
<div style="width:900px">
 
<source lang="java">
 
VTDGen vg = new VTDGen();
 
vg.parseFile("old.xml", false);
 
 
VTDNav vn = vg.getNav();
 
</source>
 
</div>
 
 
 
* <tt>AutoPilot</tt>
 
** Created from <tt>VTDNav</tt> instance
 
** Allows for XPath execution
 
** Allows for iterating over
 
 
<div style="width:900px">
 
<source lang="java">
 
VTDGen vg = new VTDGen();
 
vg.parseFile("old.xml", false);
 
 
VTDNav vn = vg.getNav();
 
</source>
 
</div>
 
 
 
===Writing a VTD-XML Document (Marshal)===
 
 
<div style="width:900px">
 
<source lang="java">
 
VTDGen vg = new VTDGen();
 
vg.parseFile("old.xml", false);
 
VTDNav vn = vg.getNav();
 
 
XMLModifier xm = new XMLModifier();
 
xm.bind(vn);
 
 
// ...
 
 
// Write to OutputStream
 
xm.output(new FileOutputStream("new.xml"));
 
</source>
 
</div>
 
 
 
===Generating a VTD-XML Index File for Faster Parsing===
 

Latest revision as of 15:47, 14 December 2012

Back to the top