EXIficient

com.siemens.ct.exi
Interface EXIEncoder

All Known Implementing Classes:
AbstractEXIEncoder, EXIEncoderInOrder, EXIEncoderInOrderSC, EXIEncoderReordered

public interface EXIEncoder

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

Version:
0.4.20090414
Author:
Daniel.Peintner.EXT@siemens.com, Joerg.Heuer@siemens.com

Method Summary
 void encodeAttribute(java.lang.String uri, java.lang.String localName, java.lang.String prefix, java.lang.String value)
          Supplies an attribute.
 void encodeCharacters(java.lang.String chars)
          Supplies a comment as corresponding characters.
 void encodeComment(char[] ch, int start, int length)
          Supplies the text of a comment.
 void encodeDocType(java.lang.String name, java.lang.String publicID, java.lang.String systemID, java.lang.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(java.lang.String name)
          Supplies the name of an entity reference
 void encodeNamespaceDeclaration(java.lang.String uri, java.lang.String prefix)
          Namespaces are reported as a discrete Namespace event.
 void encodeProcessingInstruction(java.lang.String target, java.lang.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(java.lang.String uri, java.lang.String localName, java.lang.String prefix)
          Supplies the start of an element.
 void encodeXsiNil(java.lang.String val, java.lang.String pfx)
          Supplies an xsi:nil attribute.
 void encodeXsiType(java.lang.String xsiTypeRaw)
          Supplies an xsi:type case.
 void setErrorHandler(ErrorHandler errorHandler)
           
 void setOutput(java.io.OutputStream os, boolean exiBodyOnly)
           
 

Method Detail

setOutput

void setOutput(java.io.OutputStream os,
               boolean exiBodyOnly)
               throws EXIException
Throws:
EXIException

setErrorHandler

void setErrorHandler(ErrorHandler errorHandler)

encodeStartDocument

void encodeStartDocument()
                         throws EXIException,
                                java.io.IOException
Reports the beginning of a set of XML events

Throws:
EXIException
java.io.IOException

encodeEndDocument

void encodeEndDocument()
                       throws EXIException,
                              java.io.IOException
Reports the end of a set of XML events.

Throws:
EXIException
java.io.IOException

encodeStartElement

void encodeStartElement(java.lang.String uri,
                        java.lang.String localName,
                        java.lang.String prefix)
                        throws EXIException,
                               java.io.IOException
Supplies the start of an element.

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

Parameters:
uri -
localName -
prefix - (can be null according to fidelity options)
Throws:
EXIException
java.io.IOException

encodeEndElement

void encodeEndElement()
                      throws EXIException,
                             java.io.IOException
Supplies the end tag of an element.

Throws:
EXIException
java.io.IOException

encodeAttribute

void encodeAttribute(java.lang.String uri,
                     java.lang.String localName,
                     java.lang.String prefix,
                     java.lang.String value)
                     throws EXIException,
                            java.io.IOException
Supplies an attribute.

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

Parameters:
uri -
localName -
prefix - (can be null according to fidelity options)
value -
Throws:
EXIException
java.io.IOException

encodeNamespaceDeclaration

void encodeNamespaceDeclaration(java.lang.String uri,
                                java.lang.String prefix)
                                throws EXIException,
                                       java.io.IOException
Namespaces are reported as a discrete Namespace event.

Parameters:
uri -
prefix -
Throws:
EXIException
java.io.IOException

encodeXsiNil

void encodeXsiNil(java.lang.String val,
                  java.lang.String pfx)
                  throws EXIException,
                         java.io.IOException
Supplies an xsi:nil attribute.

Parameters:
val -
pfx -
Throws:
EXIException
java.io.IOException

encodeXsiType

void encodeXsiType(java.lang.String xsiTypeRaw)
                   throws EXIException,
                          java.io.IOException
Supplies an xsi:type case.

Parameters:
xsiTypeRaw - xsi:type value
Throws:
EXIException
java.io.IOException

encodeCharacters

void encodeCharacters(java.lang.String chars)
                      throws EXIException,
                             java.io.IOException
Supplies a comment as corresponding characters.

Note that ignorable whitespace and significant whitespace are also reported as Character events.

Parameters:
chars -
Throws:
EXIException
java.io.IOException

encodeDocType

void encodeDocType(java.lang.String name,
                   java.lang.String publicID,
                   java.lang.String systemID,
                   java.lang.String text)
                   throws EXIException,
                          java.io.IOException
Supplies content items to represent a DOCTYPE definition

Parameters:
name -
publicID -
systemID -
text -
Throws:
EXIException
java.io.IOException

encodeEntityReference

void encodeEntityReference(java.lang.String name)
                           throws EXIException,
                                  java.io.IOException
Supplies the name of an entity reference

Parameters:
name -
Throws:
EXIException
java.io.IOException

encodeComment

void encodeComment(char[] ch,
                   int start,
                   int length)
                   throws EXIException,
                          java.io.IOException
Supplies the text of a comment.

Parameters:
ch -
start -
length -
Throws:
EXIException
java.io.IOException

encodeProcessingInstruction

void encodeProcessingInstruction(java.lang.String target,
                                 java.lang.String data)
                                 throws EXIException,
                                        java.io.IOException
Supplies the target and data for an underlying processing instruction.

Parameters:
target -
data -
Throws:
EXIException
java.io.IOException

EXIficient