org.basex.io.serial

Class Serializer

java.lang.Object

org.basex.io.serial.Serializer

Direct Known Subclasses:

BuilderSerializer, OutputSerializer, SAXSerializer

public abstract class Serializer
extends java.lang.Object

This is an interface for serializing trees.

Author:

BaseX Team 2005-12, BSD License, Christian Gruen

Field Summary

Fields

Modifier and Type	Field and Description
protected int	level Current level.
static SerializerProp	PROPS Default serialization parameters.
protected byte[]	tag Current tag.
protected TokenList	tags Stack of opened tags.
protected boolean	undecl Declare namespaces flag.

Constructor Summary

Constructors

Constructor and Description
Serializer()

Method Summary

Methods

Modifier and Type	Method and Description
void	atomic(Item item) Serializes an atomic value.
abstract void	attribute(byte[] name, byte[] value) Serializes an attribute.
void	close() Closes the serializer.
void	closeElement() Closes an element.
void	closeResult() Closes a result.
void	comment(byte[] value) Serializes a comment.
void	emptyElement(byte[] name, byte[]... atts) Opens and closes an empty element.
void	emptyElement(ExprInfo expr, byte[]... atts) Opens and closes an empty element, adopting the expression name as element name.
protected abstract void	finishAtomic(Item i) Serializes an item.
protected abstract void	finishClose() Closes an element.
protected abstract void	finishComment(byte[] v) Serializes a comment.
boolean	finished() Tests if the serialization was interrupted.
protected abstract void	finishEmpty() Closes an empty element.
protected abstract void	finishOpen() Finishes an opening element node.
protected abstract void	finishPi(byte[] n, byte[] v) Serializes a processing instruction.
protected abstract void	finishText(byte[] v) Serializes a text.
static XMLSerializer	get(java.io.OutputStream os) Returns an XML serializer.
static Serializer	get(java.io.OutputStream os, SerializerProp props) Returns a specific serializer.
void	namespace(byte[] pref, byte[] uri) Serializes a namespace if it has not been serialized by an ancestor yet.
void	node(Data data, int pre) Serializes a node of the specified data reference.
void	node(Data data, int pre, FTPosData ft) Serializes a node of the specified data reference.
void	openElement(byte[] name, byte[]... atts) Opens an element.
void	openElement(ExprInfo expr, byte[]... atts) Opens an element, adopting the expression name as element name.
void	openResult() Starts a result.
void	pi(byte[] name, byte[] value) Serializes a processing instruction.
void	reset() Resets the serializer (indentation, etc).
protected abstract void	startOpen(byte[] n) Starts an element.
void	text(byte[] value) Serializes a text.

Methods inherited from class java.lang.Object

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

Field Detail

PROPS

public static final SerializerProp PROPS

Default serialization parameters.

tags

protected final TokenList tags

Stack of opened tags.

level

protected int level

Current level.

tag

protected byte[] tag

Current tag.

undecl

protected boolean undecl

Declare namespaces flag.

Constructor Detail

Serializer

public Serializer()

Method Detail

get

public static XMLSerializer get(java.io.OutputStream os)
                         throws java.io.IOException

Returns an XML serializer.

Parameters:

os - output stream reference

Returns:

serializer

Throws:

java.io.IOException - I/O exception

get

public static Serializer get(java.io.OutputStream os,
             SerializerProp props)
                      throws java.io.IOException

Returns a specific serializer.

Parameters:

os - output stream reference

props - serialization properties (can be null)

Returns:

serializer

Throws:

java.io.IOException - I/O exception

openElement

public final void openElement(byte[] name,
               byte[]... atts)
                       throws java.io.IOException

Opens an element.

Parameters:

name - tag name

atts - attributes

Throws:

java.io.IOException - I/O exception

closeElement

public final void closeElement()
                        throws java.io.IOException

Closes an element.

Throws:

java.io.IOException - I/O exception

emptyElement

public final void emptyElement(byte[] name,
                byte[]... atts)
                        throws java.io.IOException

Opens and closes an empty element.

Parameters:

name - tag name

atts - attributes

Throws:

java.io.IOException - I/O exception

text

public final void text(byte[] value)
                throws java.io.IOException

Serializes a text.

Parameters:

value - text bytes

Throws:

java.io.IOException - I/O exception

comment

public final void comment(byte[] value)
                   throws java.io.IOException

Serializes a comment.

Parameters:

value - value

Throws:

java.io.IOException - I/O exception

pi

public final void pi(byte[] name,
      byte[] value)
              throws java.io.IOException

Serializes a processing instruction.

Parameters:

name - name

value - value

Throws:

java.io.IOException - I/O exception

atomic

public final void atomic(Item item)
                  throws java.io.IOException

Serializes an atomic value. This method is used internally; call Item.serialize(org.basex.io.serial.Serializer) to serialize nodes.

Parameters:

item - text bytes

Throws:

java.io.IOException - I/O exception

node

public final void node(Data data,
        int pre)
                throws java.io.IOException

Serializes a node of the specified data reference.

Parameters:

data - data reference

pre - pre value to start from

Throws:

java.io.IOException - I/O exception

node

public final void node(Data data,
        int pre,
        FTPosData ft)
                throws java.io.IOException

Serializes a node of the specified data reference.

Parameters:

data - data reference

pre - pre value to start from

ft - full-text data

Throws:

java.io.IOException - I/O exception

openElement

public final void openElement(ExprInfo expr,
               byte[]... atts)
                       throws java.io.IOException

Opens an element, adopting the expression name as element name.

Parameters:

expr - expression info

atts - attributes

Throws:

java.io.IOException - I/O exception

emptyElement

public final void emptyElement(ExprInfo expr,
                byte[]... atts)
                        throws java.io.IOException

Opens and closes an empty element, adopting the expression name as element name.

Parameters:

expr - expression info

atts - attributes

Throws:

java.io.IOException - I/O exception

openResult

public void openResult()
                throws java.io.IOException

Starts a result.

Throws:

java.io.IOException - I/O exception

closeResult

public void closeResult()
                 throws java.io.IOException

Closes a result.

Throws:

java.io.IOException - I/O exception

close

public void close()
           throws java.io.IOException

Closes the serializer.

Throws:

java.io.IOException - I/O exception

namespace

public void namespace(byte[] pref,
             byte[] uri)
               throws java.io.IOException

Serializes a namespace if it has not been serialized by an ancestor yet.

Parameters:

pref - prefix

uri - URI

Throws:

java.io.IOException - I/O exception

finished

public boolean finished()

Tests if the serialization was interrupted.

Returns:

result of check

reset

public void reset()

Resets the serializer (indentation, etc).

attribute

public abstract void attribute(byte[] name,
             byte[] value)
                        throws java.io.IOException

Serializes an attribute.

Parameters:

name - name

value - value

Throws:

java.io.IOException - I/O exception

startOpen

protected abstract void startOpen(byte[] n)
                           throws java.io.IOException

Starts an element.

Parameters:

n - tag name

Throws:

java.io.IOException - I/O exception

finishOpen

protected abstract void finishOpen()
                            throws java.io.IOException

Finishes an opening element node.

Throws:

java.io.IOException - I/O exception

finishEmpty

protected abstract void finishEmpty()
                             throws java.io.IOException

Closes an empty element.

Throws:

java.io.IOException - I/O exception

finishClose

protected abstract void finishClose()
                             throws java.io.IOException

Closes an element.

Throws:

java.io.IOException - I/O exception

finishText

protected abstract void finishText(byte[] v)
                            throws java.io.IOException

Serializes a text.

Parameters:

v - value

Throws:

java.io.IOException - I/O exception

finishComment

protected abstract void finishComment(byte[] v)
                               throws java.io.IOException

Serializes a comment.

Parameters:

v - value

Throws:

java.io.IOException - I/O exception

finishPi

protected abstract void finishPi(byte[] n,
            byte[] v)
                          throws java.io.IOException

Serializes a processing instruction.

Parameters:

n - name

v - value

Throws:

java.io.IOException - I/O exception

finishAtomic

protected abstract void finishAtomic(Item i)
                              throws java.io.IOException

Serializes an item.

Parameters:

i - item

Throws:

java.io.IOException - I/O exception