com.siemens.ct.exi.core.coder

Class EXIBodyEncoderInOrderSC

java.lang.Object

com.siemens.ct.exi.core.coder.AbstractEXIBodyCoder

com.siemens.ct.exi.core.coder.AbstractEXIBodyEncoder

com.siemens.ct.exi.core.coder.EXIBodyEncoderInOrder

com.siemens.ct.exi.core.coder.EXIBodyEncoderInOrderSC

All Implemented Interfaces:

EXIBodyEncoder

public class EXIBodyEncoderInOrderSC
extends EXIBodyEncoderInOrder

EXI encoder for bit or byte-aligned streams and possible SELF_CONTAINED elements.

All productions of the form LeftHandSide : SC Fragment are evaluated as follows:

1. Save the string table, grammars and any implementation-specific state learned while processing this EXI Body.
2. Initialize the string table, grammars and any implementation-specific state learned while processing this EXI Body to the state they held just prior to processing this EXI Body.
3. Skip to the next byte-aligned boundary in the stream if it is not already at such a boundary.
4. Let qname be the qname of the SE event immediately preceding this SC event.
5. Let content be the sequence of events following this SC event that match the grammar for element qname, up to and including the terminating EE event.
6. Evaluate the sequence of events (SD, SE(qname), content, ED) according to the Fragment grammar.
7. Skip to the next byte-aligned boundary in the stream if it is not already at such a boundary.
8. Restore the string table, grammars and implementation-specific state learned while processing this EXI Body to that saved in step 1 above.

Author:

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

Nested Class Summary

Nested classes/interfaces inherited from class com.siemens.ct.exi.core.coder.AbstractEXIBodyCoder

AbstractEXIBodyCoder.ElementContext, AbstractEXIBodyCoder.RuntimeUriContext

Field Summary

Fields

Modifier and Type	Field and Description
protected EXIBodyEncoderInOrderSC	scEncoder

Fields inherited from class com.siemens.ct.exi.core.coder.AbstractEXIBodyEncoder

bChars, channel, encodingOptions, exiHeader, isXmlSpacePreserve, lastEvent, sePrefix, seUri, stringEncoder, typeEncoder

Fields inherited from class com.siemens.ct.exi.core.coder.AbstractEXIBodyCoder

booleanDatatype, elementContextStack, elementContextStackIndex, errorHandler, exiFactory, fidelityOptions, grammar, grammarContext, gUris, INITIAL_STACK_SIZE, learnedProductions, limitGrammarLearning, maxBuiltInElementGrammars, maxBuiltInProductions, nextUriID, preserveLexicalValues, preservePrefix, runtimeGlobalElements, xsiNilContext, xsiTypeContext

Constructor Summary

Constructors

Constructor and Description
EXIBodyEncoderInOrderSC(EXIFactory exiFactory)

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	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.
protected void	encodeEndSC()
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(String uri, String localName, String prefix) Supplies the start of an element.
protected void	encodeStartElementNoSC(String uri, String localName, String prefix)
protected void	encodeStartSC(String uri, String localName, String prefix)
void	initForEachRun()
void	setErrorHandler(ErrorHandler errorHandler)

Methods inherited from class com.siemens.ct.exi.core.coder.EXIBodyEncoderInOrder

setOutputChannel, setOutputStream, writeValue

Methods inherited from class com.siemens.ct.exi.core.coder.AbstractEXIBodyEncoder

checkPendingCharacters, encode1stLevelEventCode, encode2ndLevelEventCode, encode3rdLevelEventCode, encodeAttributeList, encodeCharactersForce, encodeLocalName, encodeNamespacePrefix, encodeQName, encodeQNamePrefix, encodeSchemaInvalidAttributeEventCode, encodeStartElement, encodeUri, flush, getGlobalAttribute, getGlobalAttribute, isTypeValid, writeString

Methods inherited from class com.siemens.ct.exi.core.coder.AbstractEXIBodyCoder

addUri, declarePrefix, declarePrefix, getCurrentGrammar, getElementContext, getGlobalStartElement, getNumberOfUris, getPrefix, getUri, getUri, getURI, getXsiNilContext, getXsiTypeContext, isBuiltInStartTagGrammarWithAtXsiTypeOnly, popElement, pushElement, throwWarning, updateCurrentRule, updateElementContext

Methods inherited from class java.lang.Object

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

Field Detail

scEncoder

protected EXIBodyEncoderInOrderSC scEncoder

Constructor Detail

EXIBodyEncoderInOrderSC

public EXIBodyEncoderInOrderSC(EXIFactory exiFactory)
                        throws EXIException

Throws:

EXIException

Method Detail

initForEachRun

public void initForEachRun()
                    throws EXIException,
                           IOException

Overrides:

initForEachRun in class AbstractEXIBodyEncoder

Throws:

EXIException

IOException

setErrorHandler

public void setErrorHandler(ErrorHandler errorHandler)

Specified by:

setErrorHandler in interface EXIBodyEncoder

Overrides:

setErrorHandler in class AbstractEXIBodyCoder

Parameters:

errorHandler - error handler

encodeStartDocument

public void encodeStartDocument()
                         throws EXIException,
                                IOException

Description copied from interface: EXIBodyEncoder

Reports the beginning of a set of XML events

Specified by:

encodeStartDocument in interface EXIBodyEncoder

Overrides:

encodeStartDocument in class AbstractEXIBodyEncoder

Throws:

EXIException - EXI exception

IOException - IO exception

encodeEndDocument

public void encodeEndDocument()
                       throws EXIException,
                              IOException

Description copied from interface: EXIBodyEncoder

Reports the end of a set of XML events.

Specified by:

encodeEndDocument in interface EXIBodyEncoder

Overrides:

encodeEndDocument in class AbstractEXIBodyEncoder

Throws:

EXIException - EXI exception

IOException - IO exception

encodeEndSC

protected void encodeEndSC()
                    throws EXIException,
                           IOException

Throws:

EXIException

IOException

encodeStartElement

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

Description copied from interface: EXIBodyEncoder

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 EXIBodyEncoder

Overrides:

encodeStartElement in class AbstractEXIBodyEncoder

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

encodeStartSC

protected void encodeStartSC(String uri,
                             String localName,
                             String prefix)
                      throws EXIException,
                             IOException

Throws:

EXIException

IOException

encodeStartElementNoSC

protected void encodeStartElementNoSC(String uri,
                                      String localName,
                                      String prefix)
                               throws EXIException,
                                      IOException

Throws:

EXIException

IOException

encodeEndElement

public void encodeEndElement()
                      throws EXIException,
                             IOException

Description copied from interface: EXIBodyEncoder

Supplies the end tag of an element.

Specified by:

encodeEndElement in interface EXIBodyEncoder

Overrides:

encodeEndElement in class AbstractEXIBodyEncoder

Throws:

EXIException - EXI exception

IOException - IO exception

encodeAttribute

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

Description copied from interface: EXIBodyEncoder

Supplies an attribute.

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

Specified by:

encodeAttribute in interface EXIBodyEncoder

Overrides:

encodeAttribute in class AbstractEXIBodyEncoder

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

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

Description copied from interface: EXIBodyEncoder

Supplies an attribute with the according value.

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

Specified by:

encodeAttribute in interface EXIBodyEncoder

Overrides:

encodeAttribute in class AbstractEXIBodyEncoder

Parameters:

at - attribute's qname

value - attribute value

Throws:

EXIException - EXI exception

IOException - IO exception

encodeNamespaceDeclaration

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

Description copied from interface: EXIBodyEncoder

Namespaces are reported as a discrete Namespace event.

Specified by:

encodeNamespaceDeclaration in interface EXIBodyEncoder

Overrides:

encodeNamespaceDeclaration in class AbstractEXIBodyEncoder

Parameters:

uri - namespace URI

prefix - namespace prefix

Throws:

EXIException - EXI exception

IOException - IO exception

encodeAttributeXsiNil

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

Description copied from interface: EXIBodyEncoder

Supplies an xsi:nil attribute.

Specified by:

encodeAttributeXsiNil in interface EXIBodyEncoder

Overrides:

encodeAttributeXsiNil in class AbstractEXIBodyEncoder

Parameters:

nil - xsi:nil value

pfx - xsi:nil prefix

Throws:

EXIException - EXI exception

IOException - IO exception

encodeAttributeXsiType

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

Description copied from interface: EXIBodyEncoder

Supplies an xsi:type case.

Specified by:

encodeAttributeXsiType in interface EXIBodyEncoder

Overrides:

encodeAttributeXsiType in class AbstractEXIBodyEncoder

Parameters:

type - xsi:type value

pfx - xsi:type prefix

Throws:

EXIException - EXI exception

IOException - IO exception

encodeCharacters

public void encodeCharacters(Value chars)
                      throws EXIException,
                             IOException

Description copied from interface: EXIBodyEncoder

Supplies characters as Value.

Specified by:

encodeCharacters in interface EXIBodyEncoder

Overrides:

encodeCharacters in class AbstractEXIBodyEncoder

Parameters:

chars - character values

Throws:

EXIException - EXI exception

IOException - IO exception

encodeDocType

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

Description copied from interface: EXIBodyEncoder

Supplies content items to represent a DOCTYPE definition

Specified by:

encodeDocType in interface EXIBodyEncoder

Overrides:

encodeDocType in class AbstractEXIBodyEncoder

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

public void encodeEntityReference(String name)
                           throws EXIException,
                                  IOException

Description copied from interface: EXIBodyEncoder

Supplies the name of an entity reference

Specified by:

encodeEntityReference in interface EXIBodyEncoder

Overrides:

encodeEntityReference in class AbstractEXIBodyEncoder

Parameters:

name - entity reference name

Throws:

EXIException - EXI exception

IOException - IO exception

encodeComment

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

Description copied from interface: EXIBodyEncoder

Supplies the text of a comment.

Specified by:

encodeComment in interface EXIBodyEncoder

Overrides:

encodeComment in class AbstractEXIBodyEncoder

Parameters:

ch - comment character array

start - comment character array start

length - comment character array length

Throws:

EXIException - EXI exception

IOException - IO exception

encodeProcessingInstruction

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

Description copied from interface: EXIBodyEncoder

Supplies the target and data for an underlying processing instruction.

Specified by:

encodeProcessingInstruction in interface EXIBodyEncoder

Overrides:

encodeProcessingInstruction in class AbstractEXIBodyEncoder

Parameters:

target - processing instruction target

data - processing instruction data

Throws:

EXIException - EXI exception

IOException - IO exception