Class AbstractXDBXWriterHandler

java.lang.Object

org.x4o.sax3.io.xdbx.AbstractXDBXWriterHandler

All Implemented Interfaces:

Closeable, AutoCloseable, ContentHandler

Direct Known Subclasses:

AbstractXDBXWriterLexical

public class AbstractXDBXWriterHandler
extends Object
implements ContentHandler, Closeable

Writes SAX content handler events as binary XML called XDBX.

Version:

1.0 Dec 19, 2024

Author:

Willem Cazander

Field Summary

Fields

Modifier and Type	Field	Description
static final SAX3PropertyConfig	DEFAULT_PROPERTY_CONFIG
static final String	OUTPUT_CHAR_NULL
static final String	OUTPUT_COMMENT_AUTO_SPACE
static final String	OUTPUT_COMMENT_ENABLE
static final String	OUTPUT_DECLARATION
static final String	PROLOG_LICENCE_ENABLE
static final String	PROLOG_LICENCE_ENCODING
static final String	PROLOG_LICENCE_FILE
static final String	PROLOG_LICENCE_RESOURCE
static final String	PROLOG_USER_COMMENT
static final String	PROLOG_USER_COMMENT_ENABLE
static final String	ROOT_START_NAMESPACE_ALL

Constructor Summary

Constructors

Constructor	Description
AbstractXDBXWriterHandler(OutputStream out)	Creates writer which prints to the stream interface.

Method Summary

Modifier and Type	Method	Description
void	characters(char c)
void	characters(char[] ch, int start, int length)	Prints xml characters and uses characters(java.lang.String) method.
void	characters(String text)	Escape and prints xml characters.
protected void	charactersRaw(String text)
void	close()
void	comment(char[] ch, int start, int length)	Prints xml comment.
void	comment(String text)	Prints xml comment.
void	endDocument()
void	endElement(String uri, String localName, String name)
void	endPrefixMapping(String prefix)
SAX3PropertyConfig	getPropertyConfig()
void	ignorableWhitespace(char c)	Prints xml ignorable whitespace character.
void	ignorableWhitespace(char[] ch, int start, int length)	Prints xml ignorable whitespace.
void	ignorableWhitespace(String text)	Prints xml ignorable whitespace.
void	processingInstruction(String target, String data)	Prints xml instructions.
void	setDocumentLocator(Locator locator)	Not implemented.
void	skippedEntity(String name)	Not implemented.
void	startDocument()
void	startElement(String uri, String localName, String name, Attributes atts)
void	startElementNamespace(String uri)
void	startElementNamespaceAll(String uri)
void	startElementTag(String uri, String localName, String name)
void	startPrefixMapping(String prefix, String uri)	Starts the prefix mapping of an xml namespace uri.
protected void	writeFlush()
void	writeHeaderFlags(OutputStream out, int flags)
protected void	writeLengthValue(byte[] data)
protected void	writeLengthValue(String data)
protected void	writeTag(XDBXContentTag tag)
protected void	writeTagLengthValue(XDBXContentTag tag, String data)
protected void	writeVariableInteger(int i)
protected boolean	xdbxStringId(String data)
protected int	xdbxStringStore(String data)

Methods inherited from class Object

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

Methods inherited from interface ContentHandler

declaration

Field Details

DEFAULT_PROPERTY_CONFIG

public static final SAX3PropertyConfig DEFAULT_PROPERTY_CONFIG

OUTPUT_DECLARATION

public static final String OUTPUT_DECLARATION

See Also:

• Constant Field Values

OUTPUT_CHAR_NULL

public static final String OUTPUT_CHAR_NULL

See Also:

• Constant Field Values

OUTPUT_COMMENT_ENABLE

public static final String OUTPUT_COMMENT_ENABLE

See Also:

• Constant Field Values

OUTPUT_COMMENT_AUTO_SPACE

public static final String OUTPUT_COMMENT_AUTO_SPACE

See Also:

• Constant Field Values

PROLOG_LICENCE_FILE

public static final String PROLOG_LICENCE_FILE

See Also:

• Constant Field Values

PROLOG_LICENCE_RESOURCE

public static final String PROLOG_LICENCE_RESOURCE

See Also:

• Constant Field Values

PROLOG_LICENCE_ENCODING

public static final String PROLOG_LICENCE_ENCODING

See Also:

• Constant Field Values

PROLOG_LICENCE_ENABLE

public static final String PROLOG_LICENCE_ENABLE

See Also:

• Constant Field Values

PROLOG_USER_COMMENT

public static final String PROLOG_USER_COMMENT

See Also:

• Constant Field Values

PROLOG_USER_COMMENT_ENABLE

public static final String PROLOG_USER_COMMENT_ENABLE

See Also:

• Constant Field Values

ROOT_START_NAMESPACE_ALL

public static final String ROOT_START_NAMESPACE_ALL

See Also:

• Constant Field Values

Constructor Details

AbstractXDBXWriterHandler

public AbstractXDBXWriterHandler(OutputStream out)

Creates writer which prints to the stream interface.

Parameters:

out - The stream to print the xml to.

Method Details

getPropertyConfig

public SAX3PropertyConfig getPropertyConfig()

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException

xdbxStringId

protected boolean xdbxStringId(String data)

xdbxStringStore

protected int xdbxStringStore(String data)

startDocument

public void startDocument()
                   throws SAXException

Specified by:

startDocument in interface ContentHandler

Throws:

SAXException

See Also:

• ContentHandler.startDocument()

endDocument

public void endDocument()
                 throws SAXException

Specified by:

endDocument in interface ContentHandler

Throws:

SAXException

See Also:

• ContentHandler.endDocument()

startElement

public void startElement(String uri,
 String localName,
 String name,
 Attributes atts)
                  throws SAXException

Specified by:

startElement in interface ContentHandler

Parameters:

uri - The xml namespace uri.

localName - The local name of the xml tag.

name - The (full) name of the xml tag.

atts - The attributes of the xml tag.

Throws:

SAXException

See Also:

• ContentHandler.startElement(java.lang.String, java.lang.String, java.lang.String, org.xml.sax.Attributes)

startElementTag

public void startElementTag(String uri,
 String localName,
 String name)
                     throws SAXException

Throws:

SAXException

startElementNamespace

public void startElementNamespace(String uri)
                           throws SAXException

Throws:

SAXException

startElementNamespaceAll

public void startElementNamespaceAll(String uri)
                              throws SAXException

Throws:

SAXException

endElement

public void endElement(String uri,
 String localName,
 String name)
                throws SAXException

Specified by:

endElement in interface ContentHandler

Parameters:

uri - The xml namespace uri.

localName - The local name of the xml tag.

name - The (full) name of the xml tag.

Throws:

SAXException

See Also:

• ContentHandler.endElement(java.lang.String, java.lang.String, java.lang.String)

startPrefixMapping

public void startPrefixMapping(String prefix,
 String uri)
                        throws SAXException

Starts the prefix mapping of an xml namespace uri.

Specified by:

startPrefixMapping in interface ContentHandler

Parameters:

prefix - The xml prefix of this xml namespace uri.

uri - The xml namespace uri to add the prefix for.

Throws:

SAXException

See Also:

• ContentHandler.startPrefixMapping(java.lang.String, java.lang.String)

endPrefixMapping

public void endPrefixMapping(String prefix)
                      throws SAXException

Specified by:

endPrefixMapping in interface ContentHandler

Parameters:

prefix - The xml prefix of this xml namespace uri to be ended.

Throws:

SAXException

See Also:

• ContentHandler.endPrefixMapping(java.lang.String)

characters

public void characters(char[] ch,
 int start,
 int length)
                throws SAXException

Prints xml characters and uses characters(java.lang.String) method.

Specified by:

characters in interface ContentHandler

Parameters:

ch - Character buffer.

start - The start index of the chars in the ch buffer.

length - The length index of the chars in the ch buffer.

Throws:

SAXException - When IOException has happend while printing.

See Also:

• ContentHandler.characters(char[], int, int)

characters

public void characters(String text)
                throws SAXException

Escape and prints xml characters.

Parameters:

text - The text to write.

Throws:

SAXException - When IOException has happend while printing.

See Also:

• ContentWriter.characters(java.lang.String)

characters

public void characters(char c)
                throws SAXException

Throws:

SAXException

charactersRaw

protected void charactersRaw(String text)
                      throws SAXException

Throws:

SAXException

ignorableWhitespace

public void ignorableWhitespace(char[] ch,
 int start,
 int length)
                         throws SAXException

Prints xml ignorable whitespace.

Specified by:

ignorableWhitespace in interface ContentHandler

Parameters:

ch - Character buffer.

start - The start index of the chars in the ch buffer.

length - The length index of the chars in the ch buffer.

Throws:

SAXException - When IOException has happend while printing.

See Also:

• ContentHandler.ignorableWhitespace(char[], int, int)

ignorableWhitespace

public void ignorableWhitespace(String text)
                         throws SAXException

Prints xml ignorable whitespace.

Parameters:

text - The text to print.

Throws:

SAXException - When IOException has happend while printing.

See Also:

• ContentWriter.ignorableWhitespace(java.lang.String)

ignorableWhitespace

public void ignorableWhitespace(char c)
                         throws SAXException

Prints xml ignorable whitespace character.

Parameters:

c - The character to print.

Throws:

SAXException - When IOException has happend while printing.

processingInstruction

public void processingInstruction(String target,
 String data)
                           throws SAXException

Prints xml instructions.

Specified by:

processingInstruction in interface ContentHandler

Parameters:

target - The target.

data - The data.

Throws:

SAXException

See Also:

• ContentHandler.processingInstruction(java.lang.String, java.lang.String)

setDocumentLocator

public void setDocumentLocator(Locator locator)

Not implemented.

Specified by:

setDocumentLocator in interface ContentHandler

Parameters:

locator - The DocumentLocator to set.

See Also:

• ContentHandler.setDocumentLocator(org.xml.sax.Locator)

skippedEntity

public void skippedEntity(String name)
                   throws SAXException

Not implemented.

Specified by:

skippedEntity in interface ContentHandler

Parameters:

name - The name of the skipped entity.

Throws:

SAXException

See Also:

• ContentHandler.skippedEntity(java.lang.String)

comment

public void comment(char[] ch,
 int start,
 int length)
             throws SAXException

Prints xml comment.

Parameters:

ch - Character buffer.

start - The start index of the chars in the ch buffer.

length - The length index of the chars in the ch buffer.

Throws:

SAXException - When IOException has happend while printing.

See Also:

• DefaultHandler2.comment(char[], int, int)

comment

public void comment(String text)
             throws SAXException

Prints xml comment.

Parameters:

text - The text to write.

Throws:

SAXException - When IOException has happend while printing.

See Also:

• ContentWriter.comment(java.lang.String)

writeFlush

protected void writeFlush()
                   throws SAXException

Throws:

SAXException

writeHeaderFlags

public void writeHeaderFlags(OutputStream out,
 int flags)
                      throws SAXException

Throws:

SAXException

writeTag

protected void writeTag(XDBXContentTag tag)
                 throws SAXException

Throws:

SAXException

writeTagLengthValue

protected void writeTagLengthValue(XDBXContentTag tag,
 String data)
                            throws SAXException

Throws:

SAXException

writeVariableInteger

protected void writeVariableInteger(int i)
                             throws SAXException

Throws:

SAXException

writeLengthValue

protected void writeLengthValue(byte[] data)
                         throws SAXException

Throws:

SAXException

writeLengthValue

protected void writeLengthValue(String data)
                         throws SAXException

Throws:

SAXException