com.siemens.ct.exi.core

Interface EXIBodyDecoder

All Known Implementing Classes:

AbstractEXIBodyDecoder, EXIBodyDecoderInOrder, EXIBodyDecoderInOrderSC, EXIBodyDecoderReordered

public interface EXIBodyDecoder

Internal EXI Decoder interface to transform an EXI stream back to XML Infoset entities.

Author:

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

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
EventType	next() Reports the next available EXI event-type or null if no more EXI event is available.
void	setInputChannel(DecoderChannel channel) Sets input channel and resets all internal states
void	setInputStream(InputStream is) Sets the input stream and resets all internal states
void	updateInputChannel(DecoderChannel channel) Updates input channel and and does not reset internal states.
void	updateInputStream(InputStream is) Updates input stream and does not reset internal states.

Method Detail

setInputStream

void setInputStream(InputStream is)
             throws EXIException,
                    IOException

Sets the input stream and resets all internal states

Parameters:

is - input stream

Throws:

EXIException - EXI exception

IOException - IO exception

See Also:

updateInputStream(InputStream)

setInputChannel

void setInputChannel(DecoderChannel channel)
              throws EXIException,
                     IOException

Sets input channel and resets all internal states

Parameters:

channel - decoder channel

Throws:

EXIException - EXI exception

IOException - IO exception

See Also:

updateInputChannel(DecoderChannel)

updateInputStream

void updateInputStream(InputStream is)
                throws EXIException,
                       IOException

Updates input stream and does not reset internal states.

Parameters:

is - input stream

Throws:

EXIException - EXI exception

IOException - IO exception

See Also:

setInputStream(InputStream)

updateInputChannel

void updateInputChannel(DecoderChannel channel)
                 throws EXIException,
                        IOException

Updates input channel and and does not reset internal states.

Parameters:

channel - decoder channel

Throws:

EXIException - EXI exception

IOException - IO exception

See Also:

setInputChannel(DecoderChannel)

next

EventType next()
        throws EXIException,
               IOException

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

void decodeStartDocument()
                  throws EXIException,
                         IOException

Indicates the beginning of a set of XML events

Throws:

EXIException - EXI exception

IOException - IO exception

decodeEndDocument

void decodeEndDocument()
                throws EXIException,
                       IOException

Indicates the end of a set of XML events

Throws:

EXIException - EXI exception

IOException - IO exception

decodeStartElement

QNameContext decodeStartElement()
                         throws EXIException,
                                IOException

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

getElementPrefix

String getElementPrefix()

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

String getElementQNameAsString()

Returns qualified name for element name as String

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

Returns:

String for qname

decodeStartSelfContainedFragment

void decodeStartSelfContainedFragment()
                               throws EXIException,
                                      IOException

Reads EXI a self-contained start element.

Throws:

EXIException - EXI exception

IOException - IO exception

decodeEndElement

QNameContext decodeEndElement()
                       throws EXIException,
                              IOException

Reads EXI end element and returns qualified name.

Returns:

QNameContext for qualified name

Throws:

EXIException - EXI exception

IOException - IO exception

decodeAttributeXsiNil

QNameContext decodeAttributeXsiNil()
                            throws EXIException,
                                   IOException

Parses xsi:nil attribute

Returns:

xsi:nil qname

Throws:

EXIException - EXI exception

IOException - IO exception

decodeAttributeXsiType

QNameContext decodeAttributeXsiType()
                             throws EXIException,
                                    IOException

Parses xsi:type attribute

Returns:

QNameContext for qualified name

Throws:

EXIException - EXI exception

IOException - IO exception

decodeAttribute

QNameContext decodeAttribute()
                      throws EXIException,
                             IOException

Parses attribute and returns qualified name.

Returns:

QNameContext for qname

Throws:

EXIException - EXI exception

IOException - IO exception

getAttributePrefix

String getAttributePrefix()

Returns attribute prefix for (last) attribute as String

Returns:

String for prefix

getAttributeQNameAsString

String getAttributeQNameAsString()

Returns qualified name for (last) attribute as String

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

Returns:

String for qname

getAttributeValue

Value getAttributeValue()

Provides attribute value

Returns:

Value for attribute value

decodeNamespaceDeclaration

NamespaceDeclaration decodeNamespaceDeclaration()
                                         throws EXIException,
                                                IOException

Parses namespace declaration retrieving associated URI and prefix.

Returns:

NamespaceDeclaration ns declaration

Throws:

EXIException - EXI exception

IOException - IO exception

getDeclaredPrefixDeclarations

List<NamespaceDeclaration> getDeclaredPrefixDeclarations()

Prefix declarations for current context (element)

Returns:

list or null if no mappings are available

decodeCharacters

Value decodeCharacters()
                throws EXIException,
                       IOException

Decodes characters and reports them.

Returns:

Value for XML characters item

Throws:

EXIException - EXI exception

IOException - IO exception

decodeDocType

DocType decodeDocType()
               throws EXIException,
                      IOException

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

Returns:

DocType for DOCTYPE information items

Throws:

EXIException - EXI exception

IOException - IO exception

decodeEntityReference

char[] decodeEntityReference()
                      throws EXIException,
                             IOException

Parses EntityReference and returns ER name.

Returns:

String for ER name

Throws:

EXIException - EXI exception

IOException - IO exception

decodeComment

char[] decodeComment()
              throws EXIException,
                     IOException

Parses comment with associated characters and provides comment text.

Returns:

String for comment text

Throws:

EXIException - EXI exception

IOException - IO exception

decodeProcessingInstruction

ProcessingInstruction decodeProcessingInstruction()
                                           throws EXIException,
                                                  IOException

Parses processing instruction with associated target and data.

Returns:

String for PI target and data

Throws:

EXIException - EXI exception

IOException - IO exception