X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?p=controller.git;a=blobdiff_plain;f=third-party%2Forg.openexi%2Fnagasena%2Fsrc%2Fmain%2Fresources%2Fdoc%2Forg%2Fopenexi%2Fproc%2Fcommon%2FEXIOptions.html;fp=third-party%2Forg.openexi%2Fnagasena%2Fsrc%2Fmain%2Fresources%2Fdoc%2Forg%2Fopenexi%2Fproc%2Fcommon%2FEXIOptions.html;h=27d78e0a9938074782b800834a5db471e52b879d;hp=0000000000000000000000000000000000000000;hb=1e81fa45ab0ced56eef0518c7e7f87857724985b;hpb=259b65622b8c29c49235c2210609b9f7a68826eb 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 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + +
+ +

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