EXIficient

com.siemens.ct.exi.core
Class AbstractEXIEncoder

java.lang.Object
  extended by com.siemens.ct.exi.core.AbstractEXICoder
      extended by com.siemens.ct.exi.core.AbstractEXIEncoder
All Implemented Interfaces:
EXIEncoder
Direct Known Subclasses:
EXIEncoderInOrder, EXIEncoderReordered

public abstract class AbstractEXIEncoder
extends AbstractEXICoder
implements EXIEncoder


Field Summary
 
Fields inherited from class com.siemens.ct.exi.core.AbstractEXICoder
INITIAL_STACK_SIZE
 
Constructor Summary
AbstractEXIEncoder(EXIFactory exiFactory)
           
 
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 value, java.lang.String pfx)
          Supplies an xsi:nil attribute.
 void encodeXsiType(java.lang.String raw)
          Supplies an xsi:type case.
 void setOutput(java.io.OutputStream os, boolean exiBodyOnly)
           
 
Methods inherited from class com.siemens.ct.exi.core.AbstractEXICoder
getNamespaces, setErrorHandler
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.siemens.ct.exi.EXIEncoder
setErrorHandler
 

Constructor Detail

AbstractEXIEncoder

public AbstractEXIEncoder(EXIFactory exiFactory)
Method Detail

setOutput

public void setOutput(java.io.OutputStream os,
                      boolean exiBodyOnly)
               throws EXIException
Specified by:
setOutput in interface EXIEncoder
Throws:
EXIException

encodeStartDocument

public void encodeStartDocument()
                         throws EXIException,
                                java.io.IOException
Description copied from interface: EXIEncoder
Reports the beginning of a set of XML events

Specified by:
encodeStartDocument in interface EXIEncoder
Throws:
EXIException
java.io.IOException

encodeEndDocument

public void encodeEndDocument()
                       throws EXIException,
                              java.io.IOException
Description copied from interface: EXIEncoder
Reports the end of a set of XML events.

Specified by:
encodeEndDocument in interface EXIEncoder
Throws:
EXIException
java.io.IOException

encodeStartElement

public void encodeStartElement(java.lang.String uri,
                               java.lang.String localName,
                               java.lang.String prefix)
                        throws EXIException,
                               java.io.IOException
Description copied from interface: EXIEncoder
Supplies the start of an element.

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

Specified by:
encodeStartElement in interface EXIEncoder
prefix - (can be null according to fidelity options)
Throws:
EXIException
java.io.IOException

encodeNamespaceDeclaration

public void encodeNamespaceDeclaration(java.lang.String uri,
                                       java.lang.String prefix)
                                throws EXIException,
                                       java.io.IOException
Description copied from interface: EXIEncoder
Namespaces are reported as a discrete Namespace event.

Specified by:
encodeNamespaceDeclaration in interface EXIEncoder
Throws:
EXIException
java.io.IOException

encodeEndElement

public void encodeEndElement()
                      throws EXIException,
                             java.io.IOException
Description copied from interface: EXIEncoder
Supplies the end tag of an element.

Specified by:
encodeEndElement in interface EXIEncoder
Throws:
EXIException
java.io.IOException

encodeXsiType

public void encodeXsiType(java.lang.String raw)
                   throws EXIException,
                          java.io.IOException
Description copied from interface: EXIEncoder
Supplies an xsi:type case.

Specified by:
encodeXsiType in interface EXIEncoder
Parameters:
raw - xsi:type value
Throws:
EXIException
java.io.IOException

encodeXsiNil

public void encodeXsiNil(java.lang.String value,
                         java.lang.String pfx)
                  throws EXIException,
                         java.io.IOException
Description copied from interface: EXIEncoder
Supplies an xsi:nil attribute.

Specified by:
encodeXsiNil in interface EXIEncoder
Throws:
EXIException
java.io.IOException

encodeAttribute

public void encodeAttribute(java.lang.String uri,
                            java.lang.String localName,
                            java.lang.String prefix,
                            java.lang.String value)
                     throws EXIException,
                            java.io.IOException
Description copied from interface: EXIEncoder
Supplies an attribute.

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

Specified by:
encodeAttribute in interface EXIEncoder
prefix - (can be null according to fidelity options)
Throws:
EXIException
java.io.IOException

encodeCharacters

public void encodeCharacters(java.lang.String chars)
                      throws EXIException,
                             java.io.IOException
Description copied from interface: EXIEncoder
Supplies a comment as corresponding characters.

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

Specified by:
encodeCharacters in interface EXIEncoder
Throws:
EXIException
java.io.IOException

encodeDocType

public void encodeDocType(java.lang.String name,
                          java.lang.String publicID,
                          java.lang.String systemID,
                          java.lang.String text)
                   throws EXIException,
                          java.io.IOException
Description copied from interface: EXIEncoder
Supplies content items to represent a DOCTYPE definition

Specified by:
encodeDocType in interface EXIEncoder
Throws:
EXIException
java.io.IOException

encodeEntityReference

public void encodeEntityReference(java.lang.String name)
                           throws EXIException,
                                  java.io.IOException
Description copied from interface: EXIEncoder
Supplies the name of an entity reference

Specified by:
encodeEntityReference in interface EXIEncoder
Throws:
EXIException
java.io.IOException

encodeComment

public void encodeComment(char[] ch,
                          int start,
                          int length)
                   throws EXIException,
                          java.io.IOException
Description copied from interface: EXIEncoder
Supplies the text of a comment.

Specified by:
encodeComment in interface EXIEncoder
Throws:
EXIException
java.io.IOException

encodeProcessingInstruction

public void encodeProcessingInstruction(java.lang.String target,
                                        java.lang.String data)
                                 throws EXIException,
                                        java.io.IOException
Description copied from interface: EXIEncoder
Supplies the target and data for an underlying processing instruction.

Specified by:
encodeProcessingInstruction in interface EXIEncoder
Throws:
EXIException
java.io.IOException

EXIficient