com.siemens.ct.exi.core.coder

Class EXIBodyDecoderInOrder

java.lang.Object

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

com.siemens.ct.exi.core.coder.AbstractEXIBodyDecoder

com.siemens.ct.exi.core.coder.EXIBodyDecoderInOrder

All Implemented Interfaces:

EXIBodyDecoder

Direct Known Subclasses:

EXIBodyDecoderInOrderSC

public class EXIBodyDecoderInOrder
extends AbstractEXIBodyDecoder

EXI decoder for bit or byte-aligned streams.

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 inherited from class com.siemens.ct.exi.core.coder.AbstractEXIBodyDecoder

attributePrefix, attributeQNameContext, attributeValue, channel, nextEvent, nextEventType, nextGrammar, numberOfUriContexts, stringDecoder, typeDecoder

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

Method Summary

Modifier and Type	Method and Description
QNameContext	decodeAttribute() Parses attribute and returns qualified name.
QNameContext	decodeAttributeXsiNil() Parses xsi:nil attribute
QNameContext	decodeAttributeXsiType() Parses xsi:type attribute
Value	decodeCharacters() Decodes characters and reports them.
char[]	decodeComment() Parses comment with associated characters and provides comment text.
DocType	decodeDocType() Parses DOCTYPE with information items (name, publicID, systemID, text).
void	decodeEndDocument() Indicates the end of a set of XML events
QNameContext	decodeEndElement() Reads EXI end element and returns qualified name.
char[]	decodeEntityReference() Parses EntityReference and returns ER name.
NamespaceDeclaration	decodeNamespaceDeclaration() Parses namespace declaration retrieving associated URI and prefix.
ProcessingInstruction	decodeProcessingInstruction() Parses processing instruction with associated target and data.
void	decodeStartDocument() Indicates the beginning of a set of XML events
QNameContext	decodeStartElement() Reads EXI start element and returns qualified name.
DecoderChannel	getChannel()
List<NamespaceDeclaration>	getDeclaredPrefixDeclarations() Prefix declarations for current context (element)
String	getElementPrefix() Returns element prefix for current element as String.
String	getElementQNameAsString() Returns qualified name for element name as String QName ::= PrefixedName | UnprefixedName PrefixedName ::= Prefix ':' LocalPart UnprefixedName ::= LocalPart
void	initForEachRun()
EventType	next() Reports the next available EXI event-type or null if no more EXI event is available.
protected void	readAttributeContent()
protected void	readAttributeContent(Datatype dt)
void	setInputChannel(DecoderChannel decoderChannel) Sets input channel and resets all internal states
void	setInputStream(InputStream is) Sets the input stream and resets all internal states
void	updateInputChannel(DecoderChannel decoderChannel) Updates input channel and and does not reset internal states.
void	updateInputStream(InputStream is) Updates input stream and does not reset internal states.

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

checkDefaultPrefixNamespaceDeclaration, decode2ndLevelEventCode, decode3rdLevelEventCode, decodeAttributeAnyInvalidValueStructure, decodeAttributeGenericStructure, decodeAttributeGenericUndeclaredStructure, decodeAttributeNSStructure, decodeAttributeStructure, decodeAttributeXsiNilStructure, decodeAttributeXsiTypeStructure, decodeCharactersGenericStructure, decodeCharactersGenericUndeclaredStructure, decodeCharactersStructure, decodeCommentStructure, decodeDocTypeStructure, decodeEndDocumentStructure, decodeEndElementStructure, decodeEndElementUndeclaredStructure, decodeEntityReferenceStructure, decodeEventCode, decodeLocalName, decodeNamespaceDeclarationStructure, decodeNamespacePrefix, decodeProcessingInstructionStructure, decodeQName, decodeQNamePrefix, decodeStartDocumentStructure, decodeStartElementGenericStructure, decodeStartElementGenericUndeclaredStructure, decodeStartElementNSStructure, decodeStartElementStructure, decodeStartSelfContainedFragment, decodeUri, getAttributePrefix, getAttributeQNameAsString, getAttributeValue, handleAttributePrefix, handleElementPrefix, pushElement, updateInvalidValueAttribute

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

Methods inherited from class java.lang.Object

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

Constructor Detail

EXIBodyDecoderInOrder

public EXIBodyDecoderInOrder(EXIFactory exiFactory)
                      throws EXIException

Throws:

EXIException

Method Detail

setInputStream

public void setInputStream(InputStream is)
                    throws EXIException,
                           IOException

Description copied from interface: EXIBodyDecoder

Sets the input stream and resets all internal states

Parameters:

is - input stream

Throws:

EXIException - EXI exception

IOException - IO exception

See Also:

EXIBodyDecoder.updateInputStream(InputStream)

setInputChannel

public void setInputChannel(DecoderChannel decoderChannel)
                     throws EXIException,
                            IOException

Description copied from interface: EXIBodyDecoder

Sets input channel and resets all internal states

Parameters:

decoderChannel - decoder channel

Throws:

EXIException - EXI exception

IOException - IO exception

See Also:

EXIBodyDecoder.updateInputChannel(DecoderChannel)

updateInputStream

public void updateInputStream(InputStream is)
                       throws EXIException,
                              IOException

Description copied from interface: EXIBodyDecoder

Updates input stream and does not reset internal states.

Parameters:

is - input stream

Throws:

EXIException - EXI exception

IOException - IO exception

See Also:

EXIBodyDecoder.setInputStream(InputStream)

updateInputChannel

public void updateInputChannel(DecoderChannel decoderChannel)
                        throws EXIException,
                               IOException

Description copied from interface: EXIBodyDecoder

Updates input channel and and does not reset internal states.

Parameters:

decoderChannel - decoder channel

Throws:

EXIException - EXI exception

IOException - IO exception

See Also:

EXIBodyDecoder.setInputChannel(DecoderChannel)

getChannel

public DecoderChannel getChannel()

initForEachRun

public void initForEachRun()
                    throws EXIException,
                           IOException

Overrides:

initForEachRun in class AbstractEXIBodyDecoder

Throws:

EXIException

IOException

next

public EventType next()
               throws EXIException,
                      IOException

Description copied from interface: EXIBodyDecoder

Reports the next available EXI event-type or null if no more EXI event is available.

Returns:

EventType for next EXI event

Throws:

EXIException - EXI exception

IOException - IO exception

decodeStartDocument

public void decodeStartDocument()
                         throws EXIException

Description copied from interface: EXIBodyDecoder

Indicates the beginning of a set of XML events

Throws:

EXIException - EXI exception

decodeEndDocument

public void decodeEndDocument()
                       throws EXIException,
                              IOException

Description copied from interface: EXIBodyDecoder

Indicates the end of a set of XML events

Throws:

EXIException - EXI exception

IOException - IO exception

decodeStartElement

public QNameContext decodeStartElement()
                                throws EXIException,
                                       IOException

Description copied from interface: EXIBodyDecoder

Reads EXI start element and returns qualified name.

Start element appearing as expected event.

Returns:

QNameContext for qualified name

Throws:

EXIException - EXI exception

IOException - IO exception

decodeEndElement

public QNameContext decodeEndElement()
                              throws EXIException,
                                     IOException

Description copied from interface: EXIBodyDecoder

Reads EXI end element and returns qualified name.

Returns:

QNameContext for qualified name

Throws:

EXIException - EXI exception

IOException - IO exception

getDeclaredPrefixDeclarations

public List<NamespaceDeclaration> getDeclaredPrefixDeclarations()

Description copied from interface: EXIBodyDecoder

Prefix declarations for current context (element)

Returns:

list or null if no mappings are available

getElementPrefix

public String getElementPrefix()

Description copied from interface: EXIBodyDecoder

Returns element prefix for current element as String.

Note: IF Preserve.Prefixes set to TRUE ONLY callable after all NS events

Returns:

String for prefix

getElementQNameAsString

public String getElementQNameAsString()

Description copied from interface: EXIBodyDecoder

Returns qualified name for element name as String

QName ::= PrefixedName | UnprefixedName
PrefixedName ::= Prefix ':' LocalPart
UnprefixedName ::= LocalPart

Returns:

String for qname

decodeNamespaceDeclaration

public NamespaceDeclaration decodeNamespaceDeclaration()
                                                throws EXIException,
                                                       IOException

Description copied from interface: EXIBodyDecoder

Parses namespace declaration retrieving associated URI and prefix.

Returns:

NamespaceDeclaration ns declaration

Throws:

EXIException - EXI exception

IOException - IO exception

decodeAttributeXsiNil

public QNameContext decodeAttributeXsiNil()
                                   throws EXIException,
                                          IOException

Description copied from interface: EXIBodyDecoder

Parses xsi:nil attribute

Returns:

xsi:nil qname

Throws:

EXIException - EXI exception

IOException - IO exception

decodeAttributeXsiType

public QNameContext decodeAttributeXsiType()
                                    throws EXIException,
                                           IOException

Description copied from interface: EXIBodyDecoder

Parses xsi:type attribute

Returns:

QNameContext for qualified name

Throws:

EXIException - EXI exception

IOException - IO exception

readAttributeContent

protected void readAttributeContent(Datatype dt)
                             throws IOException

Throws:

IOException

readAttributeContent

protected void readAttributeContent()
                             throws IOException,
                                    EXIException

Throws:

IOException

EXIException

decodeAttribute

public QNameContext decodeAttribute()
                             throws EXIException,
                                    IOException

Description copied from interface: EXIBodyDecoder

Parses attribute and returns qualified name.

Returns:

QNameContext for qname

Throws:

EXIException - EXI exception

IOException - IO exception

decodeCharacters

public Value decodeCharacters()
                       throws EXIException,
                              IOException

Description copied from interface: EXIBodyDecoder

Decodes characters and reports them.

Returns:

Value for XML characters item

Throws:

EXIException - EXI exception

IOException - IO exception

decodeEntityReference

public char[] decodeEntityReference()
                             throws EXIException,
                                    IOException

Description copied from interface: EXIBodyDecoder

Parses EntityReference and returns ER name.

Returns:

String for ER name

Throws:

EXIException - EXI exception

IOException - IO exception

decodeComment

public char[] decodeComment()
                     throws EXIException,
                            IOException

Description copied from interface: EXIBodyDecoder

Parses comment with associated characters and provides comment text.

Returns:

String for comment text

Throws:

EXIException - EXI exception

IOException - IO exception

decodeProcessingInstruction

public ProcessingInstruction decodeProcessingInstruction()
                                                  throws EXIException,
                                                         IOException

Description copied from interface: EXIBodyDecoder

Parses processing instruction with associated target and data.

Returns:

String for PI target and data

Throws:

EXIException - EXI exception

IOException - IO exception

decodeDocType

public DocType decodeDocType()
                      throws EXIException,
                             IOException

Description copied from interface: EXIBodyDecoder

Parses DOCTYPE with information items (name, publicID, systemID, text).

Returns:

DocType for DOCTYPE information items

Throws:

EXIException - EXI exception

IOException - IO exception