com.siemens.ct.exi.core

Interface EXIBodyEncoder

All Known Implementing Classes:

AbstractEXIBodyEncoder, EXIBodyEncoderInOrder, EXIBodyEncoderInOrderSC, EXIBodyEncoderReordered

public interface EXIBodyEncoder

Internal EXI Encoder interface to transform XML events to an EXI stream.

Author:

Daniel.Peintner.EXT@siemens.com, Richard.Kuntschke@siemens.com

Method Summary

Modifier and Type	Method and Description
void	encodeAttribute(QName at, Value value) Supplies an attribute with the according value.
void	encodeAttribute(String uri, String localName, String prefix, Value value) Supplies an attribute.
void	encodeAttributeList(AttributeList attributes) Supplies a list of namespace declarations, xsi:type and xsi:nil values and the remaining attributes.
void	encodeAttributeXsiNil(Value nil, String pfx) Supplies an xsi:nil attribute.
void	encodeAttributeXsiType(Value type, String pfx) Supplies an xsi:type case.
void	encodeCharacters(Value chars) Supplies characters as Value.
void	encodeComment(char[] ch, int start, int length) Supplies the text of a comment.
void	encodeDocType(String name, String publicID, String systemID, String text) Supplies content items to represent a DOCTYPE definition
void	encodeEndDocument() Reports the end of a set of XML events.
void	encodeEndElement() Supplies the end tag of an element.
void	encodeEntityReference(String name) Supplies the name of an entity reference
void	encodeNamespaceDeclaration(String uri, String prefix) Namespaces are reported as a discrete Namespace event.
void	encodeProcessingInstruction(String target, String data) Supplies the target and data for an underlying processing instruction.
void	encodeStartDocument() Reports the beginning of a set of XML events
void	encodeStartElement(QName se) Supplies the start of an element.
void	encodeStartElement(String uri, String localName, String prefix) Supplies the start of an element.
void	flush() Flushes (possibly) remaining bit(s) to output stream
void	setErrorHandler(ErrorHandler errorHandler)
void	setOutputChannel(EncoderChannel channel)
void	setOutputStream(OutputStream os)

Method Detail

setOutputStream

void setOutputStream(OutputStream os)
              throws EXIException,
                     IOException

Throws:

EXIException

IOException

setOutputChannel

void setOutputChannel(EncoderChannel channel)
               throws EXIException,
                      IOException

Throws:

EXIException

IOException

flush

void flush()
    throws IOException

Flushes (possibly) remaining bit(s) to output stream

Throws:

IOException - IO exception

setErrorHandler

void setErrorHandler(ErrorHandler errorHandler)

Parameters:

errorHandler - error handler

encodeStartDocument

void encodeStartDocument()
                  throws EXIException,
                         IOException

Reports the beginning of a set of XML events

Throws:

EXIException - EXI exception

IOException - IO exception

encodeEndDocument

void encodeEndDocument()
                throws EXIException,
                       IOException

Reports the end of a set of XML events.

Throws:

EXIException - EXI exception

IOException - IO exception

encodeStartElement

void encodeStartElement(String uri,
                        String localName,
                        String prefix)
                 throws EXIException,
                        IOException

Supplies the start of an element.

Provides access to the namespace URI, local name , and prefix representation of the start tag.

Parameters:

uri - element namespace URI

localName - element local-name

prefix - element prefix (can be null according to fidelity options)

Throws:

EXIException - EXI exception

IOException - IO exception

encodeStartElement

void encodeStartElement(QName se)
                 throws EXIException,
                        IOException

Supplies the start of an element.

Provides access to the namespace URI, local name , and prefix representation of the start tag.

Parameters:

se - start element's qname

Throws:

EXIException - EXI exception

IOException - IO exception

encodeEndElement

void encodeEndElement()
               throws EXIException,
                      IOException

Supplies the end tag of an element.

Throws:

EXIException - EXI exception

IOException - IO exception

encodeAttributeList

void encodeAttributeList(AttributeList attributes)
                  throws EXIException,
                         IOException

Supplies a list of namespace declarations, xsi:type and xsi:nil values and the remaining attributes.

Parameters:

attributes - list of attributes

Throws:

EXIException - EXI exception

IOException - IO exception

encodeAttribute

void encodeAttribute(String uri,
                     String localName,
                     String prefix,
                     Value value)
              throws EXIException,
                     IOException

Supplies an attribute.

Provides access to the namespace URI, local name, prefix, and value of the attribute.

Parameters:

uri - attribute namespace URI

localName - attribute local-name

prefix - attribute prefix (can be null according to fidelity options)

value - attribute value

Throws:

EXIException - EXI exception

IOException - IO exception

encodeAttribute

void encodeAttribute(QName at,
                     Value value)
              throws EXIException,
                     IOException

Supplies an attribute with the according value.

Provides access to the namespace URI, local name, prefix, and value of the attribute.

Parameters:

at - attribute's qname

value - attribute value

Throws:

EXIException - EXI exception

IOException - IO exception

encodeNamespaceDeclaration

void encodeNamespaceDeclaration(String uri,
                                String prefix)
                         throws EXIException,
                                IOException

Namespaces are reported as a discrete Namespace event.

Parameters:

uri - namespace URI

prefix - namespace prefix

Throws:

EXIException - EXI exception

IOException - IO exception

encodeAttributeXsiNil

void encodeAttributeXsiNil(Value nil,
                           String pfx)
                    throws EXIException,
                           IOException

Supplies an xsi:nil attribute.

Parameters:

nil - xsi:nil value

pfx - xsi:nil prefix

Throws:

EXIException - EXI exception

IOException - IO exception

encodeAttributeXsiType

void encodeAttributeXsiType(Value type,
                            String pfx)
                     throws EXIException,
                            IOException

Supplies an xsi:type case.

Parameters:

type - xsi:type value

pfx - xsi:type prefix

Throws:

EXIException - EXI exception

IOException - IO exception

encodeCharacters

void encodeCharacters(Value chars)
               throws EXIException,
                      IOException

Supplies characters as Value.

Parameters:

chars - character values

Throws:

EXIException - EXI exception

IOException - IO exception

encodeDocType

void encodeDocType(String name,
                   String publicID,
                   String systemID,
                   String text)
            throws EXIException,
                   IOException

Supplies content items to represent a DOCTYPE definition

Parameters:

name - doc-type name

publicID - doc-type publicID

systemID - doc-type systemID

text - doc-type test

Throws:

EXIException - EXI exception

IOException - IO exception

encodeEntityReference

void encodeEntityReference(String name)
                    throws EXIException,
                           IOException

Supplies the name of an entity reference

Parameters:

name - entity reference name

Throws:

EXIException - EXI exception

IOException - IO exception

encodeComment

void encodeComment(char[] ch,
                   int start,
                   int length)
            throws EXIException,
                   IOException

Supplies the text of a comment.

Parameters:

ch - comment character array

start - comment character array start

length - comment character array length

Throws:

EXIException - EXI exception

IOException - IO exception

encodeProcessingInstruction

void encodeProcessingInstruction(String target,
                                 String data)
                          throws EXIException,
                                 IOException

Supplies the target and data for an underlying processing instruction.

Parameters:

target - processing instruction target

data - processing instruction data

Throws:

EXIException - EXI exception

IOException - IO exception