com.siemens.ct.exi.core.coder

Class EXIBodyDecoderInOrderSC

java.lang.Object

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

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

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

com.siemens.ct.exi.core.coder.EXIBodyDecoderInOrderSC

All Implemented Interfaces:

EXIBodyDecoder

public class EXIBodyDecoderInOrderSC
extends EXIBodyDecoderInOrder

EXI decoder for bit or byte-aligned streams and possible self-contained elements.

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 EXIBodyDecoderInOrderSC	scDecoder

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
EXIBodyDecoderInOrderSC(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.
void	decodeStartSelfContainedFragment() Reads EXI a self-contained start element.
String	getAttributePrefix() Returns attribute prefix for (last) attribute as String
String	getAttributeQNameAsString() Returns qualified name for (last) attribute as String QName ::= PrefixedName | UnprefixedName PrefixedName ::= Prefix ':' LocalPart UnprefixedName ::= LocalPart
Value	getAttributeValue() Provides attribute value
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.
void	skipSCElement(long skip)

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

getChannel, readAttributeContent, readAttributeContent, setInputChannel, setInputStream, updateInputChannel, updateInputStream

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, decodeUri, 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

Field Detail

scDecoder

protected EXIBodyDecoderInOrderSC scDecoder

Constructor Detail

EXIBodyDecoderInOrderSC

public EXIBodyDecoderInOrderSC(EXIFactory exiFactory)
                        throws EXIException

Throws:

EXIException

Method Detail

initForEachRun

public void initForEachRun()
                    throws EXIException,
                           IOException

Overrides:

initForEachRun in class EXIBodyDecoderInOrder

Throws:

EXIException

IOException

skipSCElement

public void skipSCElement(long skip)
                   throws IOException

Throws:

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.

Specified by:

next in interface EXIBodyDecoder

Overrides:

next in class EXIBodyDecoderInOrder

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

Specified by:

decodeStartDocument in interface EXIBodyDecoder

Overrides:

decodeStartDocument in class EXIBodyDecoderInOrder

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

Specified by:

decodeEndDocument in interface EXIBodyDecoder

Overrides:

decodeEndDocument in class EXIBodyDecoderInOrder

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.

Specified by:

decodeStartElement in interface EXIBodyDecoder

Overrides:

decodeStartElement in class EXIBodyDecoderInOrder

Returns:

QNameContext for qualified name

Throws:

EXIException - EXI exception

IOException - IO exception

decodeStartSelfContainedFragment

public void decodeStartSelfContainedFragment()
                                      throws EXIException,
                                             IOException

Description copied from interface: EXIBodyDecoder

Reads EXI a self-contained start element.

Specified by:

decodeStartSelfContainedFragment in interface EXIBodyDecoder

Overrides:

decodeStartSelfContainedFragment in class AbstractEXIBodyDecoder

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.

Specified by:

decodeEndElement in interface EXIBodyDecoder

Overrides:

decodeEndElement in class EXIBodyDecoderInOrder

Returns:

QNameContext for qualified name

Throws:

EXIException - EXI exception

IOException - IO exception

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

Specified by:

getElementPrefix in interface EXIBodyDecoder

Overrides:

getElementPrefix in class EXIBodyDecoderInOrder

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

Specified by:

getElementQNameAsString in interface EXIBodyDecoder

Overrides:

getElementQNameAsString in class EXIBodyDecoderInOrder

Returns:

String for qname

decodeAttributeXsiNil

public QNameContext decodeAttributeXsiNil()
                                   throws EXIException,
                                          IOException

Description copied from interface: EXIBodyDecoder

Parses xsi:nil attribute

Specified by:

decodeAttributeXsiNil in interface EXIBodyDecoder

Overrides:

decodeAttributeXsiNil in class EXIBodyDecoderInOrder

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

Specified by:

decodeAttributeXsiType in interface EXIBodyDecoder

Overrides:

decodeAttributeXsiType in class EXIBodyDecoderInOrder

Returns:

QNameContext for qualified name

Throws:

EXIException - EXI exception

IOException - IO exception

decodeAttribute

public QNameContext decodeAttribute()
                             throws EXIException,
                                    IOException

Description copied from interface: EXIBodyDecoder

Parses attribute and returns qualified name.

Specified by:

decodeAttribute in interface EXIBodyDecoder

Overrides:

decodeAttribute in class EXIBodyDecoderInOrder

Returns:

QNameContext for qname

Throws:

EXIException - EXI exception

IOException - IO exception

getAttributePrefix

public String getAttributePrefix()

Description copied from interface: EXIBodyDecoder

Returns attribute prefix for (last) attribute as String

Specified by:

getAttributePrefix in interface EXIBodyDecoder

Overrides:

getAttributePrefix in class AbstractEXIBodyDecoder

Returns:

String for prefix

getAttributeQNameAsString

public String getAttributeQNameAsString()

Description copied from interface: EXIBodyDecoder

Returns qualified name for (last) attribute as String

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

Specified by:

getAttributeQNameAsString in interface EXIBodyDecoder

Overrides:

getAttributeQNameAsString in class AbstractEXIBodyDecoder

Returns:

String for qname

getAttributeValue

public Value getAttributeValue()

Description copied from interface: EXIBodyDecoder

Provides attribute value

Specified by:

getAttributeValue in interface EXIBodyDecoder

Overrides:

getAttributeValue in class AbstractEXIBodyDecoder

Returns:

Value for attribute value

getDeclaredPrefixDeclarations

public List<NamespaceDeclaration> getDeclaredPrefixDeclarations()

Description copied from interface: EXIBodyDecoder

Prefix declarations for current context (element)

Specified by:

getDeclaredPrefixDeclarations in interface EXIBodyDecoder

Overrides:

getDeclaredPrefixDeclarations in class EXIBodyDecoderInOrder

Returns:

list or null if no mappings are available

decodeNamespaceDeclaration

public NamespaceDeclaration decodeNamespaceDeclaration()
                                                throws EXIException,
                                                       IOException

Description copied from interface: EXIBodyDecoder

Parses namespace declaration retrieving associated URI and prefix.

Specified by:

decodeNamespaceDeclaration in interface EXIBodyDecoder

Overrides:

decodeNamespaceDeclaration in class EXIBodyDecoderInOrder

Returns:

NamespaceDeclaration ns declaration

Throws:

EXIException - EXI exception

IOException - IO exception

decodeCharacters

public Value decodeCharacters()
                       throws EXIException,
                              IOException

Description copied from interface: EXIBodyDecoder

Decodes characters and reports them.

Specified by:

decodeCharacters in interface EXIBodyDecoder

Overrides:

decodeCharacters in class EXIBodyDecoderInOrder

Returns:

Value for XML characters item

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).

Specified by:

decodeDocType in interface EXIBodyDecoder

Overrides:

decodeDocType in class EXIBodyDecoderInOrder

Returns:

DocType for DOCTYPE information items

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.

Specified by:

decodeEntityReference in interface EXIBodyDecoder

Overrides:

decodeEntityReference in class EXIBodyDecoderInOrder

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.

Specified by:

decodeComment in interface EXIBodyDecoder

Overrides:

decodeComment in class EXIBodyDecoderInOrder

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.

Specified by:

decodeProcessingInstruction in interface EXIBodyDecoder

Overrides:

decodeProcessingInstruction in class EXIBodyDecoderInOrder

Returns:

String for PI target and data

Throws:

EXIException - EXI exception

IOException - IO exception