EXIficient

com.siemens.ct.exi
Interface EXIDecoder

All Known Implementing Classes:
AbstractEXIDecoder, EXIDecoderInOrder, EXIDecoderReordered

public interface EXIDecoder

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

Version:
0.3.20090414
Author:
Daniel.Peintner.EXT@siemens.com, Joerg.Heuer@siemens.com

Method Summary
 void decodeAttribute()
          Parses expected attribute.
 void decodeAttributeGeneric()
          Parses expected generic attribute.
 void decodeAttributeGenericUndeclared()
          Parses unexpected attribute.
 void decodeAttributeInvalidValue()
          Parses expected attribute with schema-invalid value
 void decodeCharacters()
          Decodes expected characters.
 void decodeCharactersGeneric()
          Decodes generic characters.
 void decodeCharactersGenericUndeclared()
          Decodes unexpected (generic) characters.
 void decodeComment()
          Parses comment with associated characters.
 void decodeDocType()
          Parses DOCTYPE with information items
 void decodeEndDocument()
          Finalizes the end of a set of XML events
 void decodeEndElement()
          Reads EXI end element.
 void decodeEndElementUndeclared()
          Reads unexpected EXI end element.
 void decodeEndFragmentSelfContained()
          Reads an end element part of self-contained fragments
 void decodeEntityReference()
          Parses EntityReference
 void decodeNamespaceDeclaration()
          Parses namespace declaration retrieving associated URI and prefix.
 void decodeProcessingInstruction()
          Parses processing instruction with associated target and data.
 void decodeStartDocument()
          Initializes the beginning of a set of XML events
 void decodeStartElement()
          Reads EXI start element.
 void decodeStartElementGeneric()
          Reads generic start element.
 void decodeStartElementGenericUndeclared()
          Parses unexpected start element.
 void decodeStartFragmentSelfContained()
          Reads EXI a self-contained start element
 void decodeXsiNil()
          Reads xsi:nil from EXI stream.
 void decodeXsiNilDeviation()
           
 void decodeXsiType()
          Reads xsi:type from EXI stream.
 java.lang.String getAttributeLocalName()
          Provides (last) attribute local-name
 java.lang.String getAttributePrefix()
          Provides (last) attribute prefix
 java.lang.String getAttributeURI()
          Provides (last) attribute namespace
 java.lang.String getAttributeValue()
          Provides attribute value
 java.lang.String getCharacters()
          Provides characters as well as significant/insignificant whitespace characters
 java.lang.String getComment()
          Provides comment text.
 java.lang.String getDocTypeName()
          Provides DOCTYPE name.
 java.lang.String getDocTypePublicID()
          Provides DOCTYPE public ID.
 java.lang.String getDocTypeSystemID()
          Provides DOCTYPE system ID.
 java.lang.String getDocTypeText()
          Provides DOCTYPE text.
 java.lang.String getElementLocalName()
          Provides (last) element local-name
 java.lang.String getElementPrefix()
          Provides (last) element prefix
 java.lang.String getElementURI()
          Provides (last) element namespace.
 java.lang.String getEntityReferenceName()
          Provides ENTITY_REFERENCE name.
 org.xml.sax.helpers.NamespaceSupport getNamespaces()
          Provides namespace support.
 EventType getNextEventType()
          Reports the next available EXI event-type
 java.lang.String getNSPrefix()
          Provides prefix of namespace declaration.
 java.lang.String getNSUri()
          Provides URI of namespace declaration.
 java.lang.String getPIData()
          Provides processing instructions data.
 java.lang.String getPITarget()
          Provides processing instructions target.
 java.lang.String getScopeLocalName()
          Provides current scope local-name.
 java.lang.String getScopeURI()
          Provides current scope URI.
 boolean getXsiNil()
          Provides xsi:nil value
 java.lang.String getXsiNilDeviation()
           
 java.lang.String getXsiTypeName()
          Provides xsi:type name
 java.lang.String getXsiTypeUri()
          Provides xsi:ytpe namespace
 boolean hasNextEvent()
          Reports whether an additional EXI event is available.
 void inspectEvent()
          Sniffs EXI stream for reporting next event.
 void setInputStream(java.io.InputStream is, boolean exiBodyOnly)
           
 

Method Detail

setInputStream

void setInputStream(java.io.InputStream is,
                    boolean exiBodyOnly)
                    throws EXIException
Throws:
EXIException

hasNextEvent

boolean hasNextEvent()
Reports whether an additional EXI event is available.

Returns:
true if the stream has more events.

getNextEventType

EventType getNextEventType()
Reports the next available EXI event-type

Returns:
EventType for next EXI event

inspectEvent

void inspectEvent()
                  throws EXIException
Sniffs EXI stream for reporting next event.

Throws:
EXIException

decodeStartDocument

void decodeStartDocument()
                         throws EXIException
Initializes the beginning of a set of XML events

Throws:
EXIException

decodeEndDocument

void decodeEndDocument()
                       throws EXIException
Finalizes the end of a set of XML events

Throws:
org.xml.sax.SAXException
EXIException

decodeStartElement

void decodeStartElement()
                        throws org.xml.sax.SAXException,
                               EXIException
Reads EXI start element.

Start element appearing as expected event.

Throws:
org.xml.sax.SAXException
EXIException

decodeStartElementGeneric

void decodeStartElementGeneric()
                               throws EXIException
Reads generic start element.

Expected generic start element

Throws:
EXIException

decodeStartElementGenericUndeclared

void decodeStartElementGenericUndeclared()
                                         throws EXIException
Parses unexpected start element.

Throws:
EXIException

decodeStartFragmentSelfContained

void decodeStartFragmentSelfContained()
                                      throws EXIException
Reads EXI a self-contained start element

Throws:
EXIException

decodeEndElement

void decodeEndElement()
                      throws EXIException
Reads EXI end element.

Throws:
EXIException

decodeEndElementUndeclared

void decodeEndElementUndeclared()
                                throws EXIException
Reads unexpected EXI end element.

Throws:
EXIException

decodeEndFragmentSelfContained

void decodeEndFragmentSelfContained()
                                    throws EXIException
Reads an end element part of self-contained fragments

Throws:
EXIException

decodeAttribute

void decodeAttribute()
                     throws EXIException
Parses expected attribute.

Throws:
EXIException

decodeAttributeInvalidValue

void decodeAttributeInvalidValue()
                                 throws EXIException
Parses expected attribute with schema-invalid value

Throws:
EXIException

decodeAttributeGeneric

void decodeAttributeGeneric()
                            throws EXIException
Parses expected generic attribute.

Throws:
EXIException

decodeAttributeGenericUndeclared

void decodeAttributeGenericUndeclared()
                                      throws EXIException
Parses unexpected attribute.

Throws:
EXIException

decodeNamespaceDeclaration

void decodeNamespaceDeclaration()
                                throws EXIException
Parses namespace declaration retrieving associated URI and prefix.

Throws:
EXIException

decodeXsiType

void decodeXsiType()
                   throws EXIException
Reads xsi:type from EXI stream.

Throws:
EXIException

decodeXsiNil

void decodeXsiNil()
                  throws EXIException
Reads xsi:nil from EXI stream.

Throws:
EXIException

decodeXsiNilDeviation

void decodeXsiNilDeviation()
                           throws EXIException
Throws:
EXIException

decodeCharacters

void decodeCharacters()
                      throws EXIException
Decodes expected characters.

Throws:
EXIException

decodeCharactersGeneric

void decodeCharactersGeneric()
                             throws EXIException
Decodes generic characters.

Throws:
EXIException

decodeCharactersGenericUndeclared

void decodeCharactersGenericUndeclared()
                                       throws EXIException
Decodes unexpected (generic) characters.

Throws:
EXIException

decodeDocType

void decodeDocType()
                   throws EXIException
Parses DOCTYPE with information items

Throws:
EXIException

decodeEntityReference

void decodeEntityReference()
                           throws EXIException
Parses EntityReference

Throws:
EXIException

decodeComment

void decodeComment()
                   throws EXIException
Parses comment with associated characters.

Throws:
EXIException

decodeProcessingInstruction

void decodeProcessingInstruction()
                                 throws EXIException
Parses processing instruction with associated target and data.

Throws:
EXIException

getScopeURI

java.lang.String getScopeURI()
Provides current scope URI.

Returns:
String for URI

getScopeLocalName

java.lang.String getScopeLocalName()
Provides current scope local-name.

Returns:
String for name

getElementURI

java.lang.String getElementURI()
Provides (last) element namespace.

Returns:
String for element URI

getElementLocalName

java.lang.String getElementLocalName()
Provides (last) element local-name

Returns:
String for element name

getElementPrefix

java.lang.String getElementPrefix()
Provides (last) element prefix

Returns:
String for element prefix

getAttributeURI

java.lang.String getAttributeURI()
Provides (last) attribute namespace

Returns:
String for attribute URI

getAttributeLocalName

java.lang.String getAttributeLocalName()
Provides (last) attribute local-name

Returns:
String for attribute name

getAttributePrefix

java.lang.String getAttributePrefix()
Provides (last) attribute prefix

Returns:
String for element prefix

getAttributeValue

java.lang.String getAttributeValue()
Provides attribute value

Returns:
String for attribute value

getXsiTypeUri

java.lang.String getXsiTypeUri()
Provides xsi:ytpe namespace

Returns:
String for type URI

getXsiTypeName

java.lang.String getXsiTypeName()
Provides xsi:type name

Returns:
String for type name

getXsiNil

boolean getXsiNil()
Provides xsi:nil value

Returns:
true for xsi nil

getXsiNilDeviation

java.lang.String getXsiNilDeviation()

getCharacters

java.lang.String getCharacters()
Provides characters as well as significant/insignificant whitespace characters

Returns:
String for characters

getDocTypeName

java.lang.String getDocTypeName()
Provides DOCTYPE name.

Returns:
String for DOCTYPE name

getDocTypePublicID

java.lang.String getDocTypePublicID()
Provides DOCTYPE public ID.

Returns:
String for DOCTYPE public ID

getDocTypeSystemID

java.lang.String getDocTypeSystemID()
Provides DOCTYPE system ID.

Returns:
String for DOCTYPE system ID

getDocTypeText

java.lang.String getDocTypeText()
Provides DOCTYPE text.

Returns:
String for DOCTYPE text

getEntityReferenceName

java.lang.String getEntityReferenceName()
Provides ENTITY_REFERENCE name.

Returns:
String for DOCTYPE name

getComment

java.lang.String getComment()
Provides comment text.

Returns:
String for comment text

getNamespaces

org.xml.sax.helpers.NamespaceSupport getNamespaces()
Provides namespace support.

Returns:
NamespaceSupport for prefix mapping

getNSUri

java.lang.String getNSUri()
Provides URI of namespace declaration.

Returns:
String for NS uri

getNSPrefix

java.lang.String getNSPrefix()
Provides prefix of namespace declaration.

Returns:
String for NS prefix

getPITarget

java.lang.String getPITarget()
Provides processing instructions target.

Returns:
String for PI target

getPIData

java.lang.String getPIData()
Provides processing instructions data.

Returns:
String for PI data

EXIficient