EXIficient

com.siemens.ct.exi
Interface EXIDecoder

All Known Implementing Classes:
AbstractEXIDecoder, EXIDecoderInOrder, EXIDecoderInOrderSC, EXIDecoderReordered

public interface EXIDecoder

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

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

Method Summary
 void decodeAttribute()
          Parses attribute
 void decodeAttributeAnyInvalidValue()
          Parses expected attribute with schema-invalid value (NO qname given)
 void decodeAttributeGeneric()
          Parses expected generic attribute.
 void decodeAttributeGenericUndeclared()
          Parses unexpected attribute.
 void decodeAttributeInvalidValue()
          Parses expected attribute with schema-invalid value (qname given)
 void decodeAttributeNS()
          Parses expected attribute with given namespaceURI
 void decodeAttributeXsiNil()
          Parses xsi:nil attribute
 void decodeAttributeXsiType()
          Parses xsi:type attribute
 void decodeCharacters()
          Decodes 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 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 decodeStartElementNS()
          Reads start element where only the URI is known.
 void decodeStartFragmentSelfContained()
          Reads EXI a self-contained start element
 java.lang.String getAttributeLocalName()
          Provides (last) attribute local-name
 java.lang.String getAttributeQName()
          Returns qualified name for (last) attribute
 java.lang.String getAttributeURI()
          Provides (last) attribute namespace
 java.lang.String getAttributeValue()
          Provides attribute value
 char[] getCharacters()
          Provides characters as well as significant/insignificant whitespace characters
 char[] 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 getElementQName()
          Returns qualified name for element name
 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.
 java.lang.String getPIData()
          Provides processing instructions data.
 java.lang.String getPITarget()
          Provides processing instructions target.
 boolean hasNext()
          Reports whether an additional EXI event is available.
 EventType next()
          Reports the next available EXI event-type
 void setInputStream(java.io.InputStream is, boolean exiBodyOnly)
           
 

Method Detail

setInputStream

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

hasNext

boolean hasNext()
                throws EXIException,
                       java.io.IOException
Reports whether an additional EXI event is available.

Returns:
true if the stream has more events.
Throws:
EXIException
java.io.IOException

next

EventType next()
               throws EXIException
Reports the next available EXI event-type

Returns:
EventType for next EXI event
Throws:
EXIException

decodeStartDocument

void decodeStartDocument()
                         throws EXIException,
                                java.io.IOException
Initializes the beginning of a set of XML events

Throws:
EXIException
java.io.IOException

decodeEndDocument

void decodeEndDocument()
                       throws EXIException,
                              java.io.IOException
Finalizes the end of a set of XML events

Throws:
EXIException
java.io.IOException

decodeStartElement

void decodeStartElement()
                        throws EXIException,
                               java.io.IOException
Reads EXI start element.

Start element appearing as expected event.

Throws:
EXIException
java.io.IOException

decodeStartElementNS

void decodeStartElementNS()
                          throws EXIException,
                                 java.io.IOException
Reads start element where only the URI is known.

Expected start element with given namespaceURI

Throws:
EXIException
java.io.IOException

decodeStartElementGeneric

void decodeStartElementGeneric()
                               throws EXIException,
                                      java.io.IOException
Reads generic start element.

Expected generic start element

Throws:
EXIException
java.io.IOException

decodeStartElementGenericUndeclared

void decodeStartElementGenericUndeclared()
                                         throws EXIException,
                                                java.io.IOException
Parses unexpected start element.

Throws:
EXIException
java.io.IOException

decodeStartFragmentSelfContained

void decodeStartFragmentSelfContained()
                                      throws EXIException,
                                             java.io.IOException
Reads EXI a self-contained start element

Throws:
EXIException
java.io.IOException

decodeEndElement

void decodeEndElement()
                      throws EXIException,
                             java.io.IOException
Reads EXI end element

Throws:
EXIException
java.io.IOException

decodeEndElementUndeclared

void decodeEndElementUndeclared()
                                throws EXIException,
                                       java.io.IOException
Reads unexpected EXI end element.

Throws:
EXIException
java.io.IOException

decodeAttributeXsiNil

void decodeAttributeXsiNil()
                           throws EXIException,
                                  java.io.IOException
Parses xsi:nil attribute

Throws:
EXIException
java.io.IOException

decodeAttributeXsiType

void decodeAttributeXsiType()
                            throws EXIException,
                                   java.io.IOException
Parses xsi:type attribute

Throws:
EXIException
java.io.IOException

decodeAttribute

void decodeAttribute()
                     throws EXIException,
                            java.io.IOException
Parses attribute

Throws:
EXIException
java.io.IOException

decodeAttributeNS

void decodeAttributeNS()
                       throws EXIException,
                              java.io.IOException
Parses expected attribute with given namespaceURI

Throws:
EXIException
java.io.IOException

decodeAttributeInvalidValue

void decodeAttributeInvalidValue()
                                 throws EXIException,
                                        java.io.IOException
Parses expected attribute with schema-invalid value (qname given)

Throws:
EXIException
java.io.IOException

decodeAttributeAnyInvalidValue

void decodeAttributeAnyInvalidValue()
                                    throws EXIException,
                                           java.io.IOException
Parses expected attribute with schema-invalid value (NO qname given)

Throws:
EXIException
java.io.IOException

decodeAttributeGeneric

void decodeAttributeGeneric()
                            throws EXIException,
                                   java.io.IOException
Parses expected generic attribute.

Throws:
EXIException
java.io.IOException

decodeAttributeGenericUndeclared

void decodeAttributeGenericUndeclared()
                                      throws EXIException,
                                             java.io.IOException
Parses unexpected attribute.

Throws:
EXIException
java.io.IOException

decodeNamespaceDeclaration

void decodeNamespaceDeclaration()
                                throws EXIException,
                                       java.io.IOException
Parses namespace declaration retrieving associated URI and prefix.

Throws:
EXIException
java.io.IOException

decodeCharacters

void decodeCharacters()
                      throws EXIException,
                             java.io.IOException
Decodes characters

Throws:
EXIException
java.io.IOException

decodeCharactersGeneric

void decodeCharactersGeneric()
                             throws EXIException,
                                    java.io.IOException
Decodes generic characters.

Throws:
EXIException
java.io.IOException

decodeCharactersGenericUndeclared

void decodeCharactersGenericUndeclared()
                                       throws EXIException,
                                              java.io.IOException
Decodes unexpected (generic) characters.

Throws:
EXIException
java.io.IOException

decodeDocType

void decodeDocType()
                   throws EXIException,
                          java.io.IOException
Parses DOCTYPE with information items

Throws:
EXIException
java.io.IOException

decodeEntityReference

void decodeEntityReference()
                           throws EXIException,
                                  java.io.IOException
Parses EntityReference

Throws:
EXIException
java.io.IOException

decodeComment

void decodeComment()
                   throws EXIException,
                          java.io.IOException
Parses comment with associated characters.

Throws:
EXIException
java.io.IOException

decodeProcessingInstruction

void decodeProcessingInstruction()
                                 throws EXIException,
                                        java.io.IOException
Parses processing instruction with associated target and data.

Throws:
EXIException
java.io.IOException

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

getElementQName

java.lang.String getElementQName()
Returns qualified name for element name

Returns:
String for qname

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

getAttributeQName

java.lang.String getAttributeQName()
Returns qualified name for (last) attribute

Returns:
String for qname

getAttributeValue

java.lang.String getAttributeValue()
Provides attribute value

Returns:
String for attribute value

getCharacters

char[] getCharacters()
Provides characters as well as significant/insignificant whitespace characters

Returns:
char[] 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

char[] getComment()
Provides comment text.

Returns:
String for comment text

getNamespaces

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

Returns:
NamespaceSupport for prefix mapping

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