com.siemens.ct.exi.core.coder

Class AbstractEXIBodyEncoder

java.lang.Object

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

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

All Implemented Interfaces:

EXIBodyEncoder

Direct Known Subclasses:

EXIBodyEncoderInOrder, EXIBodyEncoderReordered

public abstract class AbstractEXIBodyEncoder
extends AbstractEXIBodyCoder
implements EXIBodyEncoder

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 List<Value>	bChars buffers character values before flushing them out
protected EncoderChannel	channel Output Channel
protected EncodingOptions	encodingOptions Encoding options
protected EXIHeaderEncoder	exiHeader
protected boolean	isXmlSpacePreserve The xml:space attribute is defined (default false)
protected EventType	lastEvent contains last event type
protected String	sePrefix prefix of previous start element (relevant for preserving prefixes)
protected String	seUri URI of previous start element (relevant for preserving prefixes)
protected StringEncoder	stringEncoder String Encoder
protected TypeEncoder	typeEncoder Type Encoder

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
AbstractEXIBodyEncoder(EXIFactory exiFactory)

Method Summary

Modifier and Type	Method and Description
protected void	checkPendingCharacters(EventType nextEvent)
protected void	encode1stLevelEventCode(int pos)
protected void	encode2ndLevelEventCode(int pos)
protected void	encode3rdLevelEventCode(int pos)
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.
protected void	encodeCharactersForce(Value chars)
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
protected QNameContext	encodeLocalName(String localName, AbstractEXIBodyCoder.RuntimeUriContext ruc, EncoderChannel channel)
void	encodeNamespaceDeclaration(String uri, String prefix) Namespaces are reported as a discrete Namespace event.
protected void	encodeNamespacePrefix(AbstractEXIBodyCoder.RuntimeUriContext uriContext, String prefix, EncoderChannel channel)
void	encodeProcessingInstruction(String target, String data) Supplies the target and data for an underlying processing instruction.
protected QNameContext	encodeQName(String namespaceUri, String localName, EncoderChannel channel)
protected void	encodeQNamePrefix(QNameContext qnContext, String prefix, EncoderChannel channel)
protected void	encodeSchemaInvalidAttributeEventCode(int eventCode3)
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.
protected AbstractEXIBodyCoder.RuntimeUriContext	encodeUri(String namespaceUri, EncoderChannel channel)
void	flush() Flushes (possibly) remaining bit(s) to output stream
protected Attribute	getGlobalAttribute(AbstractEXIBodyCoder.RuntimeUriContext uc, String localName)
protected Attribute	getGlobalAttribute(String uri, String localName)
void	initForEachRun()
protected boolean	isTypeValid(Datatype datatype, Value value)
protected void	writeString(String text)
protected abstract void	writeValue(QNameContext valueContext)

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, setErrorHandler, throwWarning, updateCurrentRule, updateElementContext

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.siemens.ct.exi.core.EXIBodyEncoder

setErrorHandler, setOutputChannel, setOutputStream

Field Detail

exiHeader

protected final EXIHeaderEncoder exiHeader

sePrefix

protected String sePrefix

prefix of previous start element (relevant for preserving prefixes)

seUri

protected String seUri

URI of previous start element (relevant for preserving prefixes)

channel

protected EncoderChannel channel

Output Channel

typeEncoder

protected final TypeEncoder typeEncoder

Type Encoder

stringEncoder

protected final StringEncoder stringEncoder

String Encoder

encodingOptions

protected final EncodingOptions encodingOptions

Encoding options

bChars

protected List<Value> bChars

buffers character values before flushing them out

isXmlSpacePreserve

protected boolean isXmlSpacePreserve

The xml:space attribute is defined (default false)

lastEvent

protected EventType lastEvent

contains last event type

Constructor Detail

AbstractEXIBodyEncoder

public AbstractEXIBodyEncoder(EXIFactory exiFactory)
                       throws EXIException

Throws:

EXIException

Method Detail

initForEachRun

public void initForEachRun()
                    throws EXIException,
                           IOException

Overrides:

initForEachRun in class AbstractEXIBodyCoder

Throws:

EXIException

IOException

encodeQName

protected QNameContext encodeQName(String namespaceUri,
                                   String localName,
                                   EncoderChannel channel)
                            throws IOException

Throws:

IOException

encodeUri

protected AbstractEXIBodyCoder.RuntimeUriContext encodeUri(String namespaceUri,
                                                           EncoderChannel channel)
                                                    throws IOException

Throws:

IOException

encodeQNamePrefix

protected void encodeQNamePrefix(QNameContext qnContext,
                                 String prefix,
                                 EncoderChannel channel)
                          throws IOException,
                                 EXIException

Throws:

IOException

EXIException

encodeLocalName

protected QNameContext encodeLocalName(String localName,
                                       AbstractEXIBodyCoder.RuntimeUriContext ruc,
                                       EncoderChannel channel)
                                throws IOException

Throws:

IOException

encodeNamespacePrefix

protected void encodeNamespacePrefix(AbstractEXIBodyCoder.RuntimeUriContext uriContext,
                                     String prefix,
                                     EncoderChannel channel)
                              throws IOException

Throws:

IOException

flush

public void flush()
           throws IOException

Description copied from interface: EXIBodyEncoder

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

Specified by:

flush in interface EXIBodyEncoder

Throws:

IOException - IO exception

writeString

protected void writeString(String text)
                    throws IOException

Throws:

IOException

isTypeValid

protected boolean isTypeValid(Datatype datatype,
                              Value value)

writeValue

protected abstract void writeValue(QNameContext valueContext)
                            throws IOException

Throws:

IOException

encode1stLevelEventCode

protected void encode1stLevelEventCode(int pos)
                                throws IOException

Throws:

IOException

encode2ndLevelEventCode

protected void encode2ndLevelEventCode(int pos)
                                throws IOException

Throws:

IOException

encode3rdLevelEventCode

protected void encode3rdLevelEventCode(int pos)
                                throws IOException

Throws:

IOException

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

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

Throws:

EXIException - EXI exception

IOException - IO exception

encodeStartElement

public void encodeStartElement(QName se)
                        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

Parameters:

se - start element's qname

Throws:

EXIException - EXI exception

IOException - IO exception

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

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

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

Parameters:

uri - namespace URI

prefix - namespace prefix

Throws:

EXIException - EXI exception

IOException - IO exception

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

Throws:

EXIException - EXI exception

IOException - IO exception

encodeAttributeList

public void encodeAttributeList(AttributeList attributes)
                         throws EXIException,
                                IOException

Description copied from interface: EXIBodyEncoder

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

Specified by:

encodeAttributeList in interface EXIBodyEncoder

Parameters:

attributes - list of attributes

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

Parameters:

type - xsi:type value

pfx - xsi:type 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

Parameters:

nil - xsi:nil value

pfx - xsi:nil prefix

Throws:

EXIException - EXI exception

IOException - IO exception

encodeSchemaInvalidAttributeEventCode

protected void encodeSchemaInvalidAttributeEventCode(int eventCode3)
                                              throws IOException

Throws:

IOException

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

Parameters:

at - attribute's qname

value - attribute value

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

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

getGlobalAttribute

protected Attribute getGlobalAttribute(String uri,
                                       String localName)

getGlobalAttribute

protected Attribute getGlobalAttribute(AbstractEXIBodyCoder.RuntimeUriContext uc,
                                       String localName)

checkPendingCharacters

protected void checkPendingCharacters(EventType nextEvent)
                               throws EXIException,
                                      IOException

Throws:

EXIException

IOException

encodeCharacters

public void encodeCharacters(Value chars)
                      throws EXIException,
                             IOException

Description copied from interface: EXIBodyEncoder

Supplies characters as Value.

Specified by:

encodeCharacters in interface EXIBodyEncoder

Parameters:

chars - character values

Throws:

EXIException - EXI exception

IOException - IO exception

encodeCharactersForce

protected void encodeCharactersForce(Value chars)
                              throws EXIException,
                                     IOException

Throws:

EXIException

IOException

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

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

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

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

Parameters:

target - processing instruction target

data - processing instruction data

Throws:

EXIException - EXI exception

IOException - IO exception