From: Robert Varga Date: Sat, 1 Feb 2014 08:26:54 +0000 (+0100) Subject: BUG-472: Import OpenEXI nagasena-0000.0002.0035.0 X-Git-Tag: autorelease-tag-v20140601202136_82eb3f9~219 X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?p=controller.git;a=commitdiff_plain;h=1e81fa45ab0ced56eef0518c7e7f87857724985b BUG-472: Import OpenEXI nagasena-0000.0002.0035.0 This imports the OpenEXI nagasena library, on top of which the implementation will be built. Change-Id: I4ec0fc637f390fe14451c439870ec1846934ebbb Signed-off-by: Robert Varga --- diff --git a/opendaylight/netconf/pom.xml b/opendaylight/netconf/pom.xml index ab71180ba9..5dbf4423db 100644 --- a/opendaylight/netconf/pom.xml +++ b/opendaylight/netconf/pom.xml @@ -29,6 +29,7 @@ netconf-monitoring ietf-netconf-monitoring ietf-netconf-monitoring-extension + ../../third-party/org.openexi diff --git a/third-party/org.openexi/nagasena-rta/nagasena-rta-0000.0002.0035.0.jar b/third-party/org.openexi/nagasena-rta/nagasena-rta-0000.0002.0035.0.jar new file mode 100644 index 0000000000..060b171529 Binary files /dev/null and b/third-party/org.openexi/nagasena-rta/nagasena-rta-0000.0002.0035.0.jar differ diff --git a/third-party/org.openexi/nagasena-rta/pom.xml b/third-party/org.openexi/nagasena-rta/pom.xml new file mode 100644 index 0000000000..3e0da3ab4a --- /dev/null +++ b/third-party/org.openexi/nagasena-rta/pom.xml @@ -0,0 +1,65 @@ + + + + + 4.0.0 + + + org.opendaylight.controller.thirdparty + org.openexi + 0000.0002.0035.0 + + + org.opendaylight.controller.thirdparty + nagasena-rta + bundle + + + ${project.artifactId}-${project.version}.jar + + + + + + org.codehaus.mojo + truezip-maven-plugin + + + extract + + copy + + compile + + + + ${archive} + ${project.build.outputDirectory} + + ** + + + + + + + + org.apache.felix + maven-bundle-plugin + true + + + ${project.groupId}.${project.artifactId} + + + + + + + diff --git a/third-party/org.openexi/nagasena/nagasena-0000.0002.0035.0.jar b/third-party/org.openexi/nagasena/nagasena-0000.0002.0035.0.jar new file mode 100644 index 0000000000..c566f27d83 Binary files /dev/null and b/third-party/org.openexi/nagasena/nagasena-0000.0002.0035.0.jar differ diff --git a/third-party/org.openexi/nagasena/pom.xml b/third-party/org.openexi/nagasena/pom.xml new file mode 100644 index 0000000000..9094113aeb --- /dev/null +++ b/third-party/org.openexi/nagasena/pom.xml @@ -0,0 +1,65 @@ + + + + + 4.0.0 + + + org.opendaylight.controller.thirdparty + org.openexi + 0000.0002.0035.0 + + + org.opendaylight.controller.thirdparty + nagasena + bundle + + + ${project.artifactId}-${project.version}.jar + + + + + + org.codehaus.mojo + truezip-maven-plugin + + + extract + + copy + + compile + + + + ${archive} + ${project.build.outputDirectory} + + ** + + + + + + + + org.apache.felix + maven-bundle-plugin + true + + + ${project.groupId}.${project.artifactId} + + + + + + + diff --git a/third-party/org.openexi/nagasena/src/main/resources/doc/allclasses-frame.html b/third-party/org.openexi/nagasena/src/main/resources/doc/allclasses-frame.html new file mode 100644 index 0000000000..11f9ed5153 --- /dev/null +++ b/third-party/org.openexi/nagasena/src/main/resources/doc/allclasses-frame.html @@ -0,0 +1,85 @@ + + + + + + + +All Classes + + + + + + + + + + +All Classes +
+ + + + + +
AlignmentType +
+BinaryDataHandler +
+BinaryDataSink +
+BinaryDataSource +
+CharacterBuffer +
+Characters +
+EmptySchema +
+EntityResolverEx +
+EventDescription +
+EventType +
+EXIDecoder +
+EXIOptions +
+EXIReader +
+EXISchema +
+EXISchemaFactory +
+EXISchemaFactoryErrorHandler +
+EXISchemaFactoryException +
+EXISchemaReader +
+EXISchemaResolver +
+GrammarCache +
+GrammarOptions +
+HeaderOptionsOutputType +
+QName +
+ReaderSupport +
+SAXTransmogrifier +
+Scanner +
+Transmogrifier +
+TransmogrifierException +
+
+ + + diff --git a/third-party/org.openexi/nagasena/src/main/resources/doc/allclasses-noframe.html b/third-party/org.openexi/nagasena/src/main/resources/doc/allclasses-noframe.html new file mode 100644 index 0000000000..8f32ae6587 --- /dev/null +++ b/third-party/org.openexi/nagasena/src/main/resources/doc/allclasses-noframe.html @@ -0,0 +1,85 @@ + + + + + + + +All Classes + + + + + + + + + + +All Classes +
+ + + + + +
AlignmentType +
+BinaryDataHandler +
+BinaryDataSink +
+BinaryDataSource +
+CharacterBuffer +
+Characters +
+EmptySchema +
+EntityResolverEx +
+EventDescription +
+EventType +
+EXIDecoder +
+EXIOptions +
+EXIReader +
+EXISchema +
+EXISchemaFactory +
+EXISchemaFactoryErrorHandler +
+EXISchemaFactoryException +
+EXISchemaReader +
+EXISchemaResolver +
+GrammarCache +
+GrammarOptions +
+HeaderOptionsOutputType +
+QName +
+ReaderSupport +
+SAXTransmogrifier +
+Scanner +
+Transmogrifier +
+TransmogrifierException +
+
+ + + diff --git a/third-party/org.openexi/nagasena/src/main/resources/doc/constant-values.html b/third-party/org.openexi/nagasena/src/main/resources/doc/constant-values.html new file mode 100644 index 0000000000..6c4e3d2837 --- /dev/null +++ b/third-party/org.openexi/nagasena/src/main/resources/doc/constant-values.html @@ -0,0 +1,553 @@ + + + + + + + +Constant Field Values + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Overview  Package  Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Constant Field Values

+
+
+Contents + + + + + + +
+org.openexi.*
+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
org.openexi.proc.common.EventDescription
+public static final byteEVENT_AT3
+public static final byteEVENT_BLOB13
+public static final byteEVENT_CH6
+public static final byteEVENT_CM10
+public static final byteEVENT_DTD12
+public static final byteEVENT_ED1
+public static final byteEVENT_EE7
+public static final byteEVENT_ER11
+public static final byteEVENT_NL5
+public static final byteEVENT_NS8
+public static final byteEVENT_PI9
+public static final byteEVENT_SD0
+public static final byteEVENT_SE2
+public static final byteEVENT_TP4
+ +

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
org.openexi.proc.common.EventType
+public static final byteITEM_AT12
+public static final byteITEM_AT_WC_ANY_UNTYPED8
+public static final byteITEM_CH3
+public static final byteITEM_CM1
+public static final byteITEM_DTD10
+public static final byteITEM_ED4
+public static final byteITEM_EE9
+public static final byteITEM_ER2
+public static final byteITEM_NS7
+public static final byteITEM_PI0
+public static final byteITEM_SC6
+public static final byteITEM_SCHEMA_AT16
+public static final byteITEM_SCHEMA_AT_INVALID_VALUE23
+public static final byteITEM_SCHEMA_AT_WC_ANY17
+public static final byteITEM_SCHEMA_AT_WC_NS18
+public static final byteITEM_SCHEMA_CH19
+public static final byteITEM_SCHEMA_CH_MIXED20
+public static final byteITEM_SCHEMA_NIL21
+public static final byteITEM_SCHEMA_TYPE22
+public static final byteITEM_SCHEMA_WC_ANY14
+public static final byteITEM_SCHEMA_WC_NS15
+public static final byteITEM_SD13
+public static final byteITEM_SE11
+public static final byteITEM_SE_WC5
+ +

+ +

+ + + + + + + + + + + + + + + + + + + + + + +
org.openexi.proc.common.GrammarOptions
+public static final shortDEFAULT_OPTIONS2
+public static final shortOPTIONS_UNUSED0
+public static final shortSTRICT_OPTIONS1
+ +

+ +

+ + + + + + + + + + + + +
org.openexi.proc.io.CharacterBuffer
+public static final intBUFSIZE_DEFAULT4096
+ +

+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
org.openexi.sax.TransmogrifierException
+public static final intPREFIX_BOUND_TO_ANOTHER_NAMESPACE11
+public static final intPREFIX_NOT_BOUND10
+public static final intSAX_ERROR6
+public static final intSCRIBER_ERROR12
+public static final intUNEXPECTED_ATTR2
+public static final intUNEXPECTED_BINARY_VALUE4
+public static final intUNEXPECTED_CHARS3
+public static final intUNEXPECTED_ED8
+public static final intUNEXPECTED_ELEM1
+public static final intUNEXPECTED_END_ELEM7
+public static final intUNEXPECTED_SD9
+public static final intUNHANDLED_SAXPARSER_FEATURE5
+ +

+ +

+ + + + + + + + + + + + +
org.openexi.scomp.EXISchemaFactoryException
+public static final intXMLSCHEMA_ERROR1002
+ +

+ +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Overview  Package  Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+ + + diff --git a/third-party/org.openexi/nagasena/src/main/resources/doc/deprecated-list.html b/third-party/org.openexi/nagasena/src/main/resources/doc/deprecated-list.html new file mode 100644 index 0000000000..60ad3edb6c --- /dev/null +++ b/third-party/org.openexi/nagasena/src/main/resources/doc/deprecated-list.html @@ -0,0 +1,141 @@ + + + + + + + +Deprecated List + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Overview  Package  Class  Tree   Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Deprecated API

+
+
+Contents
    +
+ +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Overview  Package  Class  Tree   Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+ + + diff --git a/third-party/org.openexi/nagasena/src/main/resources/doc/help-doc.html b/third-party/org.openexi/nagasena/src/main/resources/doc/help-doc.html new file mode 100644 index 0000000000..81850ce70b --- /dev/null +++ b/third-party/org.openexi/nagasena/src/main/resources/doc/help-doc.html @@ -0,0 +1,214 @@ + + + + + + + +API Help + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Overview  Package  Class  Tree  Deprecated  Index   Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+How This API Document Is Organized

+
+This API (Application Programming Interface) document has pages corresponding to the items in the navigation bar, described as follows.

+Overview

+
+ +

+The Overview page is the front page of this API document and provides a list of all packages with a summary for each. This page can also contain an overall description of the set of packages.

+

+Package

+
+ +

+Each package has a page that contains a list of its classes and interfaces, with a summary for each. This page can contain four categories:

    +
  • Interfaces (italic)
  • Classes
  • Enums
  • Exceptions
  • Errors
  • Annotation Types
+
+

+Class/Interface

+
+ +

+Each class, interface, nested class and nested interface has its own separate page. Each of these pages has three sections consisting of a class/interface description, summary tables, and detailed member descriptions:

    +
  • Class inheritance diagram
  • Direct Subclasses
  • All Known Subinterfaces
  • All Known Implementing Classes
  • Class/interface declaration
  • Class/interface description +

    +

  • Nested Class Summary
  • Field Summary
  • Constructor Summary
  • Method Summary +

    +

  • Field Detail
  • Constructor Detail
  • Method Detail
+Each summary entry contains the first sentence from the detailed description for that item. The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.
+ +

+Annotation Type

+
+ +

+Each annotation type has its own separate page with the following sections:

    +
  • Annotation Type declaration
  • Annotation Type description
  • Required Element Summary
  • Optional Element Summary
  • Element Detail
+
+ +

+Enum

+
+ +

+Each enum has its own separate page with the following sections:

    +
  • Enum declaration
  • Enum description
  • Enum Constant Summary
  • Enum Constant Detail
+
+

+Tree (Class Hierarchy)

+
+There is a Class Hierarchy page for all packages, plus a hierarchy for each package. Each hierarchy page contains a list of classes and a list of interfaces. The classes are organized by inheritance structure starting with java.lang.Object. The interfaces do not inherit from java.lang.Object.
    +
  • When viewing the Overview page, clicking on "Tree" displays the hierarchy for all packages.
  • When viewing a particular package, class or interface page, clicking "Tree" displays the hierarchy for only that package.
+
+

+Deprecated API

+
+The Deprecated API page lists all of the API that have been deprecated. A deprecated API is not recommended for use, generally due to improvements, and a replacement API is usually given. Deprecated APIs may be removed in future implementations.
+

+Index

+
+The Index contains an alphabetic list of all classes, interfaces, constructors, methods, and fields.
+

+Prev/Next

+These links take you to the next or previous class, interface, package, or related page.

+Frames/No Frames

+These links show and hide the HTML frames. All pages are available with or without frames. +

+

+Serialized Form

+Each serializable or externalizable class has a description of its serialization fields and methods. This information is of interest to re-implementors, not to developers using the API. While there is no link in the navigation bar, you can get to this information by going to any serialized class and clicking "Serialized Form" in the "See also" section of the class description. +

+

+Constant Field Values

+The Constant Field Values page lists the static final fields and their values. +

+ + +This help file applies to API documentation generated using the standard doclet. + +
+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Overview  Package  Class  Tree  Deprecated  Index   Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+ + + diff --git a/third-party/org.openexi/nagasena/src/main/resources/doc/index-all.html b/third-party/org.openexi/nagasena/src/main/resources/doc/index-all.html new file mode 100644 index 0000000000..3fc6b297e3 --- /dev/null +++ b/third-party/org.openexi/nagasena/src/main/resources/doc/index-all.html @@ -0,0 +1,970 @@ + + + + + + + +Index + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Overview  Package  Class  Tree  Deprecated   Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +A B C D E F G H I L M N O P Q R S T U V W X _
+

+A

+
+
addCM(short) - +Static method in class org.openexi.proc.common.GrammarOptions +
Sets Preserve Comments to true. +
addDTD(short) - +Static method in class org.openexi.proc.common.GrammarOptions +
Sets Preserve Document Type Definition to true. +
addNS(short) - +Static method in class org.openexi.proc.common.GrammarOptions +
Sets Preserve Namespaces to true. +
addPI(short) - +Static method in class org.openexi.proc.common.GrammarOptions +
Sets Preserve Processing Instructions to true. +
AlignmentType - Enum in org.openexi.proc.common
AlignmentType represents one of the following bit alignment + styles so as to provide an extra degree of control over the + way information is stored in EXI format.
ancestryIds - +Variable in class org.openexi.schema.EXISchema +
  +
+
+

+B

+
+
binaryData(byte[], int, int, BinaryDataSink) - +Method in interface org.openexi.sax.BinaryDataHandler +
Writes a binary value where the schema expects a binary value. +
BinaryDataHandler - Interface in org.openexi.sax
 
BinaryDataSink - Interface in org.openexi.proc.io
BinaryDataSink represents a sink that accepts successive chunks of binary data.
BinaryDataSource - Class in org.openexi.proc.common
 
BinaryDataSource() - +Constructor for class org.openexi.proc.common.BinaryDataSource +
  +
BUFSIZE_DEFAULT - +Static variable in class org.openexi.proc.io.CharacterBuffer +
  +
+
+

+C

+
+
CharacterBuffer - Class in org.openexi.proc.io
 
CharacterBuffer(int) - +Constructor for class org.openexi.proc.io.CharacterBuffer +
  +
Characters - Class in org.openexi.schema
 
Characters(char[], int, int, boolean) - +Constructor for class org.openexi.schema.Characters +
  +
characters - +Variable in class org.openexi.schema.Characters +
  +
CHARACTERS_EMPTY - +Static variable in class org.openexi.schema.Characters +
  +
closeInputStream() - +Method in class org.openexi.proc.io.Scanner +
Close the input stream. +
compile(InputSource) - +Method in class org.openexi.scomp.EXISchemaFactory +
Compile an XML Schema Document into an EXISchema. +
+
+

+D

+
+
DEFAULT_OPTIONS - +Static variable in class org.openexi.proc.common.GrammarOptions +
Indicates that undeclared elements and attributes will be + processed when the XML stream is encoded and decoded. +
+
+

+E

+
+
EmptySchema - Class in org.openexi.schema
EmptySchema provides an EXISchema that supports all datatypes inherent + in XML Schema such as xsd:int and xsd:dateTime, but with no + user-specific definitions.
encode(InputSource) - +Method in class org.openexi.sax.Transmogrifier +
Parses XML input source and converts it to an EXI stream. +
endBinaryData(BinaryDataSink) - +Method in interface org.openexi.sax.BinaryDataHandler +
Mark the end of a binary value. +
EntityResolverEx - Interface in org.openexi.scomp
Extended SAX EntityResolver interface for resolving entities and + schema documents.
equals(Object) - +Method in class org.openexi.proc.common.QName +
  +
equals(Object) - +Method in class org.openexi.schema.Characters +
  +
error(EXISchemaFactoryException) - +Method in interface org.openexi.scomp.EXISchemaFactoryErrorHandler +
Report an error found during schema processing. +
EVENT_AT - +Static variable in interface org.openexi.proc.common.EventDescription +
Attribute event. +
EVENT_BLOB - +Static variable in interface org.openexi.proc.common.EventDescription +
BLOB event (content of an element). +
EVENT_CH - +Static variable in interface org.openexi.proc.common.EventDescription +
Character event (content of an element). +
EVENT_CM - +Static variable in interface org.openexi.proc.common.EventDescription +
Comment event. +
EVENT_DTD - +Static variable in interface org.openexi.proc.common.EventDescription +
Document Type Definition event. +
EVENT_ED - +Static variable in interface org.openexi.proc.common.EventDescription +
End Document event. +
EVENT_EE - +Static variable in interface org.openexi.proc.common.EventDescription +
End Element event. +
EVENT_ER - +Static variable in interface org.openexi.proc.common.EventDescription +
Entity Reference event. +
EVENT_NL - +Static variable in interface org.openexi.proc.common.EventDescription +
Attribute xsi:nil. +
EVENT_NS - +Static variable in interface org.openexi.proc.common.EventDescription +
Namespace declaration event. +
EVENT_PI - +Static variable in interface org.openexi.proc.common.EventDescription +
Processing Instruction event. +
EVENT_SD - +Static variable in interface org.openexi.proc.common.EventDescription +
Start Document event. +
EVENT_SE - +Static variable in interface org.openexi.proc.common.EventDescription +
Start Element event. +
EVENT_TP - +Static variable in interface org.openexi.proc.common.EventDescription +
Attribute xsi:type. +
EventDescription - Interface in org.openexi.proc.common
EventDescription provides accessors to the current EXI event data + during the decode process.
EventType - Class in org.openexi.proc.common
EventType denotes terminal symbols of grammar productions + defined in the EXI 1.0 specification.
EXIDecoder - Class in org.openexi.proc
EXIDecoder provides methods to configure and + instantiate a Scanner object + you can use to parse the contents of an EXI stream.
EXIDecoder() - +Constructor for class org.openexi.proc.EXIDecoder +
Creates an instance of EXIDecoder with the default inflator + buffer size of 8192 bytes. +
EXIDecoder(int, boolean) - +Constructor for class org.openexi.proc.EXIDecoder +
Creates an instance of EXIDecoder with the specified inflator buffer + size. +
EXIOptions - Class in org.openexi.proc.common
EXIOptions provides accessors for values associated with + EXI options in the EXI header of an EXI stream.
EXIReader - Class in org.openexi.sax
EXIReader implements the SAX XMLReader to provide a convenient and + familiar interface for decoding an EXI stream.
EXIReader() - +Constructor for class org.openexi.sax.EXIReader +
  +
EXISchema - Class in org.openexi.schema
EXISchema provides methods to read and write compiled EXI schemas.
EXISchemaFactory - Class in org.openexi.scomp
EXISchemaFactory compiles XML Schema into an EXISchema instance.
EXISchemaFactory() - +Constructor for class org.openexi.scomp.EXISchemaFactory +
  +
EXISchemaFactoryErrorHandler - Interface in org.openexi.scomp
This interface reports exceptions from EXISchemaFactory during schema + processing.
EXISchemaFactoryException - Exception in org.openexi.scomp
Any errors encountered during schema compilation are communicated to + an application as EXISchemaFactoryException objects.
EXISchemaReader - Class in org.openexi.scomp
EXISchemaReader parses EXI-encoded EXI Grammar into an EXISchema.
EXISchemaReader() - +Constructor for class org.openexi.scomp.EXISchemaReader +
  +
EXISchemaResolver - Interface in org.openexi.proc
Developers have the option of implementing the EXISchemaResolver interface + to help EXIReader and EXIDecoder locate the correct grammar cache for parsing + an EXI stream.
+
+

+F

+
+
fatalError(EXISchemaFactoryException) - +Method in interface org.openexi.scomp.EXISchemaFactoryErrorHandler +
Report a fatal error found during schema processing. +
+
+

+G

+
+
getAlignmentType() - +Method in class org.openexi.proc.common.EXIOptions +
Get the bit alignment setting. +
getBinaryDataSource() - +Method in interface org.openexi.proc.common.EventDescription +
Gets the value of an EVENT_BLOB. +
getBlockSize() - +Method in class org.openexi.proc.common.EXIOptions +
Returns the number of element and attribute values that are read and processed + as a group. +
getByteArray() - +Method in class org.openexi.proc.common.BinaryDataSource +
  +
getCharacters() - +Method in interface org.openexi.proc.common.EventDescription +
Gets the value of an EVENT_CH, + Attribute (EVENT_AT, EVENT_NL, EVENT_TP), EVENT_CM, + EVENT_DTD or EVENT_PI event. +
getCode() - +Method in exception org.openexi.sax.TransmogrifierException +
Returns a code that represents the type of the exception. +
getCode() - +Method in exception org.openexi.scomp.EXISchemaFactoryException +
Returns a code that represents the type of the exception. +
getContentHandler() - +Method in class org.openexi.sax.ReaderSupport +
Get the SAX content handler currently in use. +
getDatatypeRepresentationMap() - +Method in class org.openexi.proc.common.EXIOptions +
Returns an array of qualified names that map XMLSchema datatypes to + non-standard equivalents in EXI. +
getDatatypeRepresentationMapBindingsCount() - +Method in class org.openexi.proc.common.EXIOptions +
Returns the number of Datatype Representation Map QName pairs. +
getEventKind() - +Method in interface org.openexi.proc.common.EventDescription +
Gets the event kind of which instance data this EventDescription is describing. +
getEventType() - +Method in interface org.openexi.proc.common.EventDescription +
Returns the EventType from which this event is derived. +
getException() - +Method in exception org.openexi.sax.TransmogrifierException +
Returns an Exception object. +
getException() - +Method in exception org.openexi.scomp.EXISchemaFactoryException +
Returns an Exception object. +
getEXISchema() - +Method in class org.openexi.proc.grammars.GrammarCache +
Gets the compiled EXI Schema. +
getEXISchema() - +Static method in class org.openexi.schema.EmptySchema +
Returns an EXISchema that supports all datatypes inherent in XML Schema. +
getFeature(String) - +Method in class org.openexi.sax.EXIReader +
Get features for the SAX parser. +
getGrammarCache() - +Method in interface org.openexi.sax.SAXTransmogrifier +
Returns the GrammarCache that is in use by this SAXTransmogrifier. +
getGrammarCache() - +Method in class org.openexi.sax.Transmogrifier +
Returns the GrammarCache that was previously set. +
getHeaderOptions() - +Method in class org.openexi.proc.io.Scanner +
Returns the EXI Header options from the header of the + EXI stream, if present. +
getLength() - +Method in class org.openexi.proc.common.BinaryDataSource +
  +
getLocator() - +Method in exception org.openexi.sax.TransmogrifierException +
Returns the locator that is associated with this compilation error. +
getLocator() - +Method in exception org.openexi.scomp.EXISchemaFactoryException +
Returns the locator that is associated with this compilation error. +
getMessage() - +Method in exception org.openexi.sax.TransmogrifierException +
Returns a message that describes the exception. +
getMessage() - +Method in exception org.openexi.scomp.EXISchemaFactoryException +
Returns a message that describes the exception. +
getName() - +Method in interface org.openexi.proc.common.EventDescription +
Gets the name of the EXI event. +
getPrefix() - +Method in interface org.openexi.proc.common.EventDescription +
Gets the namespace prefix of the event. +
getPreserveComments() - +Method in class org.openexi.proc.common.EXIOptions +
Returns whether comments are conserved in the EXI Stream. +
getPreserveDTD() - +Method in class org.openexi.proc.common.EXIOptions +
Returns whether the document type definition is conserved in the EXI Stream. +
getPreserveLexicalValues() - +Method in class org.openexi.proc.common.EXIOptions +
Returns whether lexical values (literal strings) are preserved rather + than the logical values of elements and attributes. +
getPreserveNS() - +Method in class org.openexi.proc.common.EXIOptions +
Returns whether the namespaces are preserved in the EXI stream. +
getPreservePIs() - +Method in class org.openexi.proc.common.EXIOptions +
Returns whether processing instructions are conserved in the EXI Stream. +
getProperty(String) - +Method in class org.openexi.sax.EXIReader +
Use to retrieve the name of the lexical handler, currently the only + property recognized by this class. +
getRemainingBytesCount() - +Method in class org.openexi.proc.common.BinaryDataSource +
  +
getSAXTransmogrifier() - +Method in class org.openexi.sax.Transmogrifier +
Returns the SAXTransmogrifier, which implements both the ContentHandler + and LexicalHandler. +
getStartIndex() - +Method in class org.openexi.proc.common.BinaryDataSource +
  +
getURI() - +Method in interface org.openexi.proc.common.EventDescription +
Gets the URI of the EXI event. +
getValueMaxLength() - +Method in class org.openexi.proc.common.EXIOptions +
Returns the maximum length in characters of strings that will be included + in the String Table. +
getValuePartitionCapacity() - +Method in class org.openexi.proc.common.EXIOptions +
Returns the maximum number of entries in the String Table. +
GrammarCache - Class in org.openexi.proc.grammars
A GrammarCache object represents a set of EXI grammars used + for processing EXI streams using specific grammar options.
GrammarCache(EXISchema) - +Constructor for class org.openexi.proc.grammars.GrammarCache +
Creates an instance of GrammarCache informed by a schema with default + grammar options. +
GrammarCache(short) - +Constructor for class org.openexi.proc.grammars.GrammarCache +
Creates an instance of GrammarCache with the specified grammar options. +
GrammarCache(EXISchema, short) - +Constructor for class org.openexi.proc.grammars.GrammarCache +
Creates an instance of GrammarCache informed by a schema with the + specified grammar options. +
GrammarOptions - Class in org.openexi.proc.common
GrammarOptions computes a short integer that represents settings in the EXI Grammar settings + that determine how an EXI file will be encoded or decoded.
grammarOptions - +Variable in class org.openexi.proc.grammars.GrammarCache +
Short integer that encapsulates GrammarOptions + for the EXI stream. +
+
+

+H

+
+
hasCM(short) - +Static method in class org.openexi.proc.common.GrammarOptions +
Returns true if Preserve Comments is true. +
hasDTD(short) - +Static method in class org.openexi.proc.common.GrammarOptions +
Returns true if Preserve Document Type Definition is true. +
hashCode() - +Method in class org.openexi.schema.Characters +
  +
hasNext() - +Method in class org.openexi.proc.common.BinaryDataSource +
  +
hasNS(short) - +Static method in class org.openexi.proc.common.GrammarOptions +
Returns true if Preserve Namespaces is true. +
hasPI(short) - +Static method in class org.openexi.proc.common.GrammarOptions +
Returns true if Preserve Processing Instructions is true. +
HeaderOptionsOutputType - Enum in org.openexi.proc
This enumeration provides three possible settings for header options output.
+
+

+I

+
+
indexOf(char) - +Method in class org.openexi.schema.Characters +
  +
isFragment() - +Method in class org.openexi.proc.common.EXIOptions +
An XML fragment is a non-compliant XML document with multiple root + elements. +
isPermitDeviation(short) - +Static method in class org.openexi.proc.common.GrammarOptions +
Returns true if DEFAULT_OPTIONS is set to true. +
isSimpleType(int) - +Method in class org.openexi.schema.EXISchema +
  +
isStrict() - +Method in class org.openexi.proc.common.EXIOptions +
The Strict option applies to streams that have an associated XML Schema + and the data in the XML stream is 100% compliant with the schema. +
isVolatile - +Variable in class org.openexi.schema.Characters +
  +
ITEM_AT - +Static variable in class org.openexi.proc.common.EventType +
Event type for an Attribute learned by built-in element grammars + from prior attribute occurrences. +
ITEM_AT_WC_ANY_UNTYPED - +Static variable in class org.openexi.proc.common.EventType +
Wildcard event type for an Attribute where the attribute's defined + datatype (if any) is disregarded. +
ITEM_CH - +Static variable in class org.openexi.proc.common.EventType +
Event type for a Character event (character events store values as strings). +
ITEM_CM - +Static variable in class org.openexi.proc.common.EventType +
Event type for a Comment. +
ITEM_DTD - +Static variable in class org.openexi.proc.common.EventType +
Event type for a Document Type Definition. +
ITEM_ED - +Static variable in class org.openexi.proc.common.EventType +
Event type for End of Document. +
ITEM_EE - +Static variable in class org.openexi.proc.common.EventType +
Event type for End of Element. +
ITEM_ER - +Static variable in class org.openexi.proc.common.EventType +
Event type for an Entity Reference. +
ITEM_NS - +Static variable in class org.openexi.proc.common.EventType +
Event type for a Namespace declaration. +
ITEM_PI - +Static variable in class org.openexi.proc.common.EventType +
Event type for a Processing Instruction. +
ITEM_SC - +Static variable in class org.openexi.proc.common.EventType +
Self-contained items are not supported in this release of OpenEXI. +
ITEM_SCHEMA_AT - +Static variable in class org.openexi.proc.common.EventType +
Event type for AttributeUse that matches an attribute event with + a valid value. +
ITEM_SCHEMA_AT_INVALID_VALUE - +Static variable in class org.openexi.proc.common.EventType +
Event type for AttributeUse that matches an attribute event with an + invalid value. +
ITEM_SCHEMA_AT_WC_ANY - +Static variable in class org.openexi.proc.common.EventType +
Attribute wildcard event type stemming from a schema, where the attribute's + defined datatype (if any) is applied. +
ITEM_SCHEMA_AT_WC_NS - +Static variable in class org.openexi.proc.common.EventType +
Attribute wildcard event type, qualified with a specific namespace, stemming + from a schema where the attribute's defined datatype (if any) is applied. +
ITEM_SCHEMA_CH - +Static variable in class org.openexi.proc.common.EventType +
Event type for a defined Character event in an EXI stream processed + using a schema. +
ITEM_SCHEMA_CH_MIXED - +Static variable in class org.openexi.proc.common.EventType +
Event type for a Character event that occurs in the context of an element + defined so as to permit mixed content (mark up and data) in an EXI + stream processed using a schema. +
ITEM_SCHEMA_NIL - +Static variable in class org.openexi.proc.common.EventType +
Special Attribute that indicates the value of the associated element is + explicitly nil rather than an empty string. +
ITEM_SCHEMA_TYPE - +Static variable in class org.openexi.proc.common.EventType +
Special Attribute that describes a data type for the associated + element. +
ITEM_SCHEMA_WC_ANY - +Static variable in class org.openexi.proc.common.EventType +
Attribute wildcard event type stemming from a schema where the + attribute's defined datatype (if any) is applied. +
ITEM_SCHEMA_WC_NS - +Static variable in class org.openexi.proc.common.EventType +
Event type for an element defined in a namespace in an EXI stream + processed using a schema. +
ITEM_SD - +Static variable in class org.openexi.proc.common.EventType +
Event type for Start Document. +
ITEM_SE - +Static variable in class org.openexi.proc.common.EventType +
Event type for Start Element. +
ITEM_SE_WC - +Static variable in class org.openexi.proc.common.EventType +
Wildcard event type for an element. +
+
+

+L

+
+
length - +Variable in class org.openexi.schema.Characters +
  +
localName - +Variable in class org.openexi.proc.common.QName +
Local name of the datatype. +
+
+

+M

+
+
makeString() - +Method in class org.openexi.schema.Characters +
  +
+
+

+N

+
+
name - +Variable in class org.openexi.proc.common.EventType +
Local name of event type definition. +
namespaceName - +Variable in class org.openexi.proc.common.QName +
If namespaceName is null, this indicates a failure of + namespace-prefix binding. +
next() - +Method in class org.openexi.proc.common.BinaryDataSource +
  +
nextEvent() - +Method in class org.openexi.proc.io.Scanner +
Gets the next event from the EXI stream. +
+
+

+O

+
+
OPTIONS_UNUSED - +Static variable in class org.openexi.proc.common.GrammarOptions +
OPTIONS_UNUSED is an internal value. +
org.openexi.proc - package org.openexi.proc
+ + +The Proc (Processor) package contains the EXIDecoder, which is used to convert EXI streams to XML format.
org.openexi.proc.common - package org.openexi.proc.common
+ + +The common package contains classes, interfaces, and enumerators that define the vocabulary used to describe EXI streams (events, options, alignment, and character string values).
org.openexi.proc.grammars - package org.openexi.proc.grammars
+ + +The grammars package contains the GrammarCache, which combines an XML Schema Definition with EXI grammar options to create an EXI Schema.
org.openexi.proc.io - package org.openexi.proc.io
+ + +The IO package contains the Scanner, which is used by EXIDecoder to read and interpret EXI streams.
org.openexi.sax - package org.openexi.sax
+ + +The SAX package contains the Transmogrifier, which encodes an XML file to an EXI stream, and the EXIReader, which restores an EXI stream to its logical XML equivalent.
org.openexi.schema - package org.openexi.schema
+ + +The schema package contains classes that are used to represent XML Schema Documents (XSDs).
org.openexi.scomp - package org.openexi.scomp
+ + +The scomp (schema compiler) package contains the EXISchemaFactory, which is used to compile XML Schema Documents (XSDs) to EXISchemas.
+
+

+P

+
+
parse(InputStream) - +Method in class org.openexi.scomp.EXISchemaReader +
Parses EXI-encoded EXI Grammar into an EXISchema. +
PREFIX_BOUND_TO_ANOTHER_NAMESPACE - +Static variable in exception org.openexi.sax.TransmogrifierException +
Prefix is bound to another namespace. +
PREFIX_NOT_BOUND - +Static variable in exception org.openexi.sax.TransmogrifierException +
Prefix is not bound. +
processHeader() - +Method in class org.openexi.proc.EXIDecoder +
This method reads and configures any header options present + in the EXI stream, then returns a Scanner + object you can use to parse the values from the EXI stream. +
+
+

+Q

+
+
QName - Class in org.openexi.proc.common
QName is a pair comprised of a namespace name and a local name + to be used in a Datatype Representation Map (DTRM) definition + to denote an XSD datatype or an EXI datatype representation.
QName() - +Constructor for class org.openexi.proc.common.QName +
  +
QName(String, String) - +Constructor for class org.openexi.proc.common.QName +
Creates a QName based on its literal qualified name + (see http://www.w3.org/TR/xml-names/#ns-qualnames + for definition) and namespace name. +
+
+

+R

+
+
ReaderSupport - Class in org.openexi.sax
 
readIn(DataInputStream) - +Static method in class org.openexi.schema.EXISchema +
Reads an EXI Schema from a DataInputStream. +
resolveEntity(String, String, String) - +Method in interface org.openexi.scomp.EntityResolverEx +
This method will be called for resolving schema documents upon + occurrences of XML Schema directives such as "include", "import" and + "redefine" within schemas. +
resolveSchema(String, short) - +Method in interface org.openexi.proc.EXISchemaResolver +
Return a GrammarCache based on a schemaId and grammar options discovered + in the header options of an EXI stream. +
+
+

+S

+
+
SAX_ERROR - +Static variable in exception org.openexi.sax.TransmogrifierException +
SAX error reported by XML parser. +
SAXTransmogrifier - Interface in org.openexi.sax
Applications can directly feed SAX events into a transmogrifier through SAXTransmogrifier.
Scanner - Class in org.openexi.proc.io
The Scanner class provides methods for scanning events + in the body of an EXI stream.
SCRIBER_ERROR - +Static variable in exception org.openexi.sax.TransmogrifierException +
Errors reported by Scriber. +
setAlignmentType(AlignmentType) - +Method in class org.openexi.proc.EXIDecoder +
Set the bit alignment style of the stream to be decoded. +
setAlignmentType(AlignmentType) - +Method in class org.openexi.sax.EXIReader +
Set the bit alignment style used to compile the EXI input stream. +
setAlignmentType(AlignmentType) - +Method in class org.openexi.sax.Transmogrifier +
Set the bit alignment style for the encoded EXI stream. +
setBinaryChunkSize(int) - +Method in class org.openexi.proc.io.Scanner +
Binary values are read in chunks of the specified size when the + use of binary data is enabled. +
setBlockSize(int) - +Method in class org.openexi.proc.EXIDecoder +
Set the size, in number of values, of the information that will be + processed as a chunk of the entire EXI stream. +
setBlockSize(int) - +Method in class org.openexi.sax.EXIReader +
Set the size, in number of values, of the information that will be + processed as a chunk of the entire EXI stream. +
setBlockSize(int) - +Method in class org.openexi.sax.Transmogrifier +
Set the size, in number of values, of the information that will be + processed as a chunk of the entire XML stream. +
setCompilerErrorHandler(EXISchemaFactoryErrorHandler) - +Method in class org.openexi.scomp.EXISchemaFactory +
Set an error handler to report any errors encountered during + schema compilation. +
setContentHandler(ContentHandler) - +Method in class org.openexi.sax.ReaderSupport +
Set a SAX content handler to receive SAX events. +
setDatatypeRepresentationMap(QName[], int) - +Method in class org.openexi.proc.EXIDecoder +
Set a datatype representation map (DTRM). +
setDatatypeRepresentationMap(QName[], int) - +Method in class org.openexi.sax.EXIReader +
Set a datatype representation map. +
setDatatypeRepresentationMap(QName[], int) - +Method in class org.openexi.sax.Transmogrifier +
Set a datatype representation map (DTRM). +
setEnableBinaryData(boolean) - +Method in class org.openexi.proc.EXIDecoder +
Each binary value will be returned as in a EventDescription of EVENT_BLOB + instead of EVENT_CH when enabled. +
setEntityResolver(EntityResolver) - +Method in class org.openexi.sax.Transmogrifier +
Set an external SAX entity resolver. +
setEntityResolver(EntityResolverEx) - +Method in class org.openexi.scomp.EXISchemaFactory +
Set an entity resolver for use to resolve entities and schema documents. +
setEXISchemaResolver(EXISchemaResolver) - +Method in class org.openexi.sax.EXIReader +
Set the EXISchemaResolver to retrieve the schema needed to decode the + current EXI stream. +
setFeature(String, boolean) - +Method in class org.openexi.sax.EXIReader +
Set features for the SAX parser. +
setFragment(boolean) - +Method in class org.openexi.proc.EXIDecoder +
Set whether the document is a fragment. +
setFragment(boolean) - +Method in class org.openexi.sax.EXIReader +
Set to true if the EXI input stream is an XML fragment (a non-compliant + XML document with multiple root elements). +
setFragment(boolean) - +Method in class org.openexi.sax.Transmogrifier +
Set to true if the XML input stream is an XML fragment (a non-compliant + XML document with multiple root elements). +
setGrammarCache(GrammarCache) - +Method in class org.openexi.proc.EXIDecoder +
Set the GrammarCache used in decoding EXI streams. +
setGrammarCache(GrammarCache) - +Method in class org.openexi.sax.ReaderSupport +
Set the GrammarCache used in parsing EXI streams. +
setGrammarCache(GrammarCache) - +Method in class org.openexi.sax.Transmogrifier +
Set the GrammarCache used in transmogrifying XML data to EXI. +
setGrammarCache(GrammarCache, SchemaId) - +Method in class org.openexi.sax.Transmogrifier +
Set the GrammarCache to be used in encoding XML streams into EXI streams + by the transmogrifier. +
setInitialBinaryDataBufferSize(int) - +Method in class org.openexi.proc.EXIDecoder +
  +
setInputStream(InputStream) - +Method in class org.openexi.proc.EXIDecoder +
Set an input stream from which the encoded stream is read. +
setLexicalHandler(LexicalHandler) - +Method in class org.openexi.sax.EXIReader +
Set a SAX lexical handler to receive SAX lexical events. +
setOutputCookie(boolean) - +Method in class org.openexi.sax.Transmogrifier +
Tells the encoder whether to or not to start the stream by + adding an EXI cookie. +
setOutputOptions(HeaderOptionsOutputType) - +Method in class org.openexi.sax.Transmogrifier +
Set the header output options. +
setOutputStream(OutputStream) - +Method in class org.openexi.sax.Transmogrifier +
Set an output stream to which encoded streams are written. +
setPreserveLexicalValues(boolean) - +Method in class org.openexi.proc.EXIDecoder +
Set to true to preserve the original string values from the EXI + stream. +
setPreserveLexicalValues(boolean) - +Method in class org.openexi.sax.EXIReader +
Set to true if the EXI input stream was compiled with the Preserve Lexical + Values set to true. +
setPreserveLexicalValues(boolean) - +Method in class org.openexi.sax.Transmogrifier +
Set to true to preserve the original string values from the XML + stream. +
setPreserveWhitespaces(boolean) - +Method in class org.openexi.sax.Transmogrifier +
Set to true to preserve whitespace (for example, spaces, tabs, and + line breaks) in the encoded EXI stream. +
setProperty(String, Object) - +Method in class org.openexi.sax.EXIReader +
This method wraps the friendlier setLexicalHandler method to provide + syntax familiar to experienced SAX programmers. +
setResolveExternalGeneralEntities(boolean) - +Method in class org.openexi.sax.Transmogrifier +
Change the way a Transmogrifier handles external general entities. +
setSchema(EXISchema, QName[], int) - +Method in class org.openexi.proc.io.Scanner +
  +
setValueMaxLength(int) - +Method in class org.openexi.proc.EXIDecoder +
Set the maximum length of a string that will be stored for reuse in the + String Table. +
setValueMaxLength(int) - +Method in class org.openexi.sax.EXIReader +
Set the maximum length of a string that will be stored for reuse in the + String Table. +
setValueMaxLength(int) - +Method in class org.openexi.sax.Transmogrifier +
Set the maximum length of a string that will be stored for reuse in the + String Table. +
setValuePartitionCapacity(int) - +Method in class org.openexi.proc.EXIDecoder +
Set the maximum number of values in the String Table. +
setValuePartitionCapacity(int) - +Method in class org.openexi.sax.EXIReader +
Set the maximum number of values in the String Table. +
setValuePartitionCapacity(int) - +Method in class org.openexi.sax.Transmogrifier +
Set the maximum number of values in the String Table. +
startBinaryData(long) - +Method in interface org.openexi.sax.BinaryDataHandler +
Mark the start of a binary value. +
startIndex - +Variable in class org.openexi.schema.Characters +
  +
STRICT_OPTIONS - +Static variable in class org.openexi.proc.common.GrammarOptions +
Indicates that undeclared elements and attributes will throw an + exception when the XML stream is encoded and decoded. +
substring(int, int) - +Method in class org.openexi.schema.Characters +
  +
+
+

+T

+
+
Transmogrifier - Class in org.openexi.sax
The Transmogrifier converts an XML stream to an EXI stream.
Transmogrifier() - +Constructor for class org.openexi.sax.Transmogrifier +
Create an instance of the Transmogrifier with a default SAX parser. +
Transmogrifier(SAXParserFactory) - +Constructor for class org.openexi.sax.Transmogrifier +
Create an instance of the Transmogrifier, specifying the SAXParserFactory + from which to create the SAX parser. +
TransmogrifierException - Exception in org.openexi.sax
Exception handler for the Transmogrifier.
turnPermanent() - +Method in class org.openexi.schema.Characters +
  +
+
+

+U

+
+
ucsCount - +Variable in class org.openexi.schema.Characters +
  +
UNEXPECTED_ATTR - +Static variable in exception org.openexi.sax.TransmogrifierException +
Unexpected Attribute. +
UNEXPECTED_BINARY_VALUE - +Static variable in exception org.openexi.sax.TransmogrifierException +
Unexpected Binary value. +
UNEXPECTED_CHARS - +Static variable in exception org.openexi.sax.TransmogrifierException +
Unexpected Character Sequence. +
UNEXPECTED_ED - +Static variable in exception org.openexi.sax.TransmogrifierException +
Unexpected End of Document event. +
UNEXPECTED_ELEM - +Static variable in exception org.openexi.sax.TransmogrifierException +
Unexpected Element. +
UNEXPECTED_END_ELEM - +Static variable in exception org.openexi.sax.TransmogrifierException +
Unexpected End of Element event. +
UNEXPECTED_SD - +Static variable in exception org.openexi.sax.TransmogrifierException +
Unexpected Start of Document event. +
UNHANDLED_SAXPARSER_FEATURE - +Static variable in exception org.openexi.sax.TransmogrifierException +
Unhandled SAX parser feature. +
uri - +Variable in class org.openexi.proc.common.EventType +
URI of event type definition. +
+
+

+V

+
+
valueOf(String) - +Static method in enum org.openexi.proc.common.AlignmentType +
Returns the enum constant of this type with the specified name. +
valueOf(String) - +Static method in enum org.openexi.proc.HeaderOptionsOutputType +
Returns the enum constant of this type with the specified name. +
values() - +Static method in enum org.openexi.proc.common.AlignmentType +
Returns an array containing the constants of this enum type, in +the order they're declared. +
values() - +Static method in enum org.openexi.proc.HeaderOptionsOutputType +
Returns an array containing the constants of this enum type, in +the order they're declared. +
+
+

+W

+
+
warning(EXISchemaFactoryException) - +Method in interface org.openexi.scomp.EXISchemaFactoryErrorHandler +
Report a warning found during schema processing. +
writeOut(DataOutputStream) - +Method in class org.openexi.schema.EXISchema +
Writes out a serialized EXISchema. +
writeXml(OutputStream, boolean) - +Method in class org.openexi.schema.EXISchema +
  +
+
+

+X

+
+
XMLSCHEMA_ERROR - +Static variable in exception org.openexi.scomp.EXISchemaFactoryException +
The underlying XMLSchema parser found an error in the schema. +
+
+

+_

+
+
_isSimpleType(int, int[]) - +Static method in class org.openexi.schema.EXISchema +
  +
+
+A B C D E F G H I L M N O P Q R S T U V W X _ + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Overview  Package  Class  Tree  Deprecated   Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+ + + diff --git a/third-party/org.openexi/nagasena/src/main/resources/doc/index.html b/third-party/org.openexi/nagasena/src/main/resources/doc/index.html new file mode 100644 index 0000000000..f8c172cd85 --- /dev/null +++ b/third-party/org.openexi/nagasena/src/main/resources/doc/index.html @@ -0,0 +1,40 @@ + + + + + + + +Generated Documentation (Untitled) + + + + + + + + + + + +<H2> +Frame Alert</H2> + +<P> +This document is designed to be viewed using the frames feature. If you see this message, you are using a non-frame-capable web client. +<BR> +Link to<A HREF="overview-summary.html">Non-frame version.</A> + + + diff --git a/third-party/org.openexi/nagasena/src/main/resources/doc/org/openexi/proc/EXIDecoder.html b/third-party/org.openexi/nagasena/src/main/resources/doc/org/openexi/proc/EXIDecoder.html new file mode 100644 index 0000000000..15bd150a78 --- /dev/null +++ b/third-party/org.openexi/nagasena/src/main/resources/doc/org/openexi/proc/EXIDecoder.html @@ -0,0 +1,580 @@ + + + + + + + +EXIDecoder + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Overview  Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +org.openexi.proc +
+Class EXIDecoder

+
+java.lang.Object
+  extended by org.openexi.proc.EXIDecoder
+
+
+
+
public class EXIDecoder
extends java.lang.Object
+ + +

+EXIDecoder provides methods to configure and + instantiate a Scanner object + you can use to parse the contents of an EXI stream. +

+ +

+

+ +
+
+ +

+ + + + + + + + + + + + + + +
+Constructor Summary
EXIDecoder() + +
+          Creates an instance of EXIDecoder with the default inflator + buffer size of 8192 bytes.
EXIDecoder(int inflatorBufSize, + boolean useThreadedInflater) + +
+          Creates an instance of EXIDecoder with the specified inflator buffer + size.
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ ScannerprocessHeader() + +
+          This method reads and configures any header options present + in the EXI stream, then returns a Scanner + object you can use to parse the values from the EXI stream.
+ voidsetAlignmentType(AlignmentType alignmentType) + +
+          Set the bit alignment style of the stream to be decoded.
+ voidsetBlockSize(int blockSize) + +
+          Set the size, in number of values, of the information that will be + processed as a chunk of the entire EXI stream.
+ voidsetDatatypeRepresentationMap(QName[] dtrm, + int n_bindings) + +
+          Set a datatype representation map (DTRM).
+ voidsetEnableBinaryData(boolean enable) + +
+          Each binary value will be returned as in a EventDescription of EVENT_BLOB + instead of EVENT_CH when enabled.
+ voidsetFragment(boolean isFragment) + +
+          Set whether the document is a fragment.
+ voidsetGrammarCache(GrammarCache grammarCache) + +
+          Set the GrammarCache used in decoding EXI streams.
+ voidsetInitialBinaryDataBufferSize(int initialSize) + +
+           
+ voidsetInputStream(java.io.InputStream istream) + +
+          Set an input stream from which the encoded stream is read.
+ voidsetPreserveLexicalValues(boolean preserveLexicalValues) + +
+          Set to true to preserve the original string values from the EXI + stream.
+ voidsetValueMaxLength(int valueMaxLength) + +
+          Set the maximum length of a string that will be stored for reuse in the + String Table.
+ voidsetValuePartitionCapacity(int valuePartitionCapacity) + +
+          Set the maximum number of values in the String Table.
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+EXIDecoder

+
+public EXIDecoder()
+
+
Creates an instance of EXIDecoder with the default inflator + buffer size of 8192 bytes. Buffer size is only used when + the EXI stream is encoded with EXI compression. +

+

+
+ +

+EXIDecoder

+
+public EXIDecoder(int inflatorBufSize,
+                  boolean useThreadedInflater)
+
+
Creates an instance of EXIDecoder with the specified inflator buffer + size. When dynamic memory is limited on the target device, reducing + the buffer size can improve performance and avoid runtime errors. Buffer + size is only used when the EXI stream is encoded with EXI compression. +

+

+
Parameters:
inflatorBufSize - size of the buffer, in bytes.
useThreadedInflater - Inflater will be run in its own thread if true
+
+ + + + + + + + +
+Method Detail
+ +

+setInputStream

+
+public final void setInputStream(java.io.InputStream istream)
+
+
Set an input stream from which the encoded stream is read. +

+

+
Parameters:
istream - InputSream to be read.
+
+
+
+ +

+setAlignmentType

+
+public final void setAlignmentType(AlignmentType alignmentType)
+                            throws org.openexi.proc.common.EXIOptionsException
+
+
Set the bit alignment style of the stream to be decoded. +

+

+
Parameters:
alignmentType - AlignmentType object +
Throws: +
org.openexi.proc.common.EXIOptionsException
+
+
+
+ +

+setFragment

+
+public final void setFragment(boolean isFragment)
+
+
Set whether the document is a fragment. Fragments are nonstandard + XML documents with multiple root elements. Default is false. +

+

+
Parameters:
isFragment - true if the stream is an XML fragment
+
+
+
+ +

+setGrammarCache

+
+public final void setGrammarCache(GrammarCache grammarCache)
+                           throws org.openexi.proc.common.EXIOptionsException
+
+
Set the GrammarCache used in decoding EXI streams. +

+

+
Parameters:
grammarCache - GrammarCache +
Throws: +
org.openexi.proc.common.EXIOptionsException
+
+
+
+ +

+setBlockSize

+
+public final void setBlockSize(int blockSize)
+                        throws org.openexi.proc.common.EXIOptionsException
+
+
Set the size, in number of values, of the information that will be + processed as a chunk of the entire EXI stream. Reducing the block size + can improve performance for devices with limited dynamic memory. + Default is 1,000,000 items (not 1MB, but 1,000,000 complete Attribute + and Element values). Block size is only used when the EXI stream is + encoded with EXI-compression. +

+

+
Parameters:
blockSize - number of values in each processing block. Default is 1,000,000. +
Throws: +
org.openexi.proc.common.EXIOptionsException
+
+
+
+ +

+setValueMaxLength

+
+public final void setValueMaxLength(int valueMaxLength)
+
+
Set the maximum length of a string that will be stored for reuse in the + String Table. By default, there is no maximum length. However, in data + sets that have long, unique strings of information, you can improve + performance by limiting the size to the length of strings that are more + likely to appear more than once. +

+

+
Parameters:
valueMaxLength - maximum length of entries in the String Table.
+
+
+
+ +

+setValuePartitionCapacity

+
+public final void setValuePartitionCapacity(int valuePartitionCapacity)
+
+
Set the maximum number of values in the String Table. By default, there + is no limit. If the target device has limited dynamic memory, limiting + the number of entries in the String Table can improve performance and + reduce the likelihood that you will exceed memory capacity. +

+

+
Parameters:
valuePartitionCapacity - maximum number of entries in the String Table
+
+
+
+ +

+setPreserveLexicalValues

+
+public final void setPreserveLexicalValues(boolean preserveLexicalValues)
+                                    throws org.openexi.proc.common.EXIOptionsException
+
+
Set to true to preserve the original string values from the EXI + stream. For example, a date string might be converted to a different + format when interpreted by the EXIDecoder. Preserving the lexical values + ensures that the identical strings are restored, and not just their + logical values. +

+

+
Parameters:
preserveLexicalValues - true to keep original strings intact +
Throws: +
org.openexi.proc.common.EXIOptionsException
+
+
+
+ +

+setDatatypeRepresentationMap

+
+public final void setDatatypeRepresentationMap(QName[] dtrm,
+                                               int n_bindings)
+                                        throws org.openexi.proc.common.EXIOptionsException
+
+
Set a datatype representation map (DTRM). The DTRM allows you to remap + XMLSchema datatypes to EXI datatypes other than their default equivalents. + The map is created using a sequence of Qualified Name pairs that identify + a datatype definition in the XMLSchema namespace followed by the new + corresponding datatype mapping in the EXI namespace. +

+ For example, the following lines map the boolean datatype from XMLSchema + to the integer datatype in EXI. + 
+   QName q1 = new QName("xsd:boolean","http://www.w3.org/2001/XMLSchema");
+   QName q2 = new QName("exi:integer","http://www.w3.org/2009/exi");
+   QName[] dtrm = new QName[2];
+   dtrm = {q1, q2}; // Each mapping requires 2 qualified names.
+   decoderInstance.setDatatypeRepresentationMap(dtrm, 1); // The array, and the number of pairs (1).
+
+

+

+
Parameters:
dtrm - a sequence of pairs of datatype QName and datatype representation QName
n_bindings - the number of QName pairs +
Throws: +
org.openexi.proc.common.EXIOptionsException
+
+
+
+ +

+setEnableBinaryData

+
+public final void setEnableBinaryData(boolean enable)
+
+
Each binary value will be returned as in a EventDescription of EVENT_BLOB + instead of EVENT_CH when enabled. +

+

+
Parameters:
enable -
+
+
+
+ +

+setInitialBinaryDataBufferSize

+
+public final void setInitialBinaryDataBufferSize(int initialSize)
+
+
+
+
+
+
+ +

+processHeader

+
+public Scanner processHeader()
+                      throws java.io.IOException,
+                             org.openexi.proc.common.EXIOptionsException
+
+
This method reads and configures any header options present + in the EXI stream, then returns a Scanner + object you can use to parse the values from the EXI stream. +

+

+ +
Returns:
Scanner parsable object with header options applied. +
Throws: +
java.io.IOException +
org.openexi.proc.common.EXIOptionsException
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Overview  Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + diff --git a/third-party/org.openexi/nagasena/src/main/resources/doc/org/openexi/proc/EXISchemaResolver.html b/third-party/org.openexi/nagasena/src/main/resources/doc/org/openexi/proc/EXISchemaResolver.html new file mode 100644 index 0000000000..7c90b7d5fb --- /dev/null +++ b/third-party/org.openexi/nagasena/src/main/resources/doc/org/openexi/proc/EXISchemaResolver.html @@ -0,0 +1,218 @@ + + + + + + + +EXISchemaResolver + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Overview  Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +org.openexi.proc +
+Interface EXISchemaResolver

+
+
+
public interface EXISchemaResolver
+ + +

+Developers have the option of implementing the EXISchemaResolver interface + to help EXIReader and EXIDecoder locate the correct grammar cache for parsing + an EXI stream. +

+ +

+

+ +
+
+ +

+ + + + + + + + + + + + +
+Method Summary
+ GrammarCacheresolveSchema(java.lang.String schemaId, + short grammarOptions) + +
+          Return a GrammarCache based on a schemaId and grammar options discovered + in the header options of an EXI stream.
+  +

+ + + + + + + + +
+Method Detail
+ +

+resolveSchema

+
+GrammarCache resolveSchema(java.lang.String schemaId,
+                           short grammarOptions)
+
+
Return a GrammarCache based on a schemaId and grammar options discovered + in the header options of an EXI stream. +

+

+
Parameters:
schemaId - the specific schema used to decode an EXI stream
grammarOptions - the specific grammar options used to decode an EXI stream +
Returns:
a GrammarCache object
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Overview  Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + diff --git a/third-party/org.openexi/nagasena/src/main/resources/doc/org/openexi/proc/HeaderOptionsOutputType.html b/third-party/org.openexi/nagasena/src/main/resources/doc/org/openexi/proc/HeaderOptionsOutputType.html new file mode 100644 index 0000000000..db42f8f040 --- /dev/null +++ b/third-party/org.openexi/nagasena/src/main/resources/doc/org/openexi/proc/HeaderOptionsOutputType.html @@ -0,0 +1,357 @@ + + + + + + + +HeaderOptionsOutputType + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Overview  Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD +DETAIL: ENUM CONSTANTS | FIELD | METHOD
+ + + +
+ +

+ +org.openexi.proc +
+Enum HeaderOptionsOutputType

+
+java.lang.Object
+  extended by java.lang.Enum<HeaderOptionsOutputType>
+      extended by org.openexi.proc.HeaderOptionsOutputType
+
+
+
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<HeaderOptionsOutputType>
+
+
+
+
public enum HeaderOptionsOutputType
extends java.lang.Enum<HeaderOptionsOutputType>
+ + +

+This enumeration provides three possible settings for header options output. +

+

    +
  • none – Header options are not included in the header. + The receiver of the document must have precise knowledge of the + settings used to encode the document.

    +
    • +
  • + lessSchemaId – Header options are present. Every + setting used is written out in the header options, except SchemaID. + The receiver of the document must know which schema is used to + encode the document.

    +
    • +
  • + all – All header options are present. Every setting + used is written to the header options, including SchemaID. +
    • +
+

+ +

+

+ +
+
+ +

+ + + + + + + + + + + + + + + + +
+Enum Constant Summary
all + +
+           
lessSchemaId + +
+           
none + +
+           
+  + + + + + + + + + + + + + + + +
+Method Summary
+static HeaderOptionsOutputTypevalueOf(java.lang.String name) + +
+          Returns the enum constant of this type with the specified name.
+static HeaderOptionsOutputType[]values() + +
+          Returns an array containing the constants of this enum type, in +the order they're declared.
+  + + + + + + + +
Methods inherited from class java.lang.Enum
compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
+  + + + + + + + +
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Enum Constant Detail
+ +

+none

+
+public static final HeaderOptionsOutputType none
+
+
+
+
+
+ +

+lessSchemaId

+
+public static final HeaderOptionsOutputType lessSchemaId
+
+
+
+
+
+ +

+all

+
+public static final HeaderOptionsOutputType all
+
+
+
+
+ + + + + + + + +
+Method Detail
+ +

+values

+
+public static final HeaderOptionsOutputType[] values()
+
+
Returns an array containing the constants of this enum type, in +the order they're declared. This method may be used to iterate +over the constants as follows: +
+for(HeaderOptionsOutputType c : HeaderOptionsOutputType.values())
+        System.out.println(c);
+
+

+

+ +
Returns:
an array containing the constants of this enum type, in +the order they're declared
+
+
+
+ +

+valueOf

+
+public static HeaderOptionsOutputType valueOf(java.lang.String name)
+
+
Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.) +

+

+
Parameters:
name - the name of the enum constant to be returned. +
Returns:
the enum constant with the specified name +
Throws: +
java.lang.IllegalArgumentException - if this enum type has no constant +with the specified name
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Overview  Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD +DETAIL: ENUM CONSTANTS | FIELD | METHOD
+ + + +
+ + + diff --git a/third-party/org.openexi/nagasena/src/main/resources/doc/org/openexi/proc/common/AlignmentType.html b/third-party/org.openexi/nagasena/src/main/resources/doc/org/openexi/proc/common/AlignmentType.html new file mode 100644 index 0000000000..cd6ca90e7d --- /dev/null +++ b/third-party/org.openexi/nagasena/src/main/resources/doc/org/openexi/proc/common/AlignmentType.html @@ -0,0 +1,379 @@ + + + + + + + +AlignmentType + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Overview  Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD +DETAIL: ENUM CONSTANTS | FIELD | METHOD
+ + + +
+ +

+ +org.openexi.proc.common +
+Enum AlignmentType

+
+java.lang.Object
+  extended by java.lang.Enum<AlignmentType>
+      extended by org.openexi.proc.common.AlignmentType
+
+
+
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<AlignmentType>
+
+
+
+
public enum AlignmentType
extends java.lang.Enum<AlignmentType>
+ + +

+AlignmentType represents one of the following bit alignment + styles so as to provide an extra degree of control over the + way information is stored in EXI format. +
+

  • bitPacked is the default setting. Data are + stored in the fewest number of bits in sequential streams + that cross byte barriers. Conceptually, 8 boolean values + might be stored in a single byte, for example.

    • +
  • byteAligned stores data using EXI tags with + byte barriers intact. Byte-aligned files are useful for + troubleshooting, because the data are often human-readable + when the values are literally encoded as strings. It + is not meant for data transfer, as the file has not been + optimized.

    • +
  • preCompress is a byte-aligned format that arranges + the data into channels. It is intended for use cases where + file compression is part of the transfer process, so as + not to perform the compression step twice.

    • +
  • compress is not a bit alignment in and of itself, + but the Deflate algorithm requires that files be byte-aligned. + When compression is selected, byte-alignment is used, the + data are arranged in channels, and the file is compressed + at the end of processing.
    • +
+

+ +

+

+ +
+
+ +

+ + + + + + + + + + + + + + + + + + + +
+Enum Constant Summary
bitPacked + +
+           
byteAligned + +
+           
compress + +
+           
preCompress + +
+           
+  + + + + + + + + + + + + + + + +
+Method Summary
+static AlignmentTypevalueOf(java.lang.String name) + +
+          Returns the enum constant of this type with the specified name.
+static AlignmentType[]values() + +
+          Returns an array containing the constants of this enum type, in +the order they're declared.
+  + + + + + + + +
Methods inherited from class java.lang.Enum
compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
+  + + + + + + + +
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Enum Constant Detail
+ +

+bitPacked

+
+public static final AlignmentType bitPacked
+
+
+
+
+
+ +

+byteAligned

+
+public static final AlignmentType byteAligned
+
+
+
+
+
+ +

+preCompress

+
+public static final AlignmentType preCompress
+
+
+
+
+
+ +

+compress

+
+public static final AlignmentType compress
+
+
+
+
+ + + + + + + + +
+Method Detail
+ +

+values

+
+public static final AlignmentType[] values()
+
+
Returns an array containing the constants of this enum type, in +the order they're declared. This method may be used to iterate +over the constants as follows: +
+for(AlignmentType c : AlignmentType.values())
+        System.out.println(c);
+
+

+

+ +
Returns:
an array containing the constants of this enum type, in +the order they're declared
+
+
+
+ +

+valueOf

+
+public static AlignmentType valueOf(java.lang.String name)
+
+
Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.) +

+

+
Parameters:
name - the name of the enum constant to be returned. +
Returns:
the enum constant with the specified name +
Throws: +
java.lang.IllegalArgumentException - if this enum type has no constant +with the specified name
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Overview  Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD +DETAIL: ENUM CONSTANTS | FIELD | METHOD
+ + + +
+ + + diff --git a/third-party/org.openexi/nagasena/src/main/resources/doc/org/openexi/proc/common/BinaryDataSource.html b/third-party/org.openexi/nagasena/src/main/resources/doc/org/openexi/proc/common/BinaryDataSource.html new file mode 100644 index 0000000000..27a32a0db3 --- /dev/null +++ b/third-party/org.openexi/nagasena/src/main/resources/doc/org/openexi/proc/common/BinaryDataSource.html @@ -0,0 +1,349 @@ + + + + + + + +BinaryDataSource + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Overview  Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +org.openexi.proc.common +
+Class BinaryDataSource

+
+java.lang.Object
+  extended by org.openexi.proc.common.BinaryDataSource
+
+
+
+
public final class BinaryDataSource
extends java.lang.Object
+ + +

+

+ +
+
+ +

+ + + + + + + + + + + +
+Constructor Summary
BinaryDataSource() + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ byte[]getByteArray() + +
+           
+ intgetLength() + +
+           
+ longgetRemainingBytesCount() + +
+           
+ intgetStartIndex() + +
+           
+ booleanhasNext() + +
+           
+ intnext() + +
+           
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+BinaryDataSource

+
+public BinaryDataSource()
+
+
+ + + + + + + + +
+Method Detail
+ +

+getByteArray

+
+public final byte[] getByteArray()
+
+
+
+
+
+
+ +

+getStartIndex

+
+public final int getStartIndex()
+
+
+
+
+
+
+ +

+getLength

+
+public final int getLength()
+
+
+
+
+
+
+ +

+getRemainingBytesCount

+
+public final long getRemainingBytesCount()
+
+
+
+
+
+
+ +

+hasNext

+
+public boolean hasNext()
+
+
+
+
+
+
+ +

+next

+
+public int next()
+         throws java.io.IOException
+
+
+ +
Throws: +
java.io.IOException
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Overview  Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + diff --git a/third-party/org.openexi/nagasena/src/main/resources/doc/org/openexi/proc/common/EXIOptions.html b/third-party/org.openexi/nagasena/src/main/resources/doc/org/openexi/proc/common/EXIOptions.html new file mode 100644 index 0000000000..27d78e0a99 --- /dev/null +++ b/third-party/org.openexi/nagasena/src/main/resources/doc/org/openexi/proc/common/EXIOptions.html @@ -0,0 +1,502 @@ + + + + + + + +EXIOptions + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Overview  Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +org.openexi.proc.common +
+Class EXIOptions

+
+java.lang.Object
+  extended by org.openexi.proc.common.EXIOptions
+
+
+
+
public final class EXIOptions
extends java.lang.Object
+ + +

+EXIOptions provides accessors for values associated with + EXI options in the EXI header of an EXI stream. +

+ +

+

+ +
+
+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ AlignmentTypegetAlignmentType() + +
+          Get the bit alignment setting.
+ intgetBlockSize() + +
+          Returns the number of element and attribute values that are read and processed + as a group.
+ QName[]getDatatypeRepresentationMap() + +
+          Returns an array of qualified names that map XMLSchema datatypes to + non-standard equivalents in EXI.
+ intgetDatatypeRepresentationMapBindingsCount() + +
+          Returns the number of Datatype Representation Map QName pairs.
+ booleangetPreserveComments() + +
+          Returns whether comments are conserved in the EXI Stream.
+ booleangetPreserveDTD() + +
+          Returns whether the document type definition is conserved in the EXI Stream.
+ booleangetPreserveLexicalValues() + +
+          Returns whether lexical values (literal strings) are preserved rather + than the logical values of elements and attributes.
+ booleangetPreserveNS() + +
+          Returns whether the namespaces are preserved in the EXI stream.
+ booleangetPreservePIs() + +
+          Returns whether processing instructions are conserved in the EXI Stream.
+ intgetValueMaxLength() + +
+          Returns the maximum length in characters of strings that will be included + in the String Table.
+ intgetValuePartitionCapacity() + +
+          Returns the maximum number of entries in the String Table.
+ booleanisFragment() + +
+          An XML fragment is a non-compliant XML document with multiple root + elements.
+ booleanisStrict() + +
+          The Strict option applies to streams that have an associated XML Schema + and the data in the XML stream is 100% compliant with the schema.
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Method Detail
+ +

+getAlignmentType

+
+public AlignmentType getAlignmentType()
+
+
Get the bit alignment setting. +

+

+ +
Returns:
AlignmentType
+
+
+
+ +

+isFragment

+
+public boolean isFragment()
+
+
An XML fragment is a non-compliant XML document with multiple root + elements. +

+

+ +
Returns:
true if the stream is an XML fragment.
+
+
+
+ +

+isStrict

+
+public boolean isStrict()
+
+
The Strict option applies to streams that have an associated XML Schema + and the data in the XML stream is 100% compliant with the schema. +

+

+ +
Returns:
true if using strict interpretation of an associated XML Schema.
+
+
+
+ +

+getPreserveComments

+
+public boolean getPreserveComments()
+
+
Returns whether comments are conserved in the EXI Stream. +

+

+ +
Returns:
true if comments are preserved.
+
+
+
+ +

+getPreservePIs

+
+public boolean getPreservePIs()
+
+
Returns whether processing instructions are conserved in the EXI Stream. +

+

+ +
Returns:
true if processing instructions are preserved.
+
+
+
+ +

+getPreserveDTD

+
+public boolean getPreserveDTD()
+
+
Returns whether the document type definition is conserved in the EXI Stream. +

+

+ +
Returns:
true if the document type definition is preserved.
+
+
+
+ +

+getPreserveNS

+
+public boolean getPreserveNS()
+
+
Returns whether the namespaces are preserved in the EXI stream. +

+

+ +
Returns:
true if namespaces are preserved.
+
+
+
+ +

+getBlockSize

+
+public int getBlockSize()
+
+
Returns the number of element and attribute values that are read and processed + as a group. +

+

+ +
Returns:
the current block size. Default is 1,000,000.
+
+
+
+ +

+getValueMaxLength

+
+public int getValueMaxLength()
+
+
Returns the maximum length in characters of strings that will be included + in the String Table. +

+

+ +
Returns:
the maximum length of values added to the String Table. Default is unbounded (-1).
+
+
+
+ +

+getValuePartitionCapacity

+
+public int getValuePartitionCapacity()
+
+
Returns the maximum number of entries in the String Table. +

+

+ +
Returns:
the maximum number of partitions (entries) in the String Table. Default is unbounded (-1).
+
+
+
+ +

+getPreserveLexicalValues

+
+public boolean getPreserveLexicalValues()
+
+
Returns whether lexical values (literal strings) are preserved rather + than the logical values of elements and attributes. +

+

+ +
Returns:
true if lexical values are preserved.
+
+
+
+ +

+getDatatypeRepresentationMapBindingsCount

+
+public int getDatatypeRepresentationMapBindingsCount()
+
+
Returns the number of Datatype Representation Map QName pairs. +

+

+ +
Returns:
the number of DTRM bindings.
+
+
+
+ +

+getDatatypeRepresentationMap

+
+public QName[] getDatatypeRepresentationMap()
+
+
Returns an array of qualified names that map XMLSchema datatypes to + non-standard equivalents in EXI. +

+

+ +
Returns:
an array of qualified names comprising a DTRM.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Overview  Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + diff --git a/third-party/org.openexi/nagasena/src/main/resources/doc/org/openexi/proc/common/EventDescription.html b/third-party/org.openexi/nagasena/src/main/resources/doc/org/openexi/proc/common/EventDescription.html new file mode 100644 index 0000000000..396802fbc6 --- /dev/null +++ b/third-party/org.openexi/nagasena/src/main/resources/doc/org/openexi/proc/common/EventDescription.html @@ -0,0 +1,653 @@ + + + + + + + +EventDescription + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Overview  Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +org.openexi.proc.common +
+Interface EventDescription

+
+
All Known Implementing Classes:
EventType
+
+
+
+
public interface EventDescription
+ + +

+

EventDescription provides accessors to the current EXI event data + during the decode process.

+ +

Note that the content of EventDescription is transient, which means + its content may change when the decoder is asked for access to the + next EXI event data.

+

+ +

+

+ +
+
+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Field Summary
+static byteEVENT_AT + +
+          Attribute event.
+static byteEVENT_BLOB + +
+          BLOB event (content of an element).
+static byteEVENT_CH + +
+          Character event (content of an element).
+static byteEVENT_CM + +
+          Comment event.
+static byteEVENT_DTD + +
+          Document Type Definition event.
+static byteEVENT_ED + +
+          End Document event.
+static byteEVENT_EE + +
+          End Element event.
+static byteEVENT_ER + +
+          Entity Reference event.
+static byteEVENT_NL + +
+          Attribute xsi:nil.
+static byteEVENT_NS + +
+          Namespace declaration event.
+static byteEVENT_PI + +
+          Processing Instruction event.
+static byteEVENT_SD + +
+          Start Document event.
+static byteEVENT_SE + +
+          Start Element event.
+static byteEVENT_TP + +
+          Attribute xsi:type.
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ BinaryDataSourcegetBinaryDataSource() + +
+          Gets the value of an EVENT_BLOB.
+ CharactersgetCharacters() + +
+          Gets the value of an EVENT_CH, + Attribute (EVENT_AT, EVENT_NL, EVENT_TP), EVENT_CM, + EVENT_DTD or EVENT_PI event.
+ bytegetEventKind() + +
+          Gets the event kind of which instance data this EventDescription is describing.
+ EventTypegetEventType() + +
+          Returns the EventType from which this event is derived.
+ java.lang.StringgetName() + +
+          Gets the name of the EXI event.
+ java.lang.StringgetPrefix() + +
+          Gets the namespace prefix of the event.
+ java.lang.StringgetURI() + +
+          Gets the URI of the EXI event.
+  +

+ + + + + + + + +
+Field Detail
+ +

+EVENT_SD

+
+static final byte EVENT_SD
+
+
Start Document event. +

+

+
See Also:
Constant Field Values
+
+
+ +

+EVENT_ED

+
+static final byte EVENT_ED
+
+
End Document event. +

+

+
See Also:
Constant Field Values
+
+
+ +

+EVENT_SE

+
+static final byte EVENT_SE
+
+
Start Element event. +

+

+
See Also:
Constant Field Values
+
+
+ +

+EVENT_AT

+
+static final byte EVENT_AT
+
+
Attribute event. +

+

+
See Also:
Constant Field Values
+
+
+ +

+EVENT_TP

+
+static final byte EVENT_TP
+
+
Attribute xsi:type. +

+

+
See Also:
Constant Field Values
+
+
+ +

+EVENT_NL

+
+static final byte EVENT_NL
+
+
Attribute xsi:nil. +

+

+
See Also:
Constant Field Values
+
+
+ +

+EVENT_CH

+
+static final byte EVENT_CH
+
+
Character event (content of an element). +

+

+
See Also:
Constant Field Values
+
+
+ +

+EVENT_EE

+
+static final byte EVENT_EE
+
+
End Element event. +

+

+
See Also:
Constant Field Values
+
+
+ +

+EVENT_NS

+
+static final byte EVENT_NS
+
+
Namespace declaration event. +

+

+
See Also:
Constant Field Values
+
+
+ +

+EVENT_PI

+
+static final byte EVENT_PI
+
+
Processing Instruction event. +

+

+
See Also:
Constant Field Values
+
+
+ +

+EVENT_CM

+
+static final byte EVENT_CM
+
+
Comment event. +

+

+
See Also:
Constant Field Values
+
+
+ +

+EVENT_ER

+
+static final byte EVENT_ER
+
+
Entity Reference event. +

+

+
See Also:
Constant Field Values
+
+
+ +

+EVENT_DTD

+
+static final byte EVENT_DTD
+
+
Document Type Definition event. +

+

+
See Also:
Constant Field Values
+
+
+ +

+EVENT_BLOB

+
+static final byte EVENT_BLOB
+
+
BLOB event (content of an element). +

+

+
See Also:
Constant Field Values
+
+ + + + + + + + +
+Method Detail
+ +

+getEventKind

+
+byte getEventKind()
+
+
Gets the event kind of which instance data this EventDescription is describing. +

+

+ +
Returns:
a byte representing the event kind.
+
+
+
+ +

+getURI

+
+java.lang.String getURI()
+
+
Gets the URI of the EXI event. +

+

+ +
Returns:
the URI as a String.
+
+
+
+ +

+getName

+
+java.lang.String getName()
+
+
Gets the name of the EXI event. +

+

+ +
Returns:
the name of the event as a String.
+
+
+
+ +

+getPrefix

+
+java.lang.String getPrefix()
+
+
Gets the namespace prefix of the event. +

+

+ +
Returns:
the prefix as a String.
+
+
+
+ +

+getCharacters

+
+Characters getCharacters()
+
+
Gets the value of an EVENT_CH, + Attribute (EVENT_AT, EVENT_NL, EVENT_TP), EVENT_CM, + EVENT_DTD or EVENT_PI event. +

+

+ +
Returns:
a Characters of the corresponding value
+
+
+
+ +

+getBinaryDataSource

+
+BinaryDataSource getBinaryDataSource()
+
+
Gets the value of an EVENT_BLOB. +

+

+ +
Returns:
a BinaryData of the corresponding value
+
+
+
+ +

+getEventType

+
+EventType getEventType()
+
+
Returns the EventType from which this event is derived. +

+

+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Overview  Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + diff --git a/third-party/org.openexi/nagasena/src/main/resources/doc/org/openexi/proc/common/EventType.html b/third-party/org.openexi/nagasena/src/main/resources/doc/org/openexi/proc/common/EventType.html new file mode 100644 index 0000000000..aaef0c43ed --- /dev/null +++ b/third-party/org.openexi/nagasena/src/main/resources/doc/org/openexi/proc/common/EventType.html @@ -0,0 +1,829 @@ + + + + + + + +EventType + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Overview  Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +org.openexi.proc.common +
+Class EventType

+
+java.lang.Object
+  extended by org.openexi.proc.common.EventCode
+      extended by org.openexi.proc.common.EventType
+
+
+
All Implemented Interfaces:
EventDescription
+
+
+
+
public class EventType
extends org.openexi.proc.common.EventCode
implements EventDescription
+ + +

+EventType denotes terminal symbols of grammar productions + defined in the EXI 1.0 specification. +

+ +

+

+ +
+
+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Field Summary
+static byteITEM_AT + +
+          Event type for an Attribute learned by built-in element grammars + from prior attribute occurrences.
+static byteITEM_AT_WC_ANY_UNTYPED + +
+          Wildcard event type for an Attribute where the attribute's defined + datatype (if any) is disregarded.
+static byteITEM_CH + +
+          Event type for a Character event (character events store values as strings).
+static byteITEM_CM + +
+          Event type for a Comment.
+static byteITEM_DTD + +
+          Event type for a Document Type Definition.
+static byteITEM_ED + +
+          Event type for End of Document.
+static byteITEM_EE + +
+          Event type for End of Element.
+static byteITEM_ER + +
+          Event type for an Entity Reference.
+static byteITEM_NS + +
+          Event type for a Namespace declaration.
+static byteITEM_PI + +
+          Event type for a Processing Instruction.
+static byteITEM_SC + +
+          Self-contained items are not supported in this release of OpenEXI.
+static byteITEM_SCHEMA_AT + +
+          Event type for AttributeUse that matches an attribute event with + a valid value.
+static byteITEM_SCHEMA_AT_INVALID_VALUE + +
+          Event type for AttributeUse that matches an attribute event with an + invalid value.
+static byteITEM_SCHEMA_AT_WC_ANY + +
+          Attribute wildcard event type stemming from a schema, where the attribute's + defined datatype (if any) is applied.
+static byteITEM_SCHEMA_AT_WC_NS + +
+          Attribute wildcard event type, qualified with a specific namespace, stemming + from a schema where the attribute's defined datatype (if any) is applied.
+static byteITEM_SCHEMA_CH + +
+          Event type for a defined Character event in an EXI stream processed + using a schema.
+static byteITEM_SCHEMA_CH_MIXED + +
+          Event type for a Character event that occurs in the context of an element + defined so as to permit mixed content (mark up and data) in an EXI + stream processed using a schema.
+static byteITEM_SCHEMA_NIL + +
+          Special Attribute that indicates the value of the associated element is + explicitly nil rather than an empty string.
+static byteITEM_SCHEMA_TYPE + +
+          Special Attribute that describes a data type for the associated + element.
+static byteITEM_SCHEMA_WC_ANY + +
+          Attribute wildcard event type stemming from a schema where the + attribute's defined datatype (if any) is applied.
+static byteITEM_SCHEMA_WC_NS + +
+          Event type for an element defined in a namespace in an EXI stream + processed using a schema.
+static byteITEM_SD + +
+          Event type for Start Document.
+static byteITEM_SE + +
+          Event type for Start Element.
+static byteITEM_SE_WC + +
+          Wildcard event type for an element.
+ java.lang.Stringname + +
+          Local name of event type definition.
+ java.lang.Stringuri + +
+          URI of event type definition.
+  + + + + + + + +
Fields inherited from class org.openexi.proc.common.EventCode
EVENT_CODE_DEPTH_ONE, EVENT_CODE_DEPTH_THREE, EVENT_CODE_DEPTH_TWO, ITEM_TUPLE, itemType, parent, position
+  + + + + + + + +
Fields inherited from interface org.openexi.proc.common.EventDescription
EVENT_AT, EVENT_BLOB, EVENT_CH, EVENT_CM, EVENT_DTD, EVENT_ED, EVENT_EE, EVENT_ER, EVENT_NL, EVENT_NS, EVENT_PI, EVENT_SD, EVENT_SE, EVENT_TP
+  + + + + + + + +
+Method Summary
+  + + + + + + + +
Methods inherited from class org.openexi.proc.common.EventCode
setParentalContext
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  + + + + + + + +
Methods inherited from interface org.openexi.proc.common.EventDescription
getBinaryDataSource, getCharacters, getEventKind, getEventType, getName, getPrefix, getURI
+  +

+ + + + + + + + +
+Field Detail
+ +

+ITEM_PI

+
+public static final byte ITEM_PI
+
+
Event type for a Processing Instruction. Value is 0. +

+

+
See Also:
Constant Field Values
+
+
+ +

+ITEM_CM

+
+public static final byte ITEM_CM
+
+
Event type for a Comment. +
Value is 1. +

+

+
See Also:
Constant Field Values
+
+
+ +

+ITEM_ER

+
+public static final byte ITEM_ER
+
+
Event type for an Entity Reference. +
Value is 2. +

+

+
See Also:
Constant Field Values
+
+
+ +

+ITEM_CH

+
+public static final byte ITEM_CH
+
+
Event type for a Character event (character events store values as strings). +
Value is 3. +

+

+
See Also:
Constant Field Values
+
+
+ +

+ITEM_ED

+
+public static final byte ITEM_ED
+
+
Event type for End of Document. +
Value is 4. +

+

+
See Also:
Constant Field Values
+
+
+ +

+ITEM_SE_WC

+
+public static final byte ITEM_SE_WC
+
+
Wildcard event type for an element. OpenEXI will first attempt + to find a corresponding element name in the schema, if present. If + no definition is available, it is given this tag. +
Value is 5. +

+

+
See Also:
Constant Field Values
+
+
+ +

+ITEM_SC

+
+public static final byte ITEM_SC
+
+
Self-contained items are not supported in this release of OpenEXI. + Event type for self-contained item. +
Value is 6. +

+

+
See Also:
Constant Field Values
+
+
+ +

+ITEM_NS

+
+public static final byte ITEM_NS
+
+
Event type for a Namespace declaration.
+
Value is 7. +

+

+
See Also:
Constant Field Values
+
+
+ +

+ITEM_AT_WC_ANY_UNTYPED

+
+public static final byte ITEM_AT_WC_ANY_UNTYPED
+
+
Wildcard event type for an Attribute where the attribute's defined + datatype (if any) is disregarded. + This is the "catch-all" for Attributes that do not match any of the + other Event Types in an EXI stream processed using Default options. +
Value is 8. +

+

+
See Also:
Constant Field Values
+
+
+ +

+ITEM_EE

+
+public static final byte ITEM_EE
+
+
Event type for End of Element. +
Value is 9. +

+

+
See Also:
Constant Field Values
+
+
+ +

+ITEM_DTD

+
+public static final byte ITEM_DTD
+
+
Event type for a Document Type Definition. +
Value is 10. +

+

+
See Also:
Constant Field Values
+
+
+ +

+ITEM_SE

+
+public static final byte ITEM_SE
+
+
Event type for Start Element. +
Value is 11. +

+

+
See Also:
Constant Field Values
+
+
+ +

+ITEM_AT

+
+public static final byte ITEM_AT
+
+
Event type for an Attribute learned by built-in element grammars + from prior attribute occurrences. +
Value is 12. +

+

+
See Also:
Constant Field Values
+
+
+ +

+ITEM_SD

+
+public static final byte ITEM_SD
+
+
Event type for Start Document. +
Value is 13. +

+

+
See Also:
Constant Field Values
+
+
+ +

+ITEM_SCHEMA_WC_ANY

+
+public static final byte ITEM_SCHEMA_WC_ANY
+
+
Attribute wildcard event type stemming from a schema where the + attribute's defined datatype (if any) is applied. +
Value is 14. +

+

+
See Also:
Constant Field Values
+
+
+ +

+ITEM_SCHEMA_WC_NS

+
+public static final byte ITEM_SCHEMA_WC_NS
+
+
Event type for an element defined in a namespace in an EXI stream + processed using a schema. +
Value is 15. +

+

+
See Also:
Constant Field Values
+
+
+ +

+ITEM_SCHEMA_AT

+
+public static final byte ITEM_SCHEMA_AT
+
+
Event type for AttributeUse that matches an attribute event with + a valid value. +
Value is 16. +

+

+
See Also:
Constant Field Values
+
+
+ +

+ITEM_SCHEMA_AT_WC_ANY

+
+public static final byte ITEM_SCHEMA_AT_WC_ANY
+
+
Attribute wildcard event type stemming from a schema, where the attribute's + defined datatype (if any) is applied. +
Value is 17. +

+

+
See Also:
Constant Field Values
+
+
+ +

+ITEM_SCHEMA_AT_WC_NS

+
+public static final byte ITEM_SCHEMA_AT_WC_NS
+
+
Attribute wildcard event type, qualified with a specific namespace, stemming + from a schema where the attribute's defined datatype (if any) is applied. +
Value is 18. +

+

+
See Also:
Constant Field Values
+
+
+ +

+ITEM_SCHEMA_CH

+
+public static final byte ITEM_SCHEMA_CH
+
+
Event type for a defined Character event in an EXI stream processed + using a schema. +
Value is 19. +

+

+
See Also:
Constant Field Values
+
+
+ +

+ITEM_SCHEMA_CH_MIXED

+
+public static final byte ITEM_SCHEMA_CH_MIXED
+
+
Event type for a Character event that occurs in the context of an element + defined so as to permit mixed content (mark up and data) in an EXI + stream processed using a schema. +
Value is 20. +

+

+
See Also:
Constant Field Values
+
+
+ +

+ITEM_SCHEMA_NIL

+
+public static final byte ITEM_SCHEMA_NIL
+
+
Special Attribute that indicates the value of the associated element is + explicitly nil rather than an empty string. +
Value is 21. +

+

+
See Also:
Constant Field Values
+
+
+ +

+ITEM_SCHEMA_TYPE

+
+public static final byte ITEM_SCHEMA_TYPE
+
+
Special Attribute that describes a data type for the associated + element. For example, the schema might define a String value, but + the XML document being processed can declare that the element contains a + date-time field. +
Value is 22. +

+

+
See Also:
Constant Field Values
+
+
+ +

+ITEM_SCHEMA_AT_INVALID_VALUE

+
+public static final byte ITEM_SCHEMA_AT_INVALID_VALUE
+
+
Event type for AttributeUse that matches an attribute event with an + invalid value. +
Value is 23. +

+

+
See Also:
Constant Field Values
+
+
+ +

+uri

+
+public final java.lang.String uri
+
+
URI of event type definition. +

+

+
+
+
+ +

+name

+
+public final java.lang.String name
+
+
Local name of event type definition. +

+

+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Overview  Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + diff --git a/third-party/org.openexi/nagasena/src/main/resources/doc/org/openexi/proc/common/GrammarOptions.html b/third-party/org.openexi/nagasena/src/main/resources/doc/org/openexi/proc/common/GrammarOptions.html new file mode 100644 index 0000000000..7ea6e13a8c --- /dev/null +++ b/third-party/org.openexi/nagasena/src/main/resources/doc/org/openexi/proc/common/GrammarOptions.html @@ -0,0 +1,528 @@ + + + + + + + +GrammarOptions + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Overview  Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +org.openexi.proc.common +
+Class GrammarOptions

+
+java.lang.Object
+  extended by org.openexi.proc.common.GrammarOptions
+
+
+
+
public final class GrammarOptions
extends java.lang.Object
+ + +

+GrammarOptions computes a short integer that represents settings in the EXI Grammar settings + that determine how an EXI file will be encoded or decoded. +

+ Values are set using binary switch values (represented as short integers). +

+ If no options have been set, the value is 0 (this is an temporary internal + value, rather than a valid setting). +

+ If an XSD is available, and the file to be processed is 100% compatible with the XSD, choosing + STRICT_OPTIONS (1) provides the best performance. No other options can be set + when files are encoded or decoded in strict mode. +

+ The DEFAULT_OPTIONS setting is 2. The following table lists all of the options and their values. +

+ + + + + + + + +
ConstantValue
STRICT_OPTIONS1
DEFAULT_OPTIONS2
+ ADD_NS4 +
+ ADD_SCN/A* +
+ ADD_DTD16 +
+ ADD_CM32 +
+ ADD_PI64 +
*The self-contained option is not supported in this release. +
+

+ The value of DEFAULT_OPTIONS is 2. When you pass the options variable to an add[??] method, + the binary switch value is added to the current value of the options variable. + The sum of all additional switches becomes a concise list of the selected options. +

+ For example, if you preserve comments and processing instructions, the total is + 98 (2 + 32 + 64). The bitwise options are set correctly, because there is one and only one + combination of options that sums up to 98. +

+ If your application uses the same options every time, you can hard code the numeric value + as a short integer and use it to create your GrammarCache. For example: + 

+ GrammarCache gc = new GrammarCache((EXISchema)null,98);
+
+ Be careful to use the correct numeric value, to avoid unexpected results. +

+ +

+

+ +
+
+ +

+ + + + + + + + + + + + + + + + + + + +
+Field Summary
+static shortDEFAULT_OPTIONS + +
+          Indicates that undeclared elements and attributes will be + processed when the XML stream is encoded and decoded.
+static shortOPTIONS_UNUSED + +
+          OPTIONS_UNUSED is an internal value.
+static shortSTRICT_OPTIONS + +
+          Indicates that undeclared elements and attributes will throw an + exception when the XML stream is encoded and decoded.
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+static shortaddCM(short options) + +
+          Sets Preserve Comments to true.
+static shortaddDTD(short options) + +
+          Sets Preserve Document Type Definition to true.
+static shortaddNS(short options) + +
+          Sets Preserve Namespaces to true.
+static shortaddPI(short options) + +
+          Sets Preserve Processing Instructions to true.
+static booleanhasCM(short options) + +
+          Returns true if Preserve Comments is true.
+static booleanhasDTD(short options) + +
+          Returns true if Preserve Document Type Definition is true.
+static booleanhasNS(short options) + +
+          Returns true if Preserve Namespaces is true.
+static booleanhasPI(short options) + +
+          Returns true if Preserve Processing Instructions is true.
+static booleanisPermitDeviation(short options) + +
+          Returns true if DEFAULT_OPTIONS is set to true.
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+OPTIONS_UNUSED

+
+public static final short OPTIONS_UNUSED
+
+
OPTIONS_UNUSED is an internal value. + It indicates that the grammar options value has not yet been set. +

+

+
See Also:
Constant Field Values
+
+
+ +

+DEFAULT_OPTIONS

+
+public static final short DEFAULT_OPTIONS
+
+
Indicates that undeclared elements and attributes will be + processed when the XML stream is encoded and decoded. +

+

+
See Also:
Constant Field Values
+
+
+ +

+STRICT_OPTIONS

+
+public static final short STRICT_OPTIONS
+
+
Indicates that undeclared elements and attributes will throw an + exception when the XML stream is encoded and decoded. When + STRICT_OPTIONS is set, all other Grammar Options are ignored. +

+

+
See Also:
Constant Field Values
+
+ + + + + + + + +
+Method Detail
+ +

+isPermitDeviation

+
+public static boolean isPermitDeviation(short options)
+
+
Returns true if DEFAULT_OPTIONS is set to true. +

+

+
+
+
+
+ +

+hasNS

+
+public static boolean hasNS(short options)
+
+
Returns true if Preserve Namespaces is true. +

+

+
+
+
+
+ +

+hasDTD

+
+public static boolean hasDTD(short options)
+
+
Returns true if Preserve Document Type Definition is true. +

+

+
+
+
+
+ +

+hasCM

+
+public static boolean hasCM(short options)
+
+
Returns true if Preserve Comments is true. +

+

+
+
+
+
+ +

+hasPI

+
+public static boolean hasPI(short options)
+
+
Returns true if Preserve Processing Instructions is true. +

+

+
+
+
+
+ +

+addNS

+
+public static short addNS(short options)
+
+
Sets Preserve Namespaces to true. (Adds 4 to the options value.) +

+

+ +
Returns:
the new options short integer value
+
+
+
+ +

+addDTD

+
+public static short addDTD(short options)
+
+
Sets Preserve Document Type Definition to true. (Adds 16 to the options value.) +

+

+ +
Returns:
the new options short integer value
+
+
+
+ +

+addCM

+
+public static short addCM(short options)
+
+
Sets Preserve Comments to true. (Adds 32 to the options value.) +

+

+ +
Returns:
the new options short integer value
+
+
+
+ +

+addPI

+
+public static short addPI(short options)
+
+
Sets Preserve Processing Instructions to true. (Adds 64 to the options value.) +

+

+ +
Returns:
the new options short integer value
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Overview  Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + diff --git a/third-party/org.openexi/nagasena/src/main/resources/doc/org/openexi/proc/common/QName.html b/third-party/org.openexi/nagasena/src/main/resources/doc/org/openexi/proc/common/QName.html new file mode 100644 index 0000000000..61485ec734 --- /dev/null +++ b/third-party/org.openexi/nagasena/src/main/resources/doc/org/openexi/proc/common/QName.html @@ -0,0 +1,346 @@ + + + + + + + +QName + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Overview  Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +org.openexi.proc.common +
+Class QName

+
+java.lang.Object
+  extended by org.openexi.proc.common.QName
+
+
+
+
public final class QName
extends java.lang.Object
+ + +

+QName is a pair comprised of a namespace name and a local name + to be used in a Datatype Representation Map (DTRM) definition + to denote an XSD datatype or an EXI datatype representation. +

+ +

+

+ +
+
+ +

+ + + + + + + + + + + + + + + +
+Field Summary
+ java.lang.StringlocalName + +
+          Local name of the datatype.
+ java.lang.StringnamespaceName + +
+          If namespaceName is null, this indicates a failure of + namespace-prefix binding.
+  + + + + + + + + + + + + + +
+Constructor Summary
QName() + +
+           
QName(java.lang.String qname, + java.lang.String uri) + +
+          Creates a QName based on its literal qualified name + (see http://www.w3.org/TR/xml-names/#ns-qualnames + for definition) and namespace name.
+  + + + + + + + + + + + +
+Method Summary
+ booleanequals(java.lang.Object obj) + +
+           
+  + + + + + + + +
Methods inherited from class java.lang.Object
getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+namespaceName

+
+public java.lang.String namespaceName
+
+
If namespaceName is null, this indicates a failure of + namespace-prefix binding. No namespace binding for the + unprefixed QName is indicated by an empty namespace + name "". +

+

+
+
+
+ +

+localName

+
+public java.lang.String localName
+
+
Local name of the datatype. +

+

+
+
+ + + + + + + + +
+Constructor Detail
+ +

+QName

+
+public QName()
+
+
+
+ +

+QName

+
+public QName(java.lang.String qname,
+             java.lang.String uri)
+
+
Creates a QName based on its literal qualified name + (see http://www.w3.org/TR/xml-names/#ns-qualnames + for definition) and namespace name. +

+

+
Parameters:
qname - literal qualified name in its entirety
uri - namespace name (nullable) of the QName
See Also:
http://www.w3.org/TR/xml-names/#ns-qualnames
+
+ + + + + + + + +
+Method Detail
+ +

+equals

+
+public boolean equals(java.lang.Object obj)
+
+
+
Overrides:
equals in class java.lang.Object
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Overview  Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + diff --git a/third-party/org.openexi/nagasena/src/main/resources/doc/org/openexi/proc/common/package-frame.html b/third-party/org.openexi/nagasena/src/main/resources/doc/org/openexi/proc/common/package-frame.html new file mode 100644 index 0000000000..fcab6106d9 --- /dev/null +++ b/third-party/org.openexi/nagasena/src/main/resources/doc/org/openexi/proc/common/package-frame.html @@ -0,0 +1,63 @@ + + + + + + + +org.openexi.proc.common + + + + + + + + + + + +org.openexi.proc.common + + + + +
+Interfaces  + +
+EventDescription
+ + + + + + +
+Classes  + +
+BinaryDataSource +
+EventType +
+EXIOptions +
+GrammarOptions +
+QName
+ + + + + + +
+Enums  + +
+AlignmentType
+ + + + diff --git a/third-party/org.openexi/nagasena/src/main/resources/doc/org/openexi/proc/common/package-summary.html b/third-party/org.openexi/nagasena/src/main/resources/doc/org/openexi/proc/common/package-summary.html new file mode 100644 index 0000000000..c4f3e1c6fe --- /dev/null +++ b/third-party/org.openexi/nagasena/src/main/resources/doc/org/openexi/proc/common/package-summary.html @@ -0,0 +1,235 @@ + + + + + + + +org.openexi.proc.common + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Overview   Package  Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+

+Package org.openexi.proc.common +

+ + + +The common package contains classes, interfaces, and enumerators that define the vocabulary used to describe EXI streams (events, options, alignment, and character string values). +

+See: +
+          Description +

+ + + + + + + + + +
+Interface Summary
EventDescriptionEventDescription provides accessors to the current EXI event data + during the decode process.
+  + +

+ + + + + + + + + + + + + + + + + + + + + + + + + +
+Class Summary
BinaryDataSource 
EventTypeEventType denotes terminal symbols of grammar productions + defined in the EXI 1.0 specification.
EXIOptionsEXIOptions provides accessors for values associated with + EXI options in the EXI header of an EXI stream.
GrammarOptionsGrammarOptions computes a short integer that represents settings in the EXI Grammar settings + that determine how an EXI file will be encoded or decoded.
QNameQName is a pair comprised of a namespace name and a local name + to be used in a Datatype Representation Map (DTRM) definition + to denote an XSD datatype or an EXI datatype representation.
+  + +

+ + + + + + + + + +
+Enum Summary
AlignmentTypeAlignmentType represents one of the following bit alignment + styles so as to provide an extra degree of control over the + way information is stored in EXI format.
+  + +

+

+Package org.openexi.proc.common Description +

+ +

+ + + + + +
+

The common package contains classes, interfaces, and enumerators that define the vocabulary used to describe EXI streams (events, options, alignment, and character string values). +

+		 + +
+

+

+ +

+

+ +
+
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Overview   Package  Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+ + + diff --git a/third-party/org.openexi/nagasena/src/main/resources/doc/org/openexi/proc/common/package-tree.html b/third-party/org.openexi/nagasena/src/main/resources/doc/org/openexi/proc/common/package-tree.html new file mode 100644 index 0000000000..778ae7c56b --- /dev/null +++ b/third-party/org.openexi/nagasena/src/main/resources/doc/org/openexi/proc/common/package-tree.html @@ -0,0 +1,166 @@ + + + + + + + +org.openexi.proc.common Class Hierarchy + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Overview  Package  Class   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Hierarchy For Package org.openexi.proc.common +

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

+ +

+Interface Hierarchy +

+ +

+Enum Hierarchy +

+
    +
  • java.lang.Object
      +
    • java.lang.Enum<E> (implements java.lang.Comparable<T>, java.io.Serializable) + +
    +
+
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Overview  Package  Class   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+ + + diff --git a/third-party/org.openexi/nagasena/src/main/resources/doc/org/openexi/proc/grammars/GrammarCache.html b/third-party/org.openexi/nagasena/src/main/resources/doc/org/openexi/proc/grammars/GrammarCache.html new file mode 100644 index 0000000000..55b03fa67b --- /dev/null +++ b/third-party/org.openexi/nagasena/src/main/resources/doc/org/openexi/proc/grammars/GrammarCache.html @@ -0,0 +1,362 @@ + + + + + + + +GrammarCache + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Overview  Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +org.openexi.proc.grammars +
+Class GrammarCache

+
+java.lang.Object
+  extended by org.openexi.proc.grammars.GrammarCache
+
+
+
All Implemented Interfaces:
org.openexi.proc.common.IGrammarCache
+
+
+
+
public final class GrammarCache
extends java.lang.Object
implements org.openexi.proc.common.IGrammarCache
+ + +

+A GrammarCache object represents a set of EXI grammars used + for processing EXI streams using specific grammar options. + The GrammarCache is passed as an argument to + the EXIReader and Transmogrifier prior to processing an EXI stream. +

+ +

+

+ +
+
+ +

+ + + + + + + + + + + +
+Field Summary
+ shortgrammarOptions + +
+          Short integer that encapsulates GrammarOptions + for the EXI stream.
+  + + + + + + + + + + + + + + + + +
+Constructor Summary
GrammarCache(EXISchema schema) + +
+          Creates an instance of GrammarCache informed by a schema with default + grammar options.
GrammarCache(EXISchema schema, + short grammarOptions) + +
+          Creates an instance of GrammarCache informed by a schema with the + specified grammar options.
GrammarCache(short grammarOptions) + +
+          Creates an instance of GrammarCache with the specified grammar options.
+  + + + + + + + + + + + +
+Method Summary
+ EXISchemagetEXISchema() + +
+          Gets the compiled EXI Schema.
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  + + + + + + + +
Methods inherited from interface org.openexi.proc.common.IGrammarCache
getElementGrammarUse
+  +

+ + + + + + + + +
+Field Detail
+ +

+grammarOptions

+
+public final short grammarOptions
+
+
Short integer that encapsulates GrammarOptions + for the EXI stream. +

+

+
+
+ + + + + + + + +
+Constructor Detail
+ +

+GrammarCache

+
+public GrammarCache(EXISchema schema)
+
+
Creates an instance of GrammarCache informed by a schema with default + grammar options. +

+

+
Parameters:
EXISchema - compiled schema
+
+
+ +

+GrammarCache

+
+public GrammarCache(short grammarOptions)
+
+
Creates an instance of GrammarCache with the specified grammar options. +

+

+
Parameters:
grammarOptions - integer value that represents a grammar option configuration
+
+
+ +

+GrammarCache

+
+public GrammarCache(EXISchema schema,
+                    short grammarOptions)
+
+
Creates an instance of GrammarCache informed by a schema with the + specified grammar options. +

+

+
Parameters:
EXISchema - compiled schema
grammarOptions - integer value that represents a grammar option configuration
+
+ + + + + + + + +
+Method Detail
+ +

+getEXISchema

+
+public EXISchema getEXISchema()
+
+
Gets the compiled EXI Schema. +

+

+
Specified by:
getEXISchema in interface org.openexi.proc.common.IGrammarCache
+
+
+ +
Returns:
an EXI schema.
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Overview  Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + diff --git a/third-party/org.openexi/nagasena/src/main/resources/doc/org/openexi/proc/grammars/package-frame.html b/third-party/org.openexi/nagasena/src/main/resources/doc/org/openexi/proc/grammars/package-frame.html new file mode 100644 index 0000000000..5eb44a3df0 --- /dev/null +++ b/third-party/org.openexi/nagasena/src/main/resources/doc/org/openexi/proc/grammars/package-frame.html @@ -0,0 +1,33 @@ + + + + + + + +org.openexi.proc.grammars + + + + + + + + + + + +org.openexi.proc.grammars + + + + +
+Classes  + +
+GrammarCache
+ + + + diff --git a/third-party/org.openexi/nagasena/src/main/resources/doc/org/openexi/proc/grammars/package-summary.html b/third-party/org.openexi/nagasena/src/main/resources/doc/org/openexi/proc/grammars/package-summary.html new file mode 100644 index 0000000000..3ae5291fc4 --- /dev/null +++ b/third-party/org.openexi/nagasena/src/main/resources/doc/org/openexi/proc/grammars/package-summary.html @@ -0,0 +1,184 @@ + + + + + + + +org.openexi.proc.grammars + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Overview   Package  Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+

+Package org.openexi.proc.grammars +

+ + + +The grammars package contains the GrammarCache, which combines an XML Schema Definition with EXI grammar options to create an EXI Schema. +

+See: +
+          Description +

+ + + + + + + + + +
+Class Summary
GrammarCacheA GrammarCache object represents a set of EXI grammars used + for processing EXI streams using specific grammar options.
+  + +

+

+Package org.openexi.proc.grammars Description +

+ +

+ + + + + +
+

The grammars package contains the GrammarCache, which combines an XML Schema Definition with EXI grammar options to create an EXI Schema. +

+		 + +
+

+

+ +

+

+ +
+
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Overview   Package  Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+ + + diff --git a/third-party/org.openexi/nagasena/src/main/resources/doc/org/openexi/proc/grammars/package-tree.html b/third-party/org.openexi/nagasena/src/main/resources/doc/org/openexi/proc/grammars/package-tree.html new file mode 100644 index 0000000000..542514937f --- /dev/null +++ b/third-party/org.openexi/nagasena/src/main/resources/doc/org/openexi/proc/grammars/package-tree.html @@ -0,0 +1,149 @@ + + + + + + + +org.openexi.proc.grammars Class Hierarchy + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Overview  Package  Class   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Hierarchy For Package org.openexi.proc.grammars +

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

+
    +
  • java.lang.Object
      +
    • org.openexi.proc.grammars.GrammarCache (implements org.openexi.proc.common.IGrammarCache) +
    +
+
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Overview  Package  Class   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+ + + diff --git a/third-party/org.openexi/nagasena/src/main/resources/doc/org/openexi/proc/io/BinaryDataSink.html b/third-party/org.openexi/nagasena/src/main/resources/doc/org/openexi/proc/io/BinaryDataSink.html new file mode 100644 index 0000000000..0f9e531c25 --- /dev/null +++ b/third-party/org.openexi/nagasena/src/main/resources/doc/org/openexi/proc/io/BinaryDataSink.html @@ -0,0 +1,171 @@ + + + + + + + +BinaryDataSink + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Overview  Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +org.openexi.proc.io +
+Interface BinaryDataSink

+
+
+
public interface BinaryDataSink
+ + +

+BinaryDataSink represents a sink that accepts successive chunks of binary data. +

+ +

+

+ +
+
+ +

+ +

+ +

+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Overview  Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + diff --git a/third-party/org.openexi/nagasena/src/main/resources/doc/org/openexi/proc/io/CharacterBuffer.html b/third-party/org.openexi/nagasena/src/main/resources/doc/org/openexi/proc/io/CharacterBuffer.html new file mode 100644 index 0000000000..7b7e75e920 --- /dev/null +++ b/third-party/org.openexi/nagasena/src/main/resources/doc/org/openexi/proc/io/CharacterBuffer.html @@ -0,0 +1,259 @@ + + + + + + + +CharacterBuffer + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Overview  Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +org.openexi.proc.io +
+Class CharacterBuffer

+
+java.lang.Object
+  extended by org.openexi.proc.io.CharacterBuffer
+
+
+
+
public final class CharacterBuffer
extends java.lang.Object
+ + +

+

+ +
+
+ +

+ + + + + + + + + + + +
+Field Summary
+static intBUFSIZE_DEFAULT + +
+           
+  + + + + + + + + + + +
+Constructor Summary
CharacterBuffer(int bufSize) + +
+           
+  + + + + + + + +
+Method Summary
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+BUFSIZE_DEFAULT

+
+public static final int BUFSIZE_DEFAULT
+
+
+
See Also:
Constant Field Values
+
+ + + + + + + + +
+Constructor Detail
+ +

+CharacterBuffer

+
+public CharacterBuffer(int bufSize)
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Overview  Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + diff --git a/third-party/org.openexi/nagasena/src/main/resources/doc/org/openexi/proc/io/Scanner.html b/third-party/org.openexi/nagasena/src/main/resources/doc/org/openexi/proc/io/Scanner.html new file mode 100644 index 0000000000..82b51284e6 --- /dev/null +++ b/third-party/org.openexi/nagasena/src/main/resources/doc/org/openexi/proc/io/Scanner.html @@ -0,0 +1,354 @@ + + + + + + + +Scanner + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Overview  Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +org.openexi.proc.io +
+Class Scanner

+
+java.lang.Object
+  extended by org.openexi.proc.grammars.Apparatus
+      extended by org.openexi.proc.io.Scanner
+
+
+
+
public abstract class Scanner
extends org.openexi.proc.grammars.Apparatus
+ + +

+The Scanner class provides methods for scanning events + in the body of an EXI stream. +

+ +

+

+ +
+
+ +

+ + + + + + + +
+Field Summary
+  + + + + + + + +
Fields inherited from class org.openexi.proc.grammars.Apparatus
CODEC_BASE64BINARY, CODEC_BOOLEAN, CODEC_DATE, CODEC_DATETIME, CODEC_DECIMAL, CODEC_DOUBLE, CODEC_ENUMERATION, CODEC_GDAY, CODEC_GMONTH, CODEC_GMONTHDAY, CODEC_GYEAR, CODEC_GYEARMONTH, CODEC_HEXBINARY, CODEC_INTEGER, CODEC_LEXICAL, CODEC_LIST, CODEC_STRING, CODEC_TIME, currentState, eventTypesWorkSpace, schema, stringTable
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidcloseInputStream() + +
+          Close the input stream.
+ EXIOptionsgetHeaderOptions() + +
+          Returns the EXI Header options from the header of the + EXI stream, if present.
+abstract  EventDescriptionnextEvent() + +
+          Gets the next event from the EXI stream.
+abstract  voidsetBinaryChunkSize(int chunkSize) + +
+          Binary values are read in chunks of the specified size when the + use of binary data is enabled.
+ voidsetSchema(EXISchema schema, + QName[] dtrm, + int n_bindings) + +
+           
+  + + + + + + + +
Methods inherited from class org.openexi.proc.grammars.Apparatus
attribute, characters, endDocument, endElement, getAlignmentType, getNextEventCodes, getNextEventTypes, getPreserveLexicalValues, miscContent, nillify, reset, setPreserveLexicalValues, setStringTable, startDocument, startElement, startWildcardElement, undeclaredCharacters, wildcardAttribute, xsitp
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Method Detail
+ +

+setSchema

+
+public void setSchema(EXISchema schema,
+                      QName[] dtrm,
+                      int n_bindings)
+
+
+
Overrides:
setSchema in class org.openexi.proc.grammars.Apparatus
+
+
+
+
+
+
+ +

+nextEvent

+
+public abstract EventDescription nextEvent()
+                                    throws java.io.IOException
+
+
Gets the next event from the EXI stream. +

+

+ +
Returns:
EXIEvent +
Throws: +
java.io.IOException
+
+
+
+ +

+closeInputStream

+
+public void closeInputStream()
+                      throws java.io.IOException
+
+
Close the input stream. +

+

+ +
Throws: +
java.io.IOException
+
+
+
+ +

+getHeaderOptions

+
+public final EXIOptions getHeaderOptions()
+
+
Returns the EXI Header options from the header of the + EXI stream, if present. Otherwise, returns null. +

+

+ +
Returns:
EXIOptions or null if no header options are set.
+
+
+
+ +

+setBinaryChunkSize

+
+public abstract void setBinaryChunkSize(int chunkSize)
+
+
Binary values are read in chunks of the specified size when the + use of binary data is enabled. +

+

+
Parameters:
chunkSize -
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Overview  Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + diff --git a/third-party/org.openexi/nagasena/src/main/resources/doc/org/openexi/proc/io/package-frame.html b/third-party/org.openexi/nagasena/src/main/resources/doc/org/openexi/proc/io/package-frame.html new file mode 100644 index 0000000000..fe7bf70760 --- /dev/null +++ b/third-party/org.openexi/nagasena/src/main/resources/doc/org/openexi/proc/io/package-frame.html @@ -0,0 +1,46 @@ + + + + + + + +org.openexi.proc.io + + + + + + + + + + + +org.openexi.proc.io + + + + +
+Interfaces  + +
+BinaryDataSink
+ + + + + + +
+Classes  + +
+CharacterBuffer +
+Scanner
+ + + + diff --git a/third-party/org.openexi/nagasena/src/main/resources/doc/org/openexi/proc/io/package-summary.html b/third-party/org.openexi/nagasena/src/main/resources/doc/org/openexi/proc/io/package-summary.html new file mode 100644 index 0000000000..42831b8609 --- /dev/null +++ b/third-party/org.openexi/nagasena/src/main/resources/doc/org/openexi/proc/io/package-summary.html @@ -0,0 +1,205 @@ + + + + + + + +org.openexi.proc.io + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Overview   Package  Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+

+Package org.openexi.proc.io +

+ + + +The IO package contains the Scanner, which is used by EXIDecoder to read and interpret EXI streams. +

+See: +
+          Description +

+ + + + + + + + + +
+Interface Summary
BinaryDataSinkBinaryDataSink represents a sink that accepts successive chunks of binary data.
+  + +

+ + + + + + + + + + + + + +
+Class Summary
CharacterBuffer 
ScannerThe Scanner class provides methods for scanning events + in the body of an EXI stream.
+  + +

+

+Package org.openexi.proc.io Description +

+ +

+ + + + + +
+

The IO package contains the Scanner, which is used by EXIDecoder to read and interpret EXI streams. +

+

+The IO package also contains the non-public Scriber class, which is used by the Transmogrifier to encode EXI streams (which is why this is called the IO package). Scriber settings are fully implemented in the Transmogrifier. +

+		 + +
+

+

+ +

+

+ +
+
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Overview   Package  Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+ + + diff --git a/third-party/org.openexi/nagasena/src/main/resources/doc/org/openexi/proc/io/package-tree.html b/third-party/org.openexi/nagasena/src/main/resources/doc/org/openexi/proc/io/package-tree.html new file mode 100644 index 0000000000..b0cbe124ae --- /dev/null +++ b/third-party/org.openexi/nagasena/src/main/resources/doc/org/openexi/proc/io/package-tree.html @@ -0,0 +1,155 @@ + + + + + + + +org.openexi.proc.io Class Hierarchy + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Overview  Package  Class   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Hierarchy For Package org.openexi.proc.io +

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

+
    +
  • java.lang.Object +
+

+Interface Hierarchy +

+ +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Overview  Package  Class   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+ + + diff --git a/third-party/org.openexi/nagasena/src/main/resources/doc/org/openexi/proc/package-frame.html b/third-party/org.openexi/nagasena/src/main/resources/doc/org/openexi/proc/package-frame.html new file mode 100644 index 0000000000..31406d379f --- /dev/null +++ b/third-party/org.openexi/nagasena/src/main/resources/doc/org/openexi/proc/package-frame.html @@ -0,0 +1,55 @@ + + + + + + + +org.openexi.proc + + + + + + + + + + + +org.openexi.proc + + + + +
+Interfaces  + +
+EXISchemaResolver
+ + + + + + +
+Classes  + +
+EXIDecoder
+ + + + + + +
+Enums  + +
+HeaderOptionsOutputType
+ + + + diff --git a/third-party/org.openexi/nagasena/src/main/resources/doc/org/openexi/proc/package-summary.html b/third-party/org.openexi/nagasena/src/main/resources/doc/org/openexi/proc/package-summary.html new file mode 100644 index 0000000000..957e54a056 --- /dev/null +++ b/third-party/org.openexi/nagasena/src/main/resources/doc/org/openexi/proc/package-summary.html @@ -0,0 +1,219 @@ + + + + + + + +org.openexi.proc + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Overview   Package  Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+

+Package org.openexi.proc +

+ + + +The Proc (Processor) package contains the EXIDecoder, which is used to convert EXI streams to XML format. +

+See: +
+          Description +

+ + + + + + + + + +
+Interface Summary
EXISchemaResolverDevelopers have the option of implementing the EXISchemaResolver interface + to help EXIReader and EXIDecoder locate the correct grammar cache for parsing + an EXI stream.
+  + +

+ + + + + + + + + +
+Class Summary
EXIDecoderEXIDecoder provides methods to configure and + instantiate a Scanner object + you can use to parse the contents of an EXI stream.
+  + +

+ + + + + + + + + +
+Enum Summary
HeaderOptionsOutputTypeThis enumeration provides three possible settings for header options output.
+  + +

+

+Package org.openexi.proc Description +

+ +

+ + + + + +
+

The Proc (Processor) package contains the EXIDecoder, which is used to convert EXI streams to XML format. +EXIDecoder uses the org.openexi.proc.io.Scanner to parse EXI streams into a sequence of XML events. org.openexi.sax.EXIReader wraps EXIDecoder to provide a SAX interface for accessing the XML content. +

+

+The EXISchemaResolver interface can be implemented and used to add a hint in the EXI header to help EXIDecoder locate the EXISchema. +

+

The HeaderOptionsOutputType enumerator is used to set the header output options in the Transmogrifier.

 + +
+

+

+ +

+

+ +
+
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Overview   Package  Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+ + + diff --git a/third-party/org.openexi/nagasena/src/main/resources/doc/org/openexi/proc/package-tree.html b/third-party/org.openexi/nagasena/src/main/resources/doc/org/openexi/proc/package-tree.html new file mode 100644 index 0000000000..3bf180e361 --- /dev/null +++ b/third-party/org.openexi/nagasena/src/main/resources/doc/org/openexi/proc/package-tree.html @@ -0,0 +1,163 @@ + + + + + + + +org.openexi.proc Class Hierarchy + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Overview  Package  Class   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Hierarchy For Package org.openexi.proc +

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

+ +

+Interface Hierarchy +

+ +

+Enum Hierarchy +

+
    +
  • java.lang.Object
      +
    • java.lang.Enum<E> (implements java.lang.Comparable<T>, java.io.Serializable) + +
    +
+
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Overview  Package  Class   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+ + + diff --git a/third-party/org.openexi/nagasena/src/main/resources/doc/org/openexi/sax/BinaryDataHandler.html b/third-party/org.openexi/nagasena/src/main/resources/doc/org/openexi/sax/BinaryDataHandler.html new file mode 100644 index 0000000000..b73a833559 --- /dev/null +++ b/third-party/org.openexi/nagasena/src/main/resources/doc/org/openexi/sax/BinaryDataHandler.html @@ -0,0 +1,267 @@ + + + + + + + +BinaryDataHandler + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Overview  Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +org.openexi.sax +
+Interface BinaryDataHandler

+
+
All Known Subinterfaces:
SAXTransmogrifier
+
+
+
+
public interface BinaryDataHandler
+ + +

+

+ +
+
+ +

+ + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidbinaryData(byte[] byteArray, + int offset, + int length, + BinaryDataSink binaryDataSink) + +
+          Writes a binary value where the schema expects a binary value.
+ voidendBinaryData(BinaryDataSink binaryDataSink) + +
+          Mark the end of a binary value.
+ BinaryDataSinkstartBinaryData(long totalSize) + +
+          Mark the start of a binary value.
+  +

+ + + + + + + + +
+Method Detail
+ +

+startBinaryData

+
+BinaryDataSink startBinaryData(long totalSize)
+                               throws org.xml.sax.SAXException
+
+
Mark the start of a binary value. +

+

+ +
Throws: +
org.xml.sax.SAXException
+
+
+
+ +

+binaryData

+
+void binaryData(byte[] byteArray,
+                int offset,
+                int length,
+                BinaryDataSink binaryDataSink)
+                throws org.xml.sax.SAXException
+
+
Writes a binary value where the schema expects a binary value. +

+

+ +
Throws: +
org.xml.sax.SAXException
+
+
+
+ +

+endBinaryData

+
+void endBinaryData(BinaryDataSink binaryDataSink)
+                   throws org.xml.sax.SAXException
+
+
Mark the end of a binary value. +

+

+ +
Throws: +
org.xml.sax.SAXException
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Overview  Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + diff --git a/third-party/org.openexi/nagasena/src/main/resources/doc/org/openexi/sax/EXIReader.html b/third-party/org.openexi/nagasena/src/main/resources/doc/org/openexi/sax/EXIReader.html new file mode 100644 index 0000000000..228aa7506e --- /dev/null +++ b/third-party/org.openexi/nagasena/src/main/resources/doc/org/openexi/sax/EXIReader.html @@ -0,0 +1,645 @@ + + + + + + + +EXIReader + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Overview  Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +org.openexi.sax +
+Class EXIReader

+
+java.lang.Object
+  extended by org.openexi.sax.ReaderSupport
+      extended by org.openexi.sax.EXIReader
+
+
+
All Implemented Interfaces:
org.xml.sax.Attributes, org.xml.sax.XMLReader
+
+
+
+
public final class EXIReader
extends ReaderSupport
implements org.xml.sax.XMLReader
+ + +

+EXIReader implements the SAX XMLReader to provide a convenient and + familiar interface for decoding an EXI stream. +

+ +

+

+ +
+
+ +

+ + + + + + + + + + + +
+Constructor Summary
EXIReader() + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ booleangetFeature(java.lang.String name) + +
+          Get features for the SAX parser.
+ java.lang.ObjectgetProperty(java.lang.String name) + +
+          Use to retrieve the name of the lexical handler, currently the only + property recognized by this class.
+ voidsetAlignmentType(AlignmentType alignmentType) + +
+          Set the bit alignment style used to compile the EXI input stream.
+ voidsetBlockSize(int blockSize) + +
+          Set the size, in number of values, of the information that will be + processed as a chunk of the entire EXI stream.
+ voidsetDatatypeRepresentationMap(QName[] dtrm, + int n_bindings) + +
+          Set a datatype representation map.
+ voidsetEXISchemaResolver(EXISchemaResolver schemaResolver) + +
+          Set the EXISchemaResolver to retrieve the schema needed to decode the + current EXI stream.
+ voidsetFeature(java.lang.String name, + boolean value) + +
+          Set features for the SAX parser.
+ voidsetFragment(boolean isFragment) + +
+          Set to true if the EXI input stream is an XML fragment (a non-compliant + XML document with multiple root elements).
+ voidsetLexicalHandler(org.xml.sax.ext.LexicalHandler lexicalHandler) + +
+          Set a SAX lexical handler to receive SAX lexical events.
+ voidsetPreserveLexicalValues(boolean preserveLexicalValues) + +
+          Set to true if the EXI input stream was compiled with the Preserve Lexical + Values set to true.
+ voidsetProperty(java.lang.String name, + java.lang.Object value) + +
+          This method wraps the friendlier setLexicalHandler method to provide + syntax familiar to experienced SAX programmers.
+ voidsetValueMaxLength(int valueMaxLength) + +
+          Set the maximum length of a string that will be stored for reuse in the + String Table.
+ voidsetValuePartitionCapacity(int valuePartitionCapacity) + +
+          Set the maximum number of values in the String Table.
+  + + + + + + + +
Methods inherited from class org.openexi.sax.ReaderSupport
getContentHandler, setContentHandler, setGrammarCache
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  + + + + + + + +
Methods inherited from interface org.xml.sax.XMLReader
getContentHandler, getDTDHandler, getEntityResolver, getErrorHandler, parse, parse, setContentHandler, setDTDHandler, setEntityResolver, setErrorHandler
+  + + + + + + + +
Methods inherited from interface org.xml.sax.Attributes
getIndex, getIndex, getLength, getLocalName, getQName, getType, getType, getType, getURI, getValue, getValue, getValue
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+EXIReader

+
+public EXIReader()
+
+
+ + + + + + + + +
+Method Detail
+ +

+setProperty

+
+public final void setProperty(java.lang.String name,
+                              java.lang.Object value)
+                       throws org.xml.sax.SAXNotRecognizedException
+
+
This method wraps the friendlier setLexicalHandler method to provide + syntax familiar to experienced SAX programmers. The only property + supported is: 
http://xml.org/sax/properties/lexical-handler
+

+

+
Specified by:
setProperty in interface org.xml.sax.XMLReader
+
+
+
Parameters:
name - must equal "http://xml.org/sax/properties/lexical-handler"
value - an org.xml.sax.ext.LexicalHandler object +
Throws: +
org.xml.sax.SAXNotRecognizedException
+
+
+
+ +

+getProperty

+
+public final java.lang.Object getProperty(java.lang.String name)
+                                   throws org.xml.sax.SAXNotRecognizedException
+
+
Use to retrieve the name of the lexical handler, currently the only + property recognized by this class. Pass the String + "http://xml.org/sax/properties/lexical-handler" as the name. +

+

+
Specified by:
getProperty in interface org.xml.sax.XMLReader
+
+
+ +
Returns:
String name of the lexical handler +
Throws: +
org.xml.sax.SAXNotRecognizedException
+
+
+
+ +

+setFeature

+
+public final void setFeature(java.lang.String name,
+                             boolean value)
+                      throws org.xml.sax.SAXNotRecognizedException,
+                             org.xml.sax.SAXNotSupportedException
+
+
Set features for the SAX parser. The only supported arguments are 
+ EXIReader.setFeature("http://xml.org/sax/features/namespaces", true);
and 
+ EXIReader.setFeature("http://xml.org/sax/features/namespace-prefixes", false);
+

+

+
Specified by:
setFeature in interface org.xml.sax.XMLReader
+
+
+ +
Throws: +
org.xml.sax.SAXNotRecognizedException +
org.xml.sax.SAXNotSupportedException
+
+
+
+ +

+getFeature

+
+public final boolean getFeature(java.lang.String name)
+                         throws org.xml.sax.SAXNotRecognizedException
+
+
Get features for the SAX parser. +

+

+
Specified by:
getFeature in interface org.xml.sax.XMLReader
+
+
+ +
Returns:
true if the feature is "http://xml.org/sax/features/namespaces" + and false if the feature is "http://xml.org/sax/features/namespace-prefixes" +
Throws: +
org.xml.sax.SAXNotRecognizedException
+
+
+
+ +

+setAlignmentType

+
+public final void setAlignmentType(AlignmentType alignmentType)
+                            throws org.openexi.proc.common.EXIOptionsException
+
+
Set the bit alignment style used to compile the EXI input stream. +

+

+
+
+
+
Parameters:
alignmentType - AlignmentType +
Throws: +
org.openexi.proc.common.EXIOptionsException
+
+
+
+ +

+setFragment

+
+public final void setFragment(boolean isFragment)
+
+
Set to true if the EXI input stream is an XML fragment (a non-compliant + XML document with multiple root elements). +

+

+
+
+
+
Parameters:
isFragment - true if the EXI input stream is an XML fragment.
+
+
+
+ +

+setPreserveLexicalValues

+
+public final void setPreserveLexicalValues(boolean preserveLexicalValues)
+                                    throws org.openexi.proc.common.EXIOptionsException
+
+
Set to true if the EXI input stream was compiled with the Preserve Lexical + Values set to true. The original strings, rather than logical XML + equivalents, are restored in the XML output stream. +

+

+
+
+
+
Parameters:
preserveLexicalValues - set to true if the EXI input stream was compiled with + Preserve Lexical Values set to true. +
Throws: +
org.openexi.proc.common.EXIOptionsException
+
+
+
+ +

+setEXISchemaResolver

+
+public final void setEXISchemaResolver(EXISchemaResolver schemaResolver)
+
+
Set the EXISchemaResolver to retrieve the schema needed to decode the + current EXI stream. +

+

+
+
+
+
Parameters:
schemaResolver - EXISchemaResolver
+
+
+
+ +

+setDatatypeRepresentationMap

+
+public final void setDatatypeRepresentationMap(QName[] dtrm,
+                                               int n_bindings)
+                                        throws org.openexi.proc.common.EXIOptionsException
+
+
Set a datatype representation map. +

+

+
+
+
+
Parameters:
dtrm - a sequence of pairs of datatype qname and datatype representation qname
n_bindings - the number of qname pairs +
Throws: +
org.openexi.proc.common.EXIOptionsException
+
+
+
+ +

+setBlockSize

+
+public final void setBlockSize(int blockSize)
+                        throws org.openexi.proc.common.EXIOptionsException
+
+
Set the size, in number of values, of the information that will be + processed as a chunk of the entire EXI stream. Reducing the block size + can improve performance for devices with limited dynamic memory. + Default is 1,000,000 items (not 1MB, but 1,000,000 complete Attribute + and Element values). Block size is only used when the EXI stream is + encoded with EXI-compression. +

+

+
+
+
+
Parameters:
blockSize - number of values in each processing block. Default is 1,000,000. +
Throws: +
org.openexi.proc.common.EXIOptionsException
+
+
+
+ +

+setValueMaxLength

+
+public final void setValueMaxLength(int valueMaxLength)
+
+
Set the maximum length of a string that will be stored for reuse in the + String Table. By default, there is no maximum length. However, in data + sets that have long, unique strings of information, you can improve + performance by limiting the size to the length of strings that are more + likely to appear more than once. +

+

+
+
+
+
Parameters:
valueMaxLength - maximum length of entries in the String Table.
+
+
+
+ +

+setValuePartitionCapacity

+
+public final void setValuePartitionCapacity(int valuePartitionCapacity)
+
+
Set the maximum number of values in the String Table. By default, there + is no limit. If the target device has limited dynamic memory, limiting + the number of entries in the String Table can improve performance and + reduce the likelihood that you will exceed memory capacity. +

+

+
+
+
+
Parameters:
valuePartitionCapacity - maximum number of entries in the String Table
+
+
+
+ +

+setLexicalHandler

+
+public void setLexicalHandler(org.xml.sax.ext.LexicalHandler lexicalHandler)
+
+
Set a SAX lexical handler to receive SAX lexical events. +

+

+
+
+
+
Parameters:
lexicalHandler - SAX lexical handler
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Overview  Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + diff --git a/third-party/org.openexi/nagasena/src/main/resources/doc/org/openexi/sax/ReaderSupport.html b/third-party/org.openexi/nagasena/src/main/resources/doc/org/openexi/sax/ReaderSupport.html new file mode 100644 index 0000000000..7d392bb5b6 --- /dev/null +++ b/third-party/org.openexi/nagasena/src/main/resources/doc/org/openexi/sax/ReaderSupport.html @@ -0,0 +1,290 @@ + + + + + + + +ReaderSupport + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Overview  Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +org.openexi.sax +
+Class ReaderSupport

+
+java.lang.Object
+  extended by org.openexi.sax.ReaderSupport
+
+
+
All Implemented Interfaces:
org.xml.sax.Attributes
+
+
+
Direct Known Subclasses:
EXIReader
+
+
+
+
public abstract class ReaderSupport
extends java.lang.Object
implements org.xml.sax.Attributes
+ + +

+

+ +
+
+ +

+ + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ org.xml.sax.ContentHandlergetContentHandler() + +
+          Get the SAX content handler currently in use.
+ voidsetContentHandler(org.xml.sax.ContentHandler contentHandler) + +
+          Set a SAX content handler to receive SAX events.
+ voidsetGrammarCache(GrammarCache grammarCache) + +
+          Set the GrammarCache used in parsing EXI streams.
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  + + + + + + + +
Methods inherited from interface org.xml.sax.Attributes
getIndex, getIndex, getLength, getLocalName, getQName, getType, getType, getType, getURI, getValue, getValue, getValue
+  +

+ + + + + + + + +
+Method Detail
+ +

+setContentHandler

+
+public final void setContentHandler(org.xml.sax.ContentHandler contentHandler)
+
+
Set a SAX content handler to receive SAX events. +

+

+
+
+
+
Parameters:
contentHandler - SAX content handler
+
+
+
+ +

+getContentHandler

+
+public final org.xml.sax.ContentHandler getContentHandler()
+
+
Get the SAX content handler currently in use. +

+

+
+
+
+ +
Returns:
ContentHandler SAX content handler.
+
+
+
+ +

+setGrammarCache

+
+public void setGrammarCache(GrammarCache grammarCache)
+                     throws org.openexi.proc.common.EXIOptionsException
+
+
Set the GrammarCache used in parsing EXI streams. +

+

+
+
+
+
Parameters:
grammarCache - GrammarCache +
Throws: +
org.openexi.proc.common.EXIOptionsException
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Overview  Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + diff --git a/third-party/org.openexi/nagasena/src/main/resources/doc/org/openexi/sax/SAXTransmogrifier.html b/third-party/org.openexi/nagasena/src/main/resources/doc/org/openexi/sax/SAXTransmogrifier.html new file mode 100644 index 0000000000..15e2e7d77f --- /dev/null +++ b/third-party/org.openexi/nagasena/src/main/resources/doc/org/openexi/sax/SAXTransmogrifier.html @@ -0,0 +1,245 @@ + + + + + + + +SAXTransmogrifier + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Overview  Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +org.openexi.sax +
+Interface SAXTransmogrifier

+
+
All Superinterfaces:
BinaryDataHandler, org.xml.sax.ContentHandler, org.xml.sax.ext.LexicalHandler
+
+
+
+
public interface SAXTransmogrifier
extends org.xml.sax.ContentHandler, org.xml.sax.ext.LexicalHandler, BinaryDataHandler
+ + +

+Applications can directly feed SAX events into a transmogrifier through SAXTransmogrifier. +

+ +

+

+ +
+
+ +

+ + + + + + + + + + + + +
+Method Summary
+ GrammarCachegetGrammarCache() + +
+          Returns the GrammarCache that is in use by this SAXTransmogrifier.
+  + + + + + + + +
Methods inherited from interface org.xml.sax.ContentHandler
characters, endDocument, endElement, endPrefixMapping, ignorableWhitespace, processingInstruction, setDocumentLocator, skippedEntity, startDocument, startElement, startPrefixMapping
+  + + + + + + + +
Methods inherited from interface org.xml.sax.ext.LexicalHandler
comment, endCDATA, endDTD, endEntity, startCDATA, startDTD, startEntity
+  + + + + + + + +
Methods inherited from interface org.openexi.sax.BinaryDataHandler
binaryData, endBinaryData, startBinaryData
+  +

+ + + + + + + + +
+Method Detail
+ +

+getGrammarCache

+
+GrammarCache getGrammarCache()
+
+
Returns the GrammarCache that is in use by this SAXTransmogrifier. +

+

+
+
+
+ +
Returns:
a GrammarCache
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Overview  Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + diff --git a/third-party/org.openexi/nagasena/src/main/resources/doc/org/openexi/sax/Transmogrifier.html b/third-party/org.openexi/nagasena/src/main/resources/doc/org/openexi/sax/Transmogrifier.html new file mode 100644 index 0000000000..b857aab51c --- /dev/null +++ b/third-party/org.openexi/nagasena/src/main/resources/doc/org/openexi/sax/Transmogrifier.html @@ -0,0 +1,735 @@ + + + + + + + +Transmogrifier + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Overview  Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +org.openexi.sax +
+Class Transmogrifier

+
+java.lang.Object
+  extended by org.openexi.sax.Transmogrifier
+
+
+
+
public final class Transmogrifier
extends java.lang.Object
+ + +

+The Transmogrifier converts an XML stream to an EXI stream. +

+ +

+

+ +
+
+ +

+ + + + + + + + + + + + + + +
+Constructor Summary
Transmogrifier() + +
+          Create an instance of the Transmogrifier with a default SAX parser.
Transmogrifier(javax.xml.parsers.SAXParserFactory saxParserFactory) + +
+          Create an instance of the Transmogrifier, specifying the SAXParserFactory + from which to create the SAX parser.
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voidencode(org.xml.sax.InputSource is) + +
+          Parses XML input source and converts it to an EXI stream.
+ GrammarCachegetGrammarCache() + +
+          Returns the GrammarCache that was previously set.
+ SAXTransmogrifiergetSAXTransmogrifier() + +
+          Returns the SAXTransmogrifier, which implements both the ContentHandler + and LexicalHandler.
+ voidsetAlignmentType(AlignmentType alignmentType) + +
+          Set the bit alignment style for the encoded EXI stream.
+ voidsetBlockSize(int blockSize) + +
+          Set the size, in number of values, of the information that will be + processed as a chunk of the entire XML stream.
+ voidsetDatatypeRepresentationMap(QName[] dtrm, + int n_bindings) + +
+          Set a datatype representation map (DTRM).
+ voidsetEntityResolver(org.xml.sax.EntityResolver entityResolver) + +
+          Set an external SAX entity resolver.
+ voidsetFragment(boolean isFragment) + +
+          Set to true if the XML input stream is an XML fragment (a non-compliant + XML document with multiple root elements).
+ voidsetGrammarCache(GrammarCache grammarCache) + +
+          Set the GrammarCache used in transmogrifying XML data to EXI.
+ voidsetGrammarCache(GrammarCache grammarCache, + org.openexi.proc.common.SchemaId schemaId) + +
+          Set the GrammarCache to be used in encoding XML streams into EXI streams + by the transmogrifier.
+ voidsetOutputCookie(boolean outputCookie) + +
+          Tells the encoder whether to or not to start the stream by + adding an EXI cookie.
+ voidsetOutputOptions(HeaderOptionsOutputType outputOptions) + +
+          Set the header output options.
+ voidsetOutputStream(java.io.OutputStream ostream) + +
+          Set an output stream to which encoded streams are written.
+ voidsetPreserveLexicalValues(boolean preserveLexicalValues) + +
+          Set to true to preserve the original string values from the XML + stream.
+ voidsetPreserveWhitespaces(boolean preserveWhitespaces) + +
+          Set to true to preserve whitespace (for example, spaces, tabs, and + line breaks) in the encoded EXI stream.
+ voidsetResolveExternalGeneralEntities(boolean resolveExternalGeneralEntities) + +
+          Change the way a Transmogrifier handles external general entities.
+ voidsetValueMaxLength(int valueMaxLength) + +
+          Set the maximum length of a string that will be stored for reuse in the + String Table.
+ voidsetValuePartitionCapacity(int valuePartitionCapacity) + +
+          Set the maximum number of values in the String Table.
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+Transmogrifier

+
+public Transmogrifier()
+               throws org.openexi.sax.TransmogrifierRuntimeException
+
+
Create an instance of the Transmogrifier with a default SAX parser. +

+

+ +
Throws: +
TransmogrifierException +
org.openexi.sax.TransmogrifierRuntimeException
+
+
+ +

+Transmogrifier

+
+public Transmogrifier(javax.xml.parsers.SAXParserFactory saxParserFactory)
+               throws org.openexi.sax.TransmogrifierRuntimeException
+
+
Create an instance of the Transmogrifier, specifying the SAXParserFactory + from which to create the SAX parser. +

+

+
Parameters:
saxParserFactory - +
Throws: +
TransmogrifierException +
org.openexi.sax.TransmogrifierRuntimeException
+
+ + + + + + + + +
+Method Detail
+ +

+setResolveExternalGeneralEntities

+
+public void setResolveExternalGeneralEntities(boolean resolveExternalGeneralEntities)
+                                       throws TransmogrifierException
+
+
Change the way a Transmogrifier handles external general entities. When the value + of resolveExternalGeneralEntities is set to true, a Transmogrifier will try to + resolve external general entities. Otherwise, external general entities will not + be resolved. +

+

+
Parameters:
resolveExternalGeneralEntities - +
Throws: +
TransmogrifierException - Thrown when the underlying XMLReader does not + support the specified behavior.
+
+
+
+ +

+setOutputStream

+
+public final void setOutputStream(java.io.OutputStream ostream)
+
+
Set an output stream to which encoded streams are written. +

+

+
Parameters:
ostream - output stream
+
+
+
+ +

+setAlignmentType

+
+public final void setAlignmentType(AlignmentType alignmentType)
+                            throws org.openexi.proc.common.EXIOptionsException
+
+
Set the bit alignment style for the encoded EXI stream. +

+

+
Parameters:
alignmentType - AlignmentType. + Default is bit-packed. +
Throws: +
org.openexi.proc.common.EXIOptionsException
+
+
+
+ +

+setFragment

+
+public final void setFragment(boolean isFragment)
+
+
Set to true if the XML input stream is an XML fragment (a non-compliant + XML document with multiple root elements). +

+

+
Parameters:
isFragment - true if the XML input stream is an XML fragment.
+
+
+
+ +

+setBlockSize

+
+public final void setBlockSize(int blockSize)
+                        throws org.openexi.proc.common.EXIOptionsException
+
+
Set the size, in number of values, of the information that will be + processed as a chunk of the entire XML stream. Reducing the block size + can improve performance for devices with limited dynamic memory. + Default is 1,000,000 items (not 1MB, but 1,000,000 complete Attribute + and Element values). Block size is only used when the EXI stream is + encoded with EXI-compression. +

+

+
Parameters:
blockSize - number of values in each processing block. Default is 1,000,000. +
Throws: +
org.openexi.proc.common.EXIOptionsException
+
+
+
+ +

+setValueMaxLength

+
+public final void setValueMaxLength(int valueMaxLength)
+
+
Set the maximum length of a string that will be stored for reuse in the + String Table. By default, there is no maximum length. However, in data + sets that have long, unique strings of information, you can improve + performance by limiting the size to the length of strings that are more + likely to appear more than once. +

+

+
Parameters:
valueMaxLength - maximum length of entries in the String Table.
+
+
+
+ +

+setValuePartitionCapacity

+
+public final void setValuePartitionCapacity(int valuePartitionCapacity)
+
+
Set the maximum number of values in the String Table. By default, there + is no limit. If the target device has limited dynamic memory, limiting + the number of entries in the String Table can improve performance and + reduce the likelihood that you will exceed memory capacity. +

+

+
Parameters:
valuePartitionCapacity - maximum number of entries in the String Table
+
+
+
+ +

+setPreserveLexicalValues

+
+public final void setPreserveLexicalValues(boolean preserveLexicalValues)
+                                    throws org.openexi.proc.common.EXIOptionsException
+
+
Set to true to preserve the original string values from the XML + stream. For example, a date string might be converted to a different + format when interpreted by the Transmogrifier. Preserving the lexical values + ensures that the identical strings are restored, and not just their + logical values. +

+

+
Parameters:
preserveLexicalValues - true to keep original strings intact +
Throws: +
org.openexi.proc.common.EXIOptionsException
+
+
+
+ +

+setGrammarCache

+
+public final void setGrammarCache(GrammarCache grammarCache)
+                           throws org.openexi.proc.common.EXIOptionsException
+
+
Set the GrammarCache used in transmogrifying XML data to EXI. +

+

+
Parameters:
grammarCache - GrammarCache +
Throws: +
org.openexi.proc.common.EXIOptionsException
+
+
+
+ +

+setGrammarCache

+
+public final void setGrammarCache(GrammarCache grammarCache,
+                                  org.openexi.proc.common.SchemaId schemaId)
+                           throws org.openexi.proc.common.EXIOptionsException
+
+
Set the GrammarCache to be used in encoding XML streams into EXI streams + by the transmogrifier. + The SchemaId contains the string that is written in the header when + HeaderOptionsOutputType.all is set. +

+

+
Parameters:
grammarCache - GrammarCache
schemaId - +
Throws: +
org.openexi.proc.common.EXIOptionsException
+
+
+
+ +

+getGrammarCache

+
+public final GrammarCache getGrammarCache()
+
+
Returns the GrammarCache that was previously set. +

+

+ +
Returns:
a GrammarCache
+
+
+
+ +

+setDatatypeRepresentationMap

+
+public final void setDatatypeRepresentationMap(QName[] dtrm,
+                                               int n_bindings)
+                                        throws org.openexi.proc.common.EXIOptionsException
+
+
Set a datatype representation map (DTRM). The DTRM allows you to remap + XMLSchema datatypes to EXI datatypes other than their default equivalents. + The map is created using a sequence of Qualified Name pairs that identify + a datatype definition in the XMLSchema namespace followed by the new + corresponding datatype mapping in the EXI namespace. +

+ For example, the following lines map the boolean datatype from XMLSchema + to the integer datatype in EXI. + 
+   QName q1 = new QName("xsd:boolean","http://www.w3.org/2001/XMLSchema");
+   QName q2 = new QName("exi:integer","http://www.w3.org/2009/exi");
+   QName[] dtrm = new QName[2];
+   dtrm = {q1, q2}; // Each mapping requires 2 qualified names.
+   transmogrifierInstance.setDatatypeRepresentationMap(dtrm, 1); // The array, and the number of pairs (1).
+
+

+

+
Parameters:
dtrm - a sequence of pairs of datatype QName and datatype representation QName
n_bindings - the number of QName pairs +
Throws: +
org.openexi.proc.common.EXIOptionsException
+
+
+
+ +

+setEntityResolver

+
+public final void setEntityResolver(org.xml.sax.EntityResolver entityResolver)
+
+
Set an external SAX entity resolver. +

+

+
Parameters:
entityResolver - EntityResolver
+
+
+
+ +

+setOutputCookie

+
+public final void setOutputCookie(boolean outputCookie)
+
+
Tells the encoder whether to or not to start the stream by + adding an EXI cookie. +

+

+
Parameters:
outputCookie - true to include the EXI cookie
+
+
+
+ +

+setOutputOptions

+
+public final void setOutputOptions(HeaderOptionsOutputType outputOptions)
+                            throws org.openexi.proc.common.EXIOptionsException
+
+
Set the header output options. Choices are set using the + HeaderOptionsOutputType enumeration. + Options are all, lessSchemaID (that is, all values + except for the SchemaId), or none. +

+

+
Parameters:
outputOptions - HeaderOptionsOutputType +
Throws: +
org.openexi.proc.common.EXIOptionsException
+
+
+
+ +

+setPreserveWhitespaces

+
+public final void setPreserveWhitespaces(boolean preserveWhitespaces)
+
+
Set to true to preserve whitespace (for example, spaces, tabs, and + line breaks) in the encoded EXI stream. By default, non-essential whitespace + is removed from the encoded stream. +

+

+
Parameters:
preserveWhitespaces - true to retain whitespace in the encoded EXI stream
+
+
+
+ +

+encode

+
+public void encode(org.xml.sax.InputSource is)
+            throws TransmogrifierException,
+                   java.io.IOException
+
+
Parses XML input source and converts it to an EXI stream. +

+

+
Parameters:
is - XML input source +
Throws: +
TransmogrifierException +
java.io.IOException
+
+
+
+ +

+getSAXTransmogrifier

+
+public SAXTransmogrifier getSAXTransmogrifier()
+
+
Returns the SAXTransmogrifier, which implements both the ContentHandler + and LexicalHandler. SAX programmers can connect the SAXTransmogrifier to + their favorite XML Parser to convert SAX events into an EXI stream. +

+

+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Overview  Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + diff --git a/third-party/org.openexi/nagasena/src/main/resources/doc/org/openexi/sax/TransmogrifierException.html b/third-party/org.openexi/nagasena/src/main/resources/doc/org/openexi/sax/TransmogrifierException.html new file mode 100644 index 0000000000..55e1e1feaa --- /dev/null +++ b/third-party/org.openexi/nagasena/src/main/resources/doc/org/openexi/sax/TransmogrifierException.html @@ -0,0 +1,566 @@ + + + + + + + +TransmogrifierException + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Overview  Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +org.openexi.sax +
+Class TransmogrifierException

+
+java.lang.Object
+  extended by java.lang.Throwable
+      extended by java.lang.Exception
+          extended by org.openexi.sax.TransmogrifierException
+
+
+
All Implemented Interfaces:
java.io.Serializable
+
+
+
+
public final class TransmogrifierException
extends java.lang.Exception
+ + +

+Exception handler for the Transmogrifier. +

+ +

+

+
See Also:
Serialized Form +
+
+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Field Summary
+static intPREFIX_BOUND_TO_ANOTHER_NAMESPACE + +
+          Prefix is bound to another namespace.
+static intPREFIX_NOT_BOUND + +
+          Prefix is not bound.
+static intSAX_ERROR + +
+          SAX error reported by XML parser.
+static intSCRIBER_ERROR + +
+          Errors reported by Scriber.
+static intUNEXPECTED_ATTR + +
+          Unexpected Attribute.
+static intUNEXPECTED_BINARY_VALUE + +
+          Unexpected Binary value.
+static intUNEXPECTED_CHARS + +
+          Unexpected Character Sequence.
+static intUNEXPECTED_ED + +
+          Unexpected End of Document event.
+static intUNEXPECTED_ELEM + +
+          Unexpected Element.
+static intUNEXPECTED_END_ELEM + +
+          Unexpected End of Element event.
+static intUNEXPECTED_SD + +
+          Unexpected Start of Document event.
+static intUNHANDLED_SAXPARSER_FEATURE + +
+          Unhandled SAX parser feature.
+  + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ intgetCode() + +
+          Returns a code that represents the type of the exception.
+ java.lang.ExceptiongetException() + +
+          Returns an Exception object.
+ org.xml.sax.LocatorgetLocator() + +
+          Returns the locator that is associated with this compilation error.
+ java.lang.StringgetMessage() + +
+          Returns a message that describes the exception.
+  + + + + + + + +
Methods inherited from class java.lang.Throwable
fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+UNEXPECTED_ELEM

+
+public static final int UNEXPECTED_ELEM
+
+
Unexpected Element. +

+

+
See Also:
Constant Field Values
+
+
+ +

+UNEXPECTED_ATTR

+
+public static final int UNEXPECTED_ATTR
+
+
Unexpected Attribute. +

+

+
See Also:
Constant Field Values
+
+
+ +

+UNEXPECTED_CHARS

+
+public static final int UNEXPECTED_CHARS
+
+
Unexpected Character Sequence. +

+

+
See Also:
Constant Field Values
+
+
+ +

+UNEXPECTED_BINARY_VALUE

+
+public static final int UNEXPECTED_BINARY_VALUE
+
+
Unexpected Binary value. +

+

+
See Also:
Constant Field Values
+
+
+ +

+UNHANDLED_SAXPARSER_FEATURE

+
+public static final int UNHANDLED_SAXPARSER_FEATURE
+
+
Unhandled SAX parser feature. +

+

+
See Also:
Constant Field Values
+
+
+ +

+SAX_ERROR

+
+public static final int SAX_ERROR
+
+
SAX error reported by XML parser. +

+

+
See Also:
Constant Field Values
+
+
+ +

+UNEXPECTED_END_ELEM

+
+public static final int UNEXPECTED_END_ELEM
+
+
Unexpected End of Element event. +

+

+
See Also:
Constant Field Values
+
+
+ +

+UNEXPECTED_ED

+
+public static final int UNEXPECTED_ED
+
+
Unexpected End of Document event. +

+

+
See Also:
Constant Field Values
+
+
+ +

+UNEXPECTED_SD

+
+public static final int UNEXPECTED_SD
+
+
Unexpected Start of Document event. +

+

+
See Also:
Constant Field Values
+
+
+ +

+PREFIX_NOT_BOUND

+
+public static final int PREFIX_NOT_BOUND
+
+
Prefix is not bound. +

+

+
See Also:
Constant Field Values
+
+
+ +

+PREFIX_BOUND_TO_ANOTHER_NAMESPACE

+
+public static final int PREFIX_BOUND_TO_ANOTHER_NAMESPACE
+
+
Prefix is bound to another namespace. +

+

+
See Also:
Constant Field Values
+
+
+ +

+SCRIBER_ERROR

+
+public static final int SCRIBER_ERROR
+
+
Errors reported by Scriber. +

+

+
See Also:
Constant Field Values
+
+ + + + + + + + +
+Method Detail
+ +

+getCode

+
+public int getCode()
+
+
Returns a code that represents the type of the exception. +

+

+ +
Returns:
error code
+
+
+
+ +

+getMessage

+
+public java.lang.String getMessage()
+
+
Returns a message that describes the exception. +

+

+
Overrides:
getMessage in class java.lang.Throwable
+
+
+ +
Returns:
error message
+
+
+
+ +

+getException

+
+public java.lang.Exception getException()
+
+
Returns an Exception object. +

+

+ +
Returns:
the error as an Exception instance
+
+
+
+ +

+getLocator

+
+public org.xml.sax.Locator getLocator()
+
+
Returns the locator that is associated with this compilation error. +

+

+ +
Returns:
a Locator if available, otherwise null
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Overview  Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + diff --git a/third-party/org.openexi/nagasena/src/main/resources/doc/org/openexi/sax/package-frame.html b/third-party/org.openexi/nagasena/src/main/resources/doc/org/openexi/sax/package-frame.html new file mode 100644 index 0000000000..22e45d692b --- /dev/null +++ b/third-party/org.openexi/nagasena/src/main/resources/doc/org/openexi/sax/package-frame.html @@ -0,0 +1,61 @@ + + + + + + + +org.openexi.sax + + + + + + + + + + + +org.openexi.sax + + + + +
+Interfaces  + +
+BinaryDataHandler +
+SAXTransmogrifier
+ + + + + + +
+Classes  + +
+EXIReader +
+ReaderSupport +
+Transmogrifier
+ + + + + + +
+Exceptions  + +
+TransmogrifierException
+ + + + diff --git a/third-party/org.openexi/nagasena/src/main/resources/doc/org/openexi/sax/package-summary.html b/third-party/org.openexi/nagasena/src/main/resources/doc/org/openexi/sax/package-summary.html new file mode 100644 index 0000000000..b0e720814c --- /dev/null +++ b/third-party/org.openexi/nagasena/src/main/resources/doc/org/openexi/sax/package-summary.html @@ -0,0 +1,224 @@ + + + + + + + +org.openexi.sax + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Overview   Package  Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+

+Package org.openexi.sax +

+ + + +The SAX package contains the Transmogrifier, which encodes an XML file to an EXI stream, and the EXIReader, which restores an EXI stream to its logical XML equivalent. +

+See: +
+          Description +

+ + + + + + + + + + + + + +
+Interface Summary
BinaryDataHandler 
SAXTransmogrifierApplications can directly feed SAX events into a transmogrifier through SAXTransmogrifier.
+  + +

+ + + + + + + + + + + + + + + + + +
+Class Summary
EXIReaderEXIReader implements the SAX XMLReader to provide a convenient and + familiar interface for decoding an EXI stream.
ReaderSupport 
TransmogrifierThe Transmogrifier converts an XML stream to an EXI stream.
+  + +

+ + + + + + + + + +
+Exception Summary
TransmogrifierExceptionException handler for the Transmogrifier.
+  + +

+

+Package org.openexi.sax Description +

+ +

+ + + + + +
+

The SAX package contains the Transmogrifier, which encodes an XML file to an EXI stream, and the EXIReader, which restores an EXI stream to its logical XML equivalent. These classes are wrappers for the Scriber and EXIDecoder, respectively, and are primarily meant to provide access to EXI using familiar SAX syntax. +

+		 + +
+

+

+ +

+

+ +
+
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Overview   Package  Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+ + + diff --git a/third-party/org.openexi/nagasena/src/main/resources/doc/org/openexi/sax/package-tree.html b/third-party/org.openexi/nagasena/src/main/resources/doc/org/openexi/sax/package-tree.html new file mode 100644 index 0000000000..f4184bf934 --- /dev/null +++ b/third-party/org.openexi/nagasena/src/main/resources/doc/org/openexi/sax/package-tree.html @@ -0,0 +1,171 @@ + + + + + + + +org.openexi.sax Class Hierarchy + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Overview  Package  Class   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Hierarchy For Package org.openexi.sax +

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

+
    +
  • java.lang.Object +
+

+Interface Hierarchy +

+ +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Overview  Package  Class   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+ + + diff --git a/third-party/org.openexi/nagasena/src/main/resources/doc/org/openexi/schema/Characters.html b/third-party/org.openexi/nagasena/src/main/resources/doc/org/openexi/schema/Characters.html new file mode 100644 index 0000000000..022f5be35a --- /dev/null +++ b/third-party/org.openexi/nagasena/src/main/resources/doc/org/openexi/schema/Characters.html @@ -0,0 +1,486 @@ + + + + + + + +Characters + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Overview  Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +org.openexi.schema +
+Class Characters

+
+java.lang.Object
+  extended by org.openexi.schema.Characters
+
+
+
+
public final class Characters
extends java.lang.Object
+ + +

+

+ +
+
+ +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Field Summary
+ char[]characters + +
+           
+static CharactersCHARACTERS_EMPTY + +
+           
+ booleanisVolatile + +
+           
+ intlength + +
+           
+ intstartIndex + +
+           
+ intucsCount + +
+           
+  + + + + + + + + + + +
+Constructor Summary
Characters(char[] characters, + int startIndex, + int length, + boolean isVolatile) + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ booleanequals(java.lang.Object object) + +
+           
+ inthashCode() + +
+           
+ intindexOf(char c) + +
+           
+ java.lang.StringmakeString() + +
+           
+ java.lang.Stringsubstring(int beginIndex, + int endIndex) + +
+           
+ voidturnPermanent() + +
+           
+  + + + + + + + +
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+isVolatile

+
+public boolean isVolatile
+
+
+
+
+
+ +

+characters

+
+public char[] characters
+
+
+
+
+
+ +

+startIndex

+
+public int startIndex
+
+
+
+
+
+ +

+length

+
+public final int length
+
+
+
+
+
+ +

+ucsCount

+
+public final int ucsCount
+
+
+
+
+
+ +

+CHARACTERS_EMPTY

+
+public static final Characters CHARACTERS_EMPTY
+
+
+
+
+ + + + + + + + +
+Constructor Detail
+ +

+Characters

+
+public Characters(char[] characters,
+                  int startIndex,
+                  int length,
+                  boolean isVolatile)
+
+
+ + + + + + + + +
+Method Detail
+ +

+turnPermanent

+
+public void turnPermanent()
+
+
+
+
+
+
+ +

+indexOf

+
+public int indexOf(char c)
+
+
+
+
+
+
+ +

+substring

+
+public java.lang.String substring(int beginIndex,
+                                  int endIndex)
+
+
+
+
+
+
+ +

+hashCode

+
+public int hashCode()
+
+
+
Overrides:
hashCode in class java.lang.Object
+
+
+
+
+
+
+ +

+equals

+
+public boolean equals(java.lang.Object object)
+
+
+
Overrides:
equals in class java.lang.Object
+
+
+
+
+
+
+ +

+makeString

+
+public java.lang.String makeString()
+
+
+
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Overview  Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + diff --git a/third-party/org.openexi/nagasena/src/main/resources/doc/org/openexi/schema/EXISchema.html b/third-party/org.openexi/nagasena/src/main/resources/doc/org/openexi/schema/EXISchema.html new file mode 100644 index 0000000000..f3c472ec5e --- /dev/null +++ b/third-party/org.openexi/nagasena/src/main/resources/doc/org/openexi/schema/EXISchema.html @@ -0,0 +1,355 @@ + + + + + + + +EXISchema + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Overview  Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +org.openexi.schema +
+Class EXISchema

+
+java.lang.Object
+  extended by org.openexi.schema.EXISchema
+
+
+
+
public final class EXISchema
extends java.lang.Object
+ + +

+EXISchema provides methods to read and write compiled EXI schemas. +

+ +

+

+ +
+
+ +

+ + + + + + + + + + + +
+Field Summary
+ byte[]ancestryIds + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+static boolean_isSimpleType(int tp, + int[] types) + +
+           
+ booleanisSimpleType(int tp) + +
+           
+static EXISchemareadIn(java.io.DataInputStream in) + +
+          Reads an EXI Schema from a DataInputStream.
+ voidwriteOut(java.io.DataOutputStream out) + +
+          Writes out a serialized EXISchema.
+ voidwriteXml(java.io.OutputStream out, + boolean whole) + +
+           
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+ancestryIds

+
+public transient byte[] ancestryIds
+
+
+
+
+ + + + + + + + +
+Method Detail
+ +

+isSimpleType

+
+public boolean isSimpleType(int tp)
+
+
+
+
+
+
+ +

+_isSimpleType

+
+public static boolean _isSimpleType(int tp,
+                                    int[] types)
+
+
+
+
+
+
+ +

+readIn

+
+public static EXISchema readIn(java.io.DataInputStream in)
+                        throws java.io.IOException,
+                               java.lang.ClassNotFoundException
+
+
Reads an EXI Schema from a DataInputStream. +

+

+
Parameters:
in - DataInputStream containing a serialized EXISchema +
Returns:
EXISchema +
Throws: +
IOException, - ClassNotFoundException +
java.io.IOException +
java.lang.ClassNotFoundException
+
+
+
+ +

+writeOut

+
+public void writeOut(java.io.DataOutputStream out)
+              throws java.io.IOException
+
+
Writes out a serialized EXISchema. +

+

+
Parameters:
out - DataOutputStream to receive the serialized EXISchema +
Throws: +
java.io.IOException
+
+
+
+ +

+writeXml

+
+public void writeXml(java.io.OutputStream out,
+                     boolean whole)
+              throws java.io.IOException
+
+
+ +
Throws: +
java.io.IOException
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Overview  Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + diff --git a/third-party/org.openexi/nagasena/src/main/resources/doc/org/openexi/schema/EmptySchema.html b/third-party/org.openexi/nagasena/src/main/resources/doc/org/openexi/schema/EmptySchema.html new file mode 100644 index 0000000000..2a932cc5fb --- /dev/null +++ b/third-party/org.openexi/nagasena/src/main/resources/doc/org/openexi/schema/EmptySchema.html @@ -0,0 +1,229 @@ + + + + + + + +EmptySchema + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Overview  Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +org.openexi.schema +
+Class EmptySchema

+
+java.lang.Object
+  extended by org.openexi.schema.EmptySchema
+
+
+
+
public final class EmptySchema
extends java.lang.Object
+ + +

+EmptySchema provides an EXISchema that supports all datatypes inherent + in XML Schema such as xsd:int and xsd:dateTime, but with no + user-specific definitions. This is to support the use of dynamic + datatype associations discovered within elements during processing. +

+ +

+

+ +
+
+ +

+ + + + + + + + + + + + +
+Method Summary
+static EXISchemagetEXISchema() + +
+          Returns an EXISchema that supports all datatypes inherent in XML Schema.
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Method Detail
+ +

+getEXISchema

+
+public static EXISchema getEXISchema()
+
+
Returns an EXISchema that supports all datatypes inherent in XML Schema. + Calls to this method always return the same object. +

+

+ +
Returns:
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Overview  Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + diff --git a/third-party/org.openexi/nagasena/src/main/resources/doc/org/openexi/schema/package-frame.html b/third-party/org.openexi/nagasena/src/main/resources/doc/org/openexi/schema/package-frame.html new file mode 100644 index 0000000000..4fdd831792 --- /dev/null +++ b/third-party/org.openexi/nagasena/src/main/resources/doc/org/openexi/schema/package-frame.html @@ -0,0 +1,37 @@ + + + + + + + +org.openexi.schema + + + + + + + + + + + +org.openexi.schema + + + + +
+Classes  + +
+Characters +
+EmptySchema +
+EXISchema
+ + + + diff --git a/third-party/org.openexi/nagasena/src/main/resources/doc/org/openexi/schema/package-summary.html b/third-party/org.openexi/nagasena/src/main/resources/doc/org/openexi/schema/package-summary.html new file mode 100644 index 0000000000..53242f2e32 --- /dev/null +++ b/third-party/org.openexi/nagasena/src/main/resources/doc/org/openexi/schema/package-summary.html @@ -0,0 +1,195 @@ + + + + + + + +org.openexi.schema + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Overview   Package  Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+

+Package org.openexi.schema +

+ + + +The schema package contains classes that are used to represent XML Schema Documents (XSDs). +

+See: +
+          Description +

+ + + + + + + + + + + + + + + + + +
+Class Summary
Characters 
EmptySchemaEmptySchema provides an EXISchema that supports all datatypes inherent + in XML Schema such as xsd:int and xsd:dateTime, but with no + user-specific definitions.
EXISchemaEXISchema provides methods to read and write compiled EXI schemas.
+  + +

+

+Package org.openexi.schema Description +

+ +

+ + + + + +
+

The schema package contains classes that are used to represent XML Schema Documents (XSDs). EXISchema.writeOut writes an EXISchema to a DataOutputStream (which is typically saved to disk). EXISchema.readIn returns an EXISchema from a DataInputStream (typically from a file on disk), saving the step of processing the schema at runtime. +

+

+EmptySchema is used to create an explicit schema object with default settings. This is to enable the EXIDecoder and Transmogrifier to process element tags that have embedded datatype overrides. +

 + +
+

+

+ +

+

+ +
+
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Overview   Package  Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+ + + diff --git a/third-party/org.openexi/nagasena/src/main/resources/doc/org/openexi/schema/package-tree.html b/third-party/org.openexi/nagasena/src/main/resources/doc/org/openexi/schema/package-tree.html new file mode 100644 index 0000000000..dda7f6246f --- /dev/null +++ b/third-party/org.openexi/nagasena/src/main/resources/doc/org/openexi/schema/package-tree.html @@ -0,0 +1,148 @@ + + + + + + + +org.openexi.schema Class Hierarchy + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Overview  Package  Class   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Hierarchy For Package org.openexi.schema +

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

+ +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Overview  Package  Class   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+ + + diff --git a/third-party/org.openexi/nagasena/src/main/resources/doc/org/openexi/scomp/EXISchemaFactory.html b/third-party/org.openexi/nagasena/src/main/resources/doc/org/openexi/scomp/EXISchemaFactory.html new file mode 100644 index 0000000000..7a95df8e6d --- /dev/null +++ b/third-party/org.openexi/nagasena/src/main/resources/doc/org/openexi/scomp/EXISchemaFactory.html @@ -0,0 +1,308 @@ + + + + + + + +EXISchemaFactory + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Overview  Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +org.openexi.scomp +
+Class EXISchemaFactory

+
+java.lang.Object
+  extended by EXISchemaStruct
+      extended by org.openexi.scomp.EXISchemaFactory
+
+
+
+
public class EXISchemaFactory
extends EXISchemaStruct
+ + +

+EXISchemaFactory compiles XML Schema into an EXISchema instance. +

+ +

+

+ +
+
+ +

+ + + + + + + + + + + +
+Constructor Summary
EXISchemaFactory() + +
+           
+  + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ EXISchemacompile(org.xml.sax.InputSource inputSource) + +
+          Compile an XML Schema Document into an EXISchema.
+ voidsetCompilerErrorHandler(EXISchemaFactoryErrorHandler errorHandler) + +
+          Set an error handler to report any errors encountered during + schema compilation.
+ voidsetEntityResolver(EntityResolverEx entityResolver) + +
+          Set an entity resolver for use to resolve entities and schema documents.
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+EXISchemaFactory

+
+public EXISchemaFactory()
+
+
+ + + + + + + + +
+Method Detail
+ +

+setCompilerErrorHandler

+
+public void setCompilerErrorHandler(EXISchemaFactoryErrorHandler errorHandler)
+
+
Set an error handler to report any errors encountered during + schema compilation. +

+

+
Parameters:
errorHandler - Error handler
+
+
+
+ +

+setEntityResolver

+
+public void setEntityResolver(EntityResolverEx entityResolver)
+
+
Set an entity resolver for use to resolve entities and schema documents. +

+

+
Parameters:
entityResolverEx - extended SAX entity resolver
+
+
+
+ +

+compile

+
+public final EXISchema compile(org.xml.sax.InputSource inputSource)
+                        throws java.io.IOException,
+                               EXISchemaFactoryException
+
+
Compile an XML Schema Document into an EXISchema. +

+

+
Parameters:
is - XML Schema Document stream from an InputSource +
Returns:
an EXISchema instance +
Throws: +
java.io.IOException +
EXISchemaFactoryException
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Overview  Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + diff --git a/third-party/org.openexi/nagasena/src/main/resources/doc/org/openexi/scomp/EXISchemaFactoryErrorHandler.html b/third-party/org.openexi/nagasena/src/main/resources/doc/org/openexi/scomp/EXISchemaFactoryErrorHandler.html new file mode 100644 index 0000000000..48648e4635 --- /dev/null +++ b/third-party/org.openexi/nagasena/src/main/resources/doc/org/openexi/scomp/EXISchemaFactoryErrorHandler.html @@ -0,0 +1,268 @@ + + + + + + + +EXISchemaFactoryErrorHandler + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Overview  Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +org.openexi.scomp +
+Interface EXISchemaFactoryErrorHandler

+
+
+
public interface EXISchemaFactoryErrorHandler
+ + +

+This interface reports exceptions from EXISchemaFactory during schema + processing. Users of EXISchemaFactory need to provide an + implementation of this interface to receive errors from EXISchemaFactory. +

+ +

+

+
Author:
+
Dennis Dawson
+ +
+
+ +

+ + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ voiderror(EXISchemaFactoryException exc) + +
+          Report an error found during schema processing.
+ voidfatalError(EXISchemaFactoryException exc) + +
+          Report a fatal error found during schema processing.
+ voidwarning(EXISchemaFactoryException exc) + +
+          Report a warning found during schema processing.
+  +

+ + + + + + + + +
+Method Detail
+ +

+warning

+
+void warning(EXISchemaFactoryException exc)
+             throws EXISchemaFactoryException
+
+
Report a warning found during schema processing. +

+

+
Parameters:
exc - warning found +
Throws: +
EXISchemaFactoryException - at the discretion of the application
+
+
+
+ +

+error

+
+void error(EXISchemaFactoryException exc)
+           throws EXISchemaFactoryException
+
+
Report an error found during schema processing. Note that errors are + recoverable only as far as the schema processor is concerned. They might + be fatal at the application level. +

+

+
Parameters:
exc - error found +
Throws: +
EXISchemaFactoryException - at the discretion of the application
+
+
+
+ +

+fatalError

+
+void fatalError(EXISchemaFactoryException exc)
+                throws EXISchemaFactoryException
+
+
Report a fatal error found during schema processing. +

+

+
Parameters:
exc - fatal error found +
Throws: +
EXISchemaFactoryException - at the discretion of the application
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Overview  Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + diff --git a/third-party/org.openexi/nagasena/src/main/resources/doc/org/openexi/scomp/EXISchemaFactoryException.html b/third-party/org.openexi/nagasena/src/main/resources/doc/org/openexi/scomp/EXISchemaFactoryException.html new file mode 100644 index 0000000000..598f7db597 --- /dev/null +++ b/third-party/org.openexi/nagasena/src/main/resources/doc/org/openexi/scomp/EXISchemaFactoryException.html @@ -0,0 +1,350 @@ + + + + + + + +EXISchemaFactoryException + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Overview  Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +org.openexi.scomp +
+Class EXISchemaFactoryException

+
+java.lang.Object
+  extended by java.lang.Throwable
+      extended by java.lang.Exception
+          extended by org.openexi.scomp.EXISchemaFactoryException
+
+
+
All Implemented Interfaces:
java.io.Serializable
+
+
+
+
public class EXISchemaFactoryException
extends java.lang.Exception
+ + +

+Any errors encountered during schema compilation are communicated to + an application as EXISchemaFactoryException objects. +

+ +

+

+
See Also:
EXISchemaFactoryErrorHandler, +Serialized Form
Author:
+
Dennis Dawson
+ +
+
+ +

+ + + + + + + + + + + +
+Field Summary
+static intXMLSCHEMA_ERROR + +
+          The underlying XMLSchema parser found an error in the schema.
+  + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ intgetCode() + +
+          Returns a code that represents the type of the exception.
+ java.lang.ExceptiongetException() + +
+          Returns an Exception object.
+ org.xml.sax.LocatorgetLocator() + +
+          Returns the locator that is associated with this compilation error.
+ java.lang.StringgetMessage() + +
+          Returns a message that describes the exception.
+  + + + + + + + +
Methods inherited from class java.lang.Throwable
fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
+  +

+ + + + + + + + +
+Field Detail
+ +

+XMLSCHEMA_ERROR

+
+public static final int XMLSCHEMA_ERROR
+
+
The underlying XMLSchema parser found an error in the schema. +

+

+
See Also:
Constant Field Values
+
+ + + + + + + + +
+Method Detail
+ +

+getCode

+
+public int getCode()
+
+
Returns a code that represents the type of the exception. +

+

+ +
Returns:
error code
+
+
+
+ +

+getMessage

+
+public java.lang.String getMessage()
+
+
Returns a message that describes the exception. +

+

+
Overrides:
getMessage in class java.lang.Throwable
+
+
+ +
Returns:
error message
+
+
+
+ +

+getException

+
+public java.lang.Exception getException()
+
+
Returns an Exception object. +

+

+ +
Returns:
an Exception instance for the current exception.
+
+
+
+ +

+getLocator

+
+public org.xml.sax.Locator getLocator()
+
+
Returns the locator that is associated with this compilation error. +

+

+ +
Returns:
a Locator if available, otherwise null
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Overview  Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + diff --git a/third-party/org.openexi/nagasena/src/main/resources/doc/org/openexi/scomp/EXISchemaReader.html b/third-party/org.openexi/nagasena/src/main/resources/doc/org/openexi/scomp/EXISchemaReader.html new file mode 100644 index 0000000000..6249b50feb --- /dev/null +++ b/third-party/org.openexi/nagasena/src/main/resources/doc/org/openexi/scomp/EXISchemaReader.html @@ -0,0 +1,264 @@ + + + + + + + +EXISchemaReader + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Overview  Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +org.openexi.scomp +
+Class EXISchemaReader

+
+java.lang.Object
+  extended by EXISchemaStruct
+      extended by org.openexi.scomp.EXISchemaReader
+
+
+
+
public final class EXISchemaReader
extends EXISchemaStruct
+ + +

+EXISchemaReader parses EXI-encoded EXI Grammar into an EXISchema. +

+ +

+

+ +
+
+ +

+ + + + + + + + + + + +
+Constructor Summary
EXISchemaReader() + +
+           
+  + + + + + + + + + + + +
+Method Summary
+ EXISchemaparse(java.io.InputStream inputStream) + +
+          Parses EXI-encoded EXI Grammar into an EXISchema.
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+EXISchemaReader

+
+public EXISchemaReader()
+
+
+ + + + + + + + +
+Method Detail
+ +

+parse

+
+public EXISchema parse(java.io.InputStream inputStream)
+                throws java.io.IOException,
+                       org.openexi.proc.common.EXIOptionsException
+
+
Parses EXI-encoded EXI Grammar into an EXISchema. +

+

+
Parameters:
inputStream - EXI-encoded EXI Grammar +
Returns:
EXISchema +
Throws: +
java.io.IOException +
org.openexi.proc.common.EXIOptionsException
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Overview  Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + diff --git a/third-party/org.openexi/nagasena/src/main/resources/doc/org/openexi/scomp/EntityResolverEx.html b/third-party/org.openexi/nagasena/src/main/resources/doc/org/openexi/scomp/EntityResolverEx.html new file mode 100644 index 0000000000..cd12bdddb1 --- /dev/null +++ b/third-party/org.openexi/nagasena/src/main/resources/doc/org/openexi/scomp/EntityResolverEx.html @@ -0,0 +1,241 @@ + + + + + + + +EntityResolverEx + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Overview  Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +org.openexi.scomp +
+Interface EntityResolverEx

+
+
All Superinterfaces:
org.xml.sax.EntityResolver
+
+
+
+
public interface EntityResolverEx
extends org.xml.sax.EntityResolver
+ + +

+Extended SAX EntityResolver interface for resolving entities and + schema documents. +

+ +

+

+ +
+
+ +

+ + + + + + + + + + + + +
+Method Summary
+ org.xml.sax.InputSourceresolveEntity(java.lang.String publicId, + java.lang.String systemId, + java.lang.String namespaceURI) + +
+          This method will be called for resolving schema documents upon + occurrences of XML Schema directives such as "include", "import" and + "redefine" within schemas.
+  + + + + + + + +
Methods inherited from interface org.xml.sax.EntityResolver
resolveEntity
+  +

+ + + + + + + + +
+Method Detail
+ +

+resolveEntity

+
+org.xml.sax.InputSource resolveEntity(java.lang.String publicId,
+                                      java.lang.String systemId,
+                                      java.lang.String namespaceURI)
+                                      throws org.xml.sax.SAXException,
+                                             java.io.IOException
+
+
This method will be called for resolving schema documents upon + occurrences of XML Schema directives such as "include", "import" and + "redefine" within schemas. +

+

+
+
+
+
Parameters:
publicId - Public identifier of the schema document that is being resolved
systemId - System identifier of the schema document that is being resolved
namespaceURI - Target namespace name of the schema document that is being resolved +
Returns:
InputSource that represents the schema document if resolved otherwise null +
Throws: +
org.xml.sax.SAXException +
java.io.IOException
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Overview  Package   Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + + diff --git a/third-party/org.openexi/nagasena/src/main/resources/doc/org/openexi/scomp/package-frame.html b/third-party/org.openexi/nagasena/src/main/resources/doc/org/openexi/scomp/package-frame.html new file mode 100644 index 0000000000..65600a98d7 --- /dev/null +++ b/third-party/org.openexi/nagasena/src/main/resources/doc/org/openexi/scomp/package-frame.html @@ -0,0 +1,59 @@ + + + + + + + +org.openexi.scomp + + + + + + + + + + + +org.openexi.scomp + + + + +
+Interfaces  + +
+EntityResolverEx +
+EXISchemaFactoryErrorHandler
+ + + + + + +
+Classes  + +
+EXISchemaFactory +
+EXISchemaReader
+ + + + + + +
+Exceptions  + +
+EXISchemaFactoryException
+ + + + diff --git a/third-party/org.openexi/nagasena/src/main/resources/doc/org/openexi/scomp/package-summary.html b/third-party/org.openexi/nagasena/src/main/resources/doc/org/openexi/scomp/package-summary.html new file mode 100644 index 0000000000..a35b92a223 --- /dev/null +++ b/third-party/org.openexi/nagasena/src/main/resources/doc/org/openexi/scomp/package-summary.html @@ -0,0 +1,222 @@ + + + + + + + +org.openexi.scomp + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Overview   Package  Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+

+Package org.openexi.scomp +

+ + + +The scomp (schema compiler) package contains the EXISchemaFactory, which is used to compile XML Schema Documents (XSDs) to EXISchemas. +

+See: +
+          Description +

+ + + + + + + + + + + + + +
+Interface Summary
EntityResolverExExtended SAX EntityResolver interface for resolving entities and + schema documents.
EXISchemaFactoryErrorHandlerThis interface reports exceptions from EXISchemaFactory during schema + processing.
+  + +

+ + + + + + + + + + + + + +
+Class Summary
EXISchemaFactoryEXISchemaFactory compiles XML Schema into an EXISchema instance.
EXISchemaReaderEXISchemaReader parses EXI-encoded EXI Grammar into an EXISchema.
+  + +

+ + + + + + + + + +
+Exception Summary
EXISchemaFactoryExceptionAny errors encountered during schema compilation are communicated to + an application as EXISchemaFactoryException objects.
+  + +

+

+Package org.openexi.scomp Description +

+ +

+ + + + + +
+

The scomp (schema compiler) package contains the EXISchemaFactory, which is used to compile XML Schema Documents (XSDs) to EXISchemas. Developers can implement the interface EXISchemaFactoryErrorHandler to capture and report runtime exceptions from EXISchemaFactory. +

+		 + +
+

+

+ +

+

+ +
+
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Overview   Package  Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+ + + diff --git a/third-party/org.openexi/nagasena/src/main/resources/doc/org/openexi/scomp/package-tree.html b/third-party/org.openexi/nagasena/src/main/resources/doc/org/openexi/scomp/package-tree.html new file mode 100644 index 0000000000..93d1752d5a --- /dev/null +++ b/third-party/org.openexi/nagasena/src/main/resources/doc/org/openexi/scomp/package-tree.html @@ -0,0 +1,162 @@ + + + + + + + +org.openexi.scomp Class Hierarchy + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Overview  Package  Class   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Hierarchy For Package org.openexi.scomp +

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

+ +

+Interface Hierarchy +

+ +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Overview  Package  Class   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+ + + diff --git a/third-party/org.openexi/nagasena/src/main/resources/doc/overview-frame.html b/third-party/org.openexi/nagasena/src/main/resources/doc/overview-frame.html new file mode 100644 index 0000000000..045191d7df --- /dev/null +++ b/third-party/org.openexi/nagasena/src/main/resources/doc/overview-frame.html @@ -0,0 +1,55 @@ + + + + + + + +Overview + + + + + + + + + + + + + + + +
+
+ + + + + +
All Classes +

+ +Packages +
+org.openexi.proc +
+org.openexi.proc.common +
+org.openexi.proc.grammars +
+org.openexi.proc.io +
+org.openexi.sax +
+org.openexi.schema +
+org.openexi.scomp +
+

+ +

+  + + diff --git a/third-party/org.openexi/nagasena/src/main/resources/doc/overview-summary.html b/third-party/org.openexi/nagasena/src/main/resources/doc/overview-summary.html new file mode 100644 index 0000000000..1a299fd622 --- /dev/null +++ b/third-party/org.openexi/nagasena/src/main/resources/doc/overview-summary.html @@ -0,0 +1,227 @@ + + + + + + + +Overview + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
 Overview  Package  Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +

+
+

+OpenEXI Nagasena +

+
+ + + +OpenEXI is a W3C open source API for converting XML files to the Efficient XML Interchange format (EXI). +

+See: +
+          Description +

+ + + + + + + + + +The Proc (Processor) package contains the EXIDecoder, which is used to convert EXI streams to XML format. + + + + + +The common package contains classes, interfaces, and enumerators that define the vocabulary used to describe EXI streams (events, options, alignment, and character string values). + + + + + +The grammars package contains the GrammarCache, which combines an XML Schema Definition with EXI grammar options to create an EXI Schema. + + + + + +The IO package contains the Scanner, which is used by EXIDecoder to read and interpret EXI streams. + + + + + +The SAX package contains the Transmogrifier, which encodes an XML file to an EXI stream, and the EXIReader, which restores an EXI stream to its logical XML equivalent. + + + + + +The schema package contains classes that are used to represent XML Schema Documents (XSDs). + + + + + +The scomp (schema compiler) package contains the EXISchemaFactory, which is used to compile XML Schema Documents (XSDs) to EXISchemas. + +
+Packages
org.openexi.proc +
org.openexi.proc.common +
org.openexi.proc.grammars +
org.openexi.proc.io +
org.openexi.sax +
org.openexi.schema +
org.openexi.scomp +
+ +

+  +

+ + + + + +
+

OpenEXI is a W3C open source API for converting XML files to the Efficient XML Interchange format (EXI). +

+

You can learn more about OpenEXI by visiting the OpenEXI homepage at openexi.sourceforge.net. +

 + +
+

+

+ +

+

+ +
+
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
 Overview  Package  Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+ + + diff --git a/third-party/org.openexi/nagasena/src/main/resources/doc/overview-tree.html b/third-party/org.openexi/nagasena/src/main/resources/doc/overview-tree.html new file mode 100644 index 0000000000..8409fdb317 --- /dev/null +++ b/third-party/org.openexi/nagasena/src/main/resources/doc/overview-tree.html @@ -0,0 +1,190 @@ + + + + + + + +Class Hierarchy + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Overview  Package  Class   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Hierarchy For All Packages

+
+
+
Package Hierarchies:
org.openexi.proc, org.openexi.proc.common, org.openexi.proc.grammars, org.openexi.proc.io, org.openexi.sax, org.openexi.schema, org.openexi.scomp
+
+

+Class Hierarchy +

+ +

+Interface Hierarchy +

+ +

+Enum Hierarchy +

+
    +
  • java.lang.Object +
+
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Overview  Package  Class   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+ + + diff --git a/third-party/org.openexi/nagasena/src/main/resources/doc/package-list b/third-party/org.openexi/nagasena/src/main/resources/doc/package-list new file mode 100644 index 0000000000..746aadc8bd --- /dev/null +++ b/third-party/org.openexi/nagasena/src/main/resources/doc/package-list @@ -0,0 +1,7 @@ +org.openexi.proc +org.openexi.proc.common +org.openexi.proc.grammars +org.openexi.proc.io +org.openexi.sax +org.openexi.schema +org.openexi.scomp diff --git a/third-party/org.openexi/nagasena/src/main/resources/doc/resources/inherit.gif b/third-party/org.openexi/nagasena/src/main/resources/doc/resources/inherit.gif new file mode 100644 index 0000000000..c814867a13 Binary files /dev/null and b/third-party/org.openexi/nagasena/src/main/resources/doc/resources/inherit.gif differ diff --git a/third-party/org.openexi/nagasena/src/main/resources/doc/serialized-form.html b/third-party/org.openexi/nagasena/src/main/resources/doc/serialized-form.html new file mode 100644 index 0000000000..c3688f526d --- /dev/null +++ b/third-party/org.openexi/nagasena/src/main/resources/doc/serialized-form.html @@ -0,0 +1,269 @@ + + + + + + + +Serialized Form + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Overview  Package  Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Serialized Form

+
+
+ + + + + +
+Package org.openexi.sax
+ +

+ + + + + +
+Class org.openexi.sax.TransmogrifierException extends java.lang.Exception implements Serializable
+ +

+serialVersionUID: -4536662596727577640L + +

+ + + + + +
+Serialized Fields
+ +

+m_code

+
+int m_code
+
+
+
+
+
+

+m_message

+
+java.lang.String m_message
+
+
+
+
+
+

+m_exception

+
+java.lang.Exception m_exception
+
+
+
+
+
+

+m_locator

+
+org.xml.sax.Locator m_locator
+
+
+
+
+
+ + + + + +
+Package org.openexi.scomp
+ +

+ + + + + +
+Class org.openexi.scomp.EXISchemaFactoryException extends java.lang.Exception implements Serializable
+ +

+serialVersionUID: 3816521974819647026L + +

+ + + + + +
+Serialized Fields
+ +

+m_code

+
+int m_code
+
+
+
+
+
+

+m_message

+
+java.lang.String m_message
+
+
+
+
+
+

+m_exception

+
+java.lang.Exception m_exception
+
+
+
+
+
+

+m_locator

+
+org.xml.sax.Locator m_locator
+
+
+
+
+ +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
Overview  Package  Class  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+ + + diff --git a/third-party/org.openexi/nagasena/src/main/resources/doc/stylesheet.css b/third-party/org.openexi/nagasena/src/main/resources/doc/stylesheet.css new file mode 100644 index 0000000000..14c3737e8a --- /dev/null +++ b/third-party/org.openexi/nagasena/src/main/resources/doc/stylesheet.css @@ -0,0 +1,29 @@ +/* Javadoc style sheet */ + +/* Define colors, fonts and other style attributes here to override the defaults */ + +/* Page background color */ +body { background-color: #FFFFFF } + +/* Headings */ +h1 { font-size: 145% } + +/* Table colors */ +.TableHeadingColor { background: #CCCCFF } /* Dark mauve */ +.TableSubHeadingColor { background: #EEEEFF } /* Light mauve */ +.TableRowColor { background: #FFFFFF } /* White */ + +/* Font used in left-hand frame lists */ +.FrameTitleFont { font-size: 100%; font-family: Helvetica, Arial, sans-serif } +.FrameHeadingFont { font-size: 90%; font-family: Helvetica, Arial, sans-serif } +.FrameItemFont { font-size: 90%; font-family: Helvetica, Arial, sans-serif } + +/* Navigation bar fonts and colors */ +.NavBarCell1 { background-color:#EEEEFF;} /* Light mauve */ +.NavBarCell1Rev { background-color:#00008B;} /* Dark Blue */ +.NavBarFont1 { font-family: Arial, Helvetica, sans-serif; color:#000000;} +.NavBarFont1Rev { font-family: Arial, Helvetica, sans-serif; color:#FFFFFF;} + +.NavBarCell2 { font-family: Arial, Helvetica, sans-serif; background-color:#FFFFFF;} +.NavBarCell3 { font-family: Arial, Helvetica, sans-serif; background-color:#FFFFFF;} + diff --git a/third-party/org.openexi/pom.xml b/third-party/org.openexi/pom.xml new file mode 100644 index 0000000000..e7a1c303b4 --- /dev/null +++ b/third-party/org.openexi/pom.xml @@ -0,0 +1,50 @@ + + + + + 4.0.0 + + + org.opendaylight.controller + commons.thirdparty + 1.1.2-SNAPSHOT + ../commons/thirdparty + + + org.opendaylight.controller.thirdparty + org.openexi + 0000.0002.0035.0 + pom + + 3.0.4 + + + + nagasena + nagasena-rta + + + + + + + org.codehaus.mojo + truezip-maven-plugin + 1.1 + + + org.apache.felix + maven-bundle-plugin + 2.4.0 + + + + + +