com.saxonica.ptree

Class PTreeWriter

java.lang.Object

com.saxonica.ptree.PTreeWriter

public class PTreeWriter
extends java.lang.Object

This class serializes a TinyTree to a binary file on disk, in a proprietary format designed for speed of loading back into a new TinyTree.

The format stored on disk is not dependent on the NamePool. Although it still uses name codes, it also contains a mapping of namecodes to the actual QNames.

The base URIs of nodes are not retained. Line numbers (if they were present in the original tree) are not retained.

Constructor Summary

Constructors

Constructor and Description
PTreeWriter(ProfessionalConfiguration config)

Method Summary

Modifier and Type	Method and Description
static void	copyToPTree(javax.xml.transform.Source in, ParseOptions options, java.io.OutputStream out) Static utility method for writing a Ptree
static void	main(java.lang.String[] args) Command line interface for writing a Ptree
void	setPTreeVersion(int version) Set the PTree version to be written.
void	writeTree(TinyTree tree, java.io.DataOutputStream out) Serialize a TinyTree in PTree format to a supplied output stream

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PTreeWriter

public PTreeWriter(ProfessionalConfiguration config)

Method Detail

setPTreeVersion

public void setPTreeVersion(int version)

Set the PTree version to be written.

• Version 0 was written by all releases prior to 9.9
• Version 1 was introduced in Saxon 9.9; it extends the format with textual element nodes.

Saxon 9.9 can read both version 0 and version 1, but always writes version 1, which cannot be read by earlier releases.

Parameters:

version - the version to be written. Must be 1.

writeTree

public void writeTree(TinyTree tree,
                      java.io.DataOutputStream out)
               throws java.io.IOException,
                      XPathException

Serialize a TinyTree in PTree format to a supplied output stream

Parameters:

tree - the tree to be serialized

out - the output stream. Responsibility for closing this stream rests with the caller

Throws:

java.io.IOException - if any error occurs writing to the output stream.

XPathException

copyToPTree

public static void copyToPTree(javax.xml.transform.Source in,
                               ParseOptions options,
                               java.io.OutputStream out)
                        throws XPathException,
                               java.io.IOException

Static utility method for writing a Ptree

Parameters:

in - the Source representing the document to be written as a PTree

options - the options to be used when processing the input source

out - the OutputStream to which the PTree is written. The responsibility for closing this stream rests with the caller.

Throws:

XPathException - if any failure occurs processing the input

java.io.IOException - if any failure occurs writing the output

Since:

9.3

main

public static void main(java.lang.String[] args)
                 throws java.lang.Exception

Command line interface for writing a Ptree

Parameters:

args - [-strip] source.xml out.tree

Throws:

java.lang.Exception - if the operation fails