DefaultEXIFactory (EXIficient-Core 1.0.4 API)

java.lang.Object
- com.siemens.ct.exi.core.helpers.DefaultEXIFactory

All Implemented Interfaces:

EXIFactory, Cloneable
```
public class DefaultEXIFactory
extends Object
implements EXIFactory
```
This is the default implementation of an EXIFactory class.

Author:

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

See Also:

EXIFactory

Field Summary

Fields
Modifier and Type	Field and Description
`protected int`	`blockSize`
`protected CodingMode`	`codingMode`
`protected DecodingOptions`	`decodingOptions`
`protected QName[]`	`dtrMapRepresentations`
`protected Map<QName,Datatype>`	`dtrMapRepresentationsDatatype`
`protected QName[]`	`dtrMapTypes`
`protected EncodingOptions`	`encodingOptions`
`protected FidelityOptions`	`fidelityOptions`
`protected Grammars`	`grammar`
`protected boolean`	`grammarLearningDisabled`
`protected boolean`	`isFragment`
`protected boolean`	`isUsingNonEvolvingGrammrs`
`protected boolean`	`localValuePartitions`
`protected int`	`maximumNumberOfBuiltInElementGrammars`
`protected int`	`maximumNumberOfBuiltInProductions`
`protected static QNameSort`	`qnameSort`
`protected QName[]`	`scElements`
`protected SelfContainedHandler`	`scHandler`
`protected SchemaIdResolver`	`schemaIdResolver`
`protected List<String>`	`sharedStrings`
`protected int`	`valueMaxLength`
`protected int`	`valuePartitionCapacity`

Constructor Summary

Constructors
Modifier Constructor and Description

protected DefaultEXIFactory()

Constructors
Modifier	Constructor and Description
`protected`	`DefaultEXIFactory()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`bubbleSort(QName[] dtrMapTypes, QName[] dtrMapRepresentations)`
`EXIFactory`	`clone()` Returns a shallow copy of this EXI factory.
`EXIBodyDecoder`	`createEXIBodyDecoder()` Returns an `EXIBodyDecoder`
`EXIBodyEncoder`	`createEXIBodyEncoder()` Returns an `EXIBodyEncoder`
`EXIStreamDecoder`	`createEXIStreamDecoder()` Returns an `EXIStreamDecoder`
`EXIStreamEncoder`	`createEXIStreamEncoder()` Returns an `EXIStreamEncoder`
`StringDecoder`	`createStringDecoder()` Returns an EXI `StringDecoder` according coding options
`StringEncoder`	`createStringEncoder()` Returns an EXI `StringEncoder` according coding options
`TypeDecoder`	`createTypeDecoder()` Returns an EXI `TypeDecoder` according coding options such as schema-informed or schema-less grammar and options like Preserve.LexicalValues
`TypeEncoder`	`createTypeEncoder()` Returns an EXI `TypeEncoder` according coding options such as schema-informed or schema-less grammar and options like Preserve.LexicalValues
`protected void`	`doSanityCheck()`
`boolean`	`equals(Object o)`
`int`	`getBlockSize()` The blockSize option specifies the block size used for EXI compression.
`CodingMode`	`getCodingMode()` Returns the currently used `CodingMode`.
`QName[]`	`getDatatypeRepresentationMapRepresentations()` EXI processors MAY provide the capability to specify different built-in EXI datatype representations or user-defined datatype representations for representing specific schema datatypes.
`QName[]`	`getDatatypeRepresentationMapTypes()` EXI processors MAY provide the capability to specify different built-in EXI datatype representations or user-defined datatype representations for representing specific schema datatypes.
`DecodingOptions`	`getDecodingOptions()` Returns the options used by the EXI decoder.
`EncodingOptions`	`getEncodingOptions()` Returns the header options used by the EXI encoder.
`FidelityOptions`	`getFidelityOptions()` Returns the fidelity options used by the EXI factory (e.g. preserving XML comments or DTDs).
`Grammars`	`getGrammars()` Returns the currently used EXI `Grammars`.
`int`	`getMaximumNumberOfBuiltInElementGrammars()` The EXI profile defines a parameter that restricts the maximum number of elements for which evolving built-in element grammars can be instantiated.
`int`	`getMaximumNumberOfBuiltInProductions()` The EXI profile defines a parameter that restricts the maximum number of top-level productions that can be dynamically inserted in built-in element grammars.
`SchemaIdResolver`	`getSchemaIdResolver()` Returns schemaId resolver for this factory;
`SelfContainedHandler`	`getSelfContainedHandler()` Returns selfContained element handler.
`List<String>`	`getSharedStrings()` (Experimental) Return list of shared strings.
`int`	`getValueMaxLength()` The default value "unbounded" is assumed when the "valueMaxLength" element is absent.
`int`	`getValuePartitionCapacity()` The default value "unbounded" is assumed when the "valuePartitionCapacity" element is absent
`int`	`hashCode()`
`boolean`	`isFragment()` Returns whether we deal with a fragment
`boolean`	`isGrammarLearningDisabled()` The EXI profile defines parameters that restrict grammar learning.
`boolean`	`isLocalValuePartitions()` The localValuePartitions option of the EXI profile is a Boolean used to indicate whether local value partitions are used. ] The value "0" indicates that no local value partition is used while "1" represents the behavior of the EXI 1.0 specification
`protected boolean`	`isSchemaInformed()`
`boolean`	`isSelfContainedElement(QName element)` Returns boolean value telling whether a certain element is encoded as selfContained fragment.
`boolean`	`isUsingNonEvolvingGrammars()` (Experimental) Returns whether non-evolving grammars are used
`static EXIFactory`	`newInstance()`
`Datatype`	`registerDatatypeRepresentationMapDatatype(QName dtrMapRepresentation, Datatype datatype)` The DTR map representation may use built-in String datatypes (e.g., `exi:string`) or use user-defined type representations.
`void`	`setBlockSize(int blockSize)` The default blockSize is intentionally large (1,000,000) but can be reduced for processing large documents on devices with limited memory.
`void`	`setCodingMode(CodingMode codingMode)` Re-sets the coding mode used by the factory.
`void`	`setDatatypeRepresentationMap(QName[] dtrMapTypes, QName[] dtrMapRepresentations)` By default, each typed value in an EXI stream is represented by the associated built-in EXI datatype representation.
`void`	`setDecodingOptions(DecodingOptions decodingOptions)` Sets the options used by the EXI Decoder(e.g., ignore schemaId).
`protected static void`	`setDefaultValues(EXIFactory factory)`
`void`	`setEncodingOptions(EncodingOptions encodingOptions)` Sets the header options used by the EXI Encoder(e.g., include EXI Cookie, EXI Options document).
`void`	`setFidelityOptions(FidelityOptions fidelityOptions)` Sets the fidelity options used by the EXI factory (e.g. preserving XML comments or DTDs).
`void`	`setFragment(boolean isFragment)` Informs the factory that we are dealing with an XML fragment instead of an XML document
`void`	`setGrammars(Grammars grammar)` Sets the EXI `Grammars` used for coding.
`void`	`setLocalValuePartitions(boolean useLocalValuePartitions)` The EXI profile defines a parameter that can disable the use of local value references.
`void`	`setMaximumNumberOfBuiltInElementGrammars(int maximumNumberOfBuiltInElementGrammars)` The EXI profile defines a parameter that restricts the maximum number of elements for which evolving built-in element grammars can be instantiated.
`void`	`setMaximumNumberOfBuiltInProductions(int maximumNumberOfBuiltInProductions)` The EXI profile defines a parameter that restricts the maximum number of top-level productions that can be dynamically inserted in built-in element grammars.
`void`	`setSchemaIdResolver(SchemaIdResolver schemaIdResolver)` Sets specific schemaId resolver.
`void`	`setSelfContainedElements(QName[] scElements)` Self-contained elements may be read independently from the rest of the EXI body, allowing them to be indexed for random access.
`void`	`setSelfContainedElements(QName[] scElements, SelfContainedHandler scHandler)` Self-contained elements may be read independently from the rest of the EXI body, allowing them to be indexed for random access.
`void`	`setSharedStrings(List<String> sharedStrings)` (Experimental) Feature to pre-agree on shared strings.
`void`	`setUsingNonEvolvingGrammars(boolean isNonEvolving)` (Experimental) Feature which dictates that grammar does not grow in any circumstance
`void`	`setValueMaxLength(int valueMaxLength)` The valueMaxLength option specifies the maximum length of value content items to be considered for addition to the string table.
`void`	`setValuePartitionCapacity(int valuePartitionCapacity)` The valuePartitionCapacity option specifies the maximum number of value content items in the string table at any given time.
`String`	`toString()`
`protected void`	`updateFactoryAccordingCanonicalEXI()`

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - grammar
```
protected Grammars grammar
```
  - isFragment
```
protected boolean isFragment
```
  - codingMode
```
protected CodingMode codingMode
```
  - fidelityOptions
```
protected FidelityOptions fidelityOptions
```
  - encodingOptions
```
protected EncodingOptions encodingOptions
```
  - decodingOptions
```
protected DecodingOptions decodingOptions
```
  - schemaIdResolver
```
protected SchemaIdResolver schemaIdResolver
```
  - dtrMapTypes
```
protected QName[] dtrMapTypes
```
  - dtrMapRepresentations
```
protected QName[] dtrMapRepresentations
```
  - dtrMapRepresentationsDatatype
```
protected Map<QName,Datatype> dtrMapRepresentationsDatatype
```
  - scElements
```
protected QName[] scElements
```
  - scHandler
```
protected SelfContainedHandler scHandler
```
  - blockSize
```
protected int blockSize
```
  - valueMaxLength
```
protected int valueMaxLength
```
  - valuePartitionCapacity
```
protected int valuePartitionCapacity
```
  - localValuePartitions
```
protected boolean localValuePartitions
```
  - maximumNumberOfBuiltInElementGrammars
```
protected int maximumNumberOfBuiltInElementGrammars
```
  - maximumNumberOfBuiltInProductions
```
protected int maximumNumberOfBuiltInProductions
```
  - grammarLearningDisabled
```
protected boolean grammarLearningDisabled
```
  - sharedStrings
```
protected List<String> sharedStrings
```
  - isUsingNonEvolvingGrammrs
```
protected boolean isUsingNonEvolvingGrammrs
```
  - qnameSort
```
protected static final QNameSort qnameSort
```
- Constructor Detail
  - DefaultEXIFactory
```
protected DefaultEXIFactory()
```
- Method Detail
  - setDefaultValues
```
protected static void setDefaultValues(EXIFactory factory)
```
  - newInstance
```
public static EXIFactory newInstance()
```
  - setFidelityOptions
```
public void setFidelityOptions(FidelityOptions fidelityOptions)
```
    Description copied from interface: EXIFactory
    
    Sets the fidelity options used by the EXI factory (e.g. preserving XML comments or DTDs).
    
    Specified by:
    
    setFidelityOptions in interface EXIFactory
    
    Parameters:
    
    fidelityOptions - new fidelity options
    
    See Also:
    
    FidelityOptions
  - getFidelityOptions
```
public FidelityOptions getFidelityOptions()
```
    Description copied from interface: EXIFactory
    
    Returns the fidelity options used by the EXI factory (e.g. preserving XML comments or DTDs).
    
    Specified by:
    
    getFidelityOptions in interface EXIFactory
    
    Returns:
    
    fidelity options currently used by the factory
    
    See Also:
    
    FidelityOptions
  - setEncodingOptions
```
public void setEncodingOptions(EncodingOptions encodingOptions)
```
    Description copied from interface: EXIFactory
    
    Sets the header options used by the EXI Encoder(e.g., include EXI Cookie, EXI Options document).
    
    Specified by:
    
    setEncodingOptions in interface EXIFactory
    
    Parameters:
    
    encodingOptions - header options
    
    See Also:
    
    EncodingOptions
  - getEncodingOptions
```
public EncodingOptions getEncodingOptions()
```
    Description copied from interface: EXIFactory
    
    Returns the header options used by the EXI encoder.
    
    Specified by:
    
    getEncodingOptions in interface EXIFactory
    
    Returns:
    
    header options currently used by the factory
    
    See Also:
    
    EncodingOptions
  - setDecodingOptions
```
public void setDecodingOptions(DecodingOptions decodingOptions)
```
    Description copied from interface: EXIFactory
    
    Sets the options used by the EXI Decoder(e.g., ignore schemaId).
    
    Specified by:
    
    setDecodingOptions in interface EXIFactory
    
    Parameters:
    
    decodingOptions - decoding options
    
    See Also:
    
    decoding options
  - getDecodingOptions
```
public DecodingOptions getDecodingOptions()
```
    Description copied from interface: EXIFactory
    
    Returns the options used by the EXI decoder.
    
    Specified by:
    
    getDecodingOptions in interface EXIFactory
    
    Returns:
    
    options currently used by the factory
    
    See Also:
    
    DecodingOptions
  - setSchemaIdResolver
```
public void setSchemaIdResolver(SchemaIdResolver schemaIdResolver)
```
    Description copied from interface: EXIFactory
    
    Sets specific schemaId resolver.
    
    Specified by:
    
    setSchemaIdResolver in interface EXIFactory
    
    Parameters:
    
    schemaIdResolver - schemaId resolver
    
    See Also:
    
    SchemaIdResolver
  - getSchemaIdResolver
```
public SchemaIdResolver getSchemaIdResolver()
```
    Description copied from interface: EXIFactory
    
    Returns schemaId resolver for this factory;
    
    Specified by:
    
    getSchemaIdResolver in interface EXIFactory
    
    Returns:
    
    Schema Id Resolver
  - setDatatypeRepresentationMap
```
public void setDatatypeRepresentationMap(QName[] dtrMapTypes,
                                         QName[] dtrMapRepresentations)
```
    Description copied from interface: EXIFactory
    
    By default, each typed value in an EXI stream is represented by the associated built-in EXI datatype representation. However, EXI processors MAY provide the capability to specify different built-in EXI datatype representations or user-defined datatype representations for representing specific schema datatypes. This capability is called Datatype Representation Map.
    
    Specified by:
    
    setDatatypeRepresentationMap in interface EXIFactory
    
    Parameters:
    
    dtrMapTypes - dtrMap types
    
    dtrMapRepresentations - dtrMap representations
  - registerDatatypeRepresentationMapDatatype
```
public Datatype registerDatatypeRepresentationMapDatatype(QName dtrMapRepresentation,
                                                          Datatype datatype)
```
    Description copied from interface: EXIFactory
    
    The DTR map representation may use built-in String datatypes (e.g., exi:string) or use user-defined type representations. This method allows to register the datatype that should be used.
    
    Specified by:
    
    registerDatatypeRepresentationMapDatatype in interface EXIFactory
    
    Parameters:
    
    dtrMapRepresentation - dtrMap type
    
    datatype - dtrMap datatype
    
    Returns:
    
    the previous value associated with dtrMapRepresentation, or null if there was no mapping
  - getDatatypeRepresentationMapTypes
```
public QName[] getDatatypeRepresentationMapTypes()
```
    Description copied from interface: EXIFactory
    
    EXI processors MAY provide the capability to specify different built-in EXI datatype representations or user-defined datatype representations for representing specific schema datatypes.
    
    Specified by:
    
    getDatatypeRepresentationMapTypes in interface EXIFactory
    
    Returns:
    
    qualified name array for dtr types OR null
  - getDatatypeRepresentationMapRepresentations
```
public QName[] getDatatypeRepresentationMapRepresentations()
```
    Description copied from interface: EXIFactory
    
    EXI processors MAY provide the capability to specify different built-in EXI datatype representations or user-defined datatype representations for representing specific schema datatypes.
    
    Specified by:
    
    getDatatypeRepresentationMapRepresentations in interface EXIFactory
    
    Returns:
    
    qualified name array for dtr representations OR null
  - setSelfContainedElements
```
public void setSelfContainedElements(QName[] scElements)
```
    Description copied from interface: EXIFactory
    
    Self-contained elements may be read independently from the rest of the EXI body, allowing them to be indexed for random access. The "selfContained" element MUST NOT appear in an EXI options document when one of "compression", "pre-compression" or "strict" elements are present in the same options document.
    
    Specified by:
    
    setSelfContainedElements in interface EXIFactory
    
    Parameters:
    
    scElements - selfContained elements
  - setSelfContainedElements
```
public void setSelfContainedElements(QName[] scElements,
                                     SelfContainedHandler scHandler)
```
    Description copied from interface: EXIFactory
    
    Self-contained elements may be read independently from the rest of the EXI body, allowing them to be indexed for random access. The "selfContained" element MUST NOT appear in an EXI options document when one of "compression", "pre-compression" or "strict" elements are present in the same options document.
    
    Specified by:
    
    setSelfContainedElements in interface EXIFactory
    
    Parameters:
    
    scElements - selfContained elements
    
    scHandler - handler for SC elements
  - isSelfContainedElement
```
public boolean isSelfContainedElement(QName element)
```
    Description copied from interface: EXIFactory
    
    Returns boolean value telling whether a certain element is encoded as selfContained fragment.
    
    Specified by:
    
    isSelfContainedElement in interface EXIFactory
    
    Parameters:
    
    element - qualified element name
    
    Returns:
    
    true if a certain element is selfContained
  - getSelfContainedHandler
```
public SelfContainedHandler getSelfContainedHandler()
```
    Description copied from interface: EXIFactory
    
    Returns selfContained element handler.
    
    Specified by:
    
    getSelfContainedHandler in interface EXIFactory
    
    Returns:
    
    selfContained element handler or null
  - setGrammars
```
public void setGrammars(Grammars grammar)
```
    Description copied from interface: EXIFactory
    
    Sets the EXI Grammars used for coding.
    
    Specified by:
    
    setGrammars in interface EXIFactory
    
    Parameters:
    
    grammar - grammar
  - getGrammars
```
public Grammars getGrammars()
```
    Description copied from interface: EXIFactory
    
    Returns the currently used EXI Grammars. By default a SchemaLessGrammars is used.
    
    Specified by:
    
    getGrammars in interface EXIFactory
    
    Returns:
    
    grammar used by the factory
  - isSchemaInformed
```
protected boolean isSchemaInformed()
```
  - setFragment
```
public void setFragment(boolean isFragment)
```
    Description copied from interface: EXIFactory
    
    Informs the factory that we are dealing with an XML fragment instead of an XML document
    
    Specified by:
    
    setFragment in interface EXIFactory
    
    Parameters:
    
    isFragment - true if is fragment
  - isFragment
```
public boolean isFragment()
```
    Description copied from interface: EXIFactory
    
    Returns whether we deal with a fragment
    
    Specified by:
    
    isFragment in interface EXIFactory
    
    Returns:
    
    is fragment
  - setCodingMode
```
public void setCodingMode(CodingMode codingMode)
```
    Description copied from interface: EXIFactory
    
    Re-sets the coding mode used by the factory.
    
    Specified by:
    
    setCodingMode in interface EXIFactory
    
    Parameters:
    
    codingMode - coding mode
  - getCodingMode
```
public CodingMode getCodingMode()
```
    Description copied from interface: EXIFactory
    
    Returns the currently used CodingMode. By default BIT_PACKED is used.
    
    Specified by:
    
    getCodingMode in interface EXIFactory
    
    Returns:
    
    coding-mode used by the factory
  - setBlockSize
```
public void setBlockSize(int blockSize)
```
    Description copied from interface: EXIFactory
    
    The default blockSize is intentionally large (1,000,000) but can be reduced for processing large documents on devices with limited memory.
    
    Specified by:
    
    setBlockSize in interface EXIFactory
    
    Parameters:
    
    blockSize - blockSize
  - getBlockSize
```
public int getBlockSize()
```
    Description copied from interface: EXIFactory
    
    The blockSize option specifies the block size used for EXI compression. When the "blockSize" element is absent in the EXI Options document, the default blocksize of 1,000,000 is used.
    
    Specified by:
    
    getBlockSize in interface EXIFactory
    
    Returns:
    
    blockSize
  - setValueMaxLength
```
public void setValueMaxLength(int valueMaxLength)
```
    Description copied from interface: EXIFactory
    
    The valueMaxLength option specifies the maximum length of value content items to be considered for addition to the string table. The default value "unbounded" is assumed when the "valueMaxLength" element is absent in the EXI Options document.
    See http://www.w3.org/TR/exi/#key-valueMaxLengthOption
    
    Specified by:
    
    setValueMaxLength in interface EXIFactory
    
    Parameters:
    
    valueMaxLength - the maximum string length of value content items to be considered for addition to the string table
  - getValueMaxLength
```
public int getValueMaxLength()
```
    Description copied from interface: EXIFactory
    
    The default value "unbounded" is assumed when the "valueMaxLength" element is absent.
    
    Specified by:
    
    getValueMaxLength in interface EXIFactory
    
    Returns:
    
    value OR negative for unbounded
  - setValuePartitionCapacity
```
public void setValuePartitionCapacity(int valuePartitionCapacity)
```
    Description copied from interface: EXIFactory
    
    The valuePartitionCapacity option specifies the maximum number of value content items in the string table at any given time. The default value "unbounded" is assumed when the "valuePartitionCapacity" element is absent.
    See http://www.w3.org/TR/exi/#key-valuePartitionCapacityOption
    
    Specified by:
    
    setValuePartitionCapacity in interface EXIFactory
    
    Parameters:
    
    valuePartitionCapacity - the total capacity of value partitions in a string table
  - getValuePartitionCapacity
```
public int getValuePartitionCapacity()
```
    Description copied from interface: EXIFactory
    
    The default value "unbounded" is assumed when the "valuePartitionCapacity" element is absent
    
    Specified by:
    
    getValuePartitionCapacity in interface EXIFactory
    
    Returns:
    
    value OR negative for unbounded
  - setLocalValuePartitions
```
public void setLocalValuePartitions(boolean useLocalValuePartitions)
```
    Description copied from interface: EXIFactory
    
    The EXI profile defines a parameter that can disable the use of local value references. Global value indexing may be controlled using the options defined in the EXI 1.0 specification
    The localValuePartitions option of the EXI profile is a Boolean used to indicate whether local value partitions are used. ] The value "0" indicates that no local value partition is used while "1" represents the behavior of the EXI 1.0 specification
    
    Specified by:
    
    setLocalValuePartitions in interface EXIFactory
    
    Parameters:
    
    useLocalValuePartitions - whether to use localValue partitions
  - isLocalValuePartitions
```
public boolean isLocalValuePartitions()
```
    Description copied from interface: EXIFactory
    
    The localValuePartitions option of the EXI profile is a Boolean used to indicate whether local value partitions are used. ] The value "0" indicates that no local value partition is used while "1" represents the behavior of the EXI 1.0 specification
    
    Specified by:
    
    isLocalValuePartitions in interface EXIFactory
    
    Returns:
    
    whether local value partitions are used
  - setMaximumNumberOfBuiltInElementGrammars
```
public void setMaximumNumberOfBuiltInElementGrammars(int maximumNumberOfBuiltInElementGrammars)
```
    Description copied from interface: EXIFactory
    
    The EXI profile defines a parameter that restricts the maximum number of elements for which evolving built-in element grammars can be instantiated.
    The value "unbounded" (-1) indicates that no restrictions are used and represents the behavior of the EXI 1.0 specification
    
    Specified by:
    
    setMaximumNumberOfBuiltInElementGrammars in interface EXIFactory
    
    Parameters:
    
    maximumNumberOfBuiltInElementGrammars - maximum number of Built-In element grammars
  - getMaximumNumberOfBuiltInElementGrammars
```
public int getMaximumNumberOfBuiltInElementGrammars()
```
    Description copied from interface: EXIFactory
    
    The EXI profile defines a parameter that restricts the maximum number of elements for which evolving built-in element grammars can be instantiated.
    
    Specified by:
    
    getMaximumNumberOfBuiltInElementGrammars in interface EXIFactory
    
    Returns:
    
    maximum number of evolving built-in element grammars
  - setMaximumNumberOfBuiltInProductions
```
public void setMaximumNumberOfBuiltInProductions(int maximumNumberOfBuiltInProductions)
```
    Description copied from interface: EXIFactory
    
    The EXI profile defines a parameter that restricts the maximum number of top-level productions that can be dynamically inserted in built-in element grammars.
    The value "unbounded" (-1) indicates that no restrictions are used and represents the behavior of the EXI 1.0 specification
    
    Specified by:
    
    setMaximumNumberOfBuiltInProductions in interface EXIFactory
    
    Parameters:
    
    maximumNumberOfBuiltInProductions - maximum number of Built-In productions
  - getMaximumNumberOfBuiltInProductions
```
public int getMaximumNumberOfBuiltInProductions()
```
    Description copied from interface: EXIFactory
    
    The EXI profile defines a parameter that restricts the maximum number of top-level productions that can be dynamically inserted in built-in element grammars.
    
    Specified by:
    
    getMaximumNumberOfBuiltInProductions in interface EXIFactory
    
    Returns:
    
    maximum number of built-in productions
  - isGrammarLearningDisabled
```
public boolean isGrammarLearningDisabled()
```
    Description copied from interface: EXIFactory
    
    The EXI profile defines parameters that restrict grammar learning. This is a convenience method to indicate whether grammar restriction is in use.
    
    Specified by:
    
    isGrammarLearningDisabled in interface EXIFactory
    
    Returns:
    
    whether schema learning is disabled
  - setSharedStrings
```
public void setSharedStrings(List<String> sharedStrings)
```
    Description copied from interface: EXIFactory
    
    (Experimental) Feature to pre-agree on shared strings.
    
    Specified by:
    
    setSharedStrings in interface EXIFactory
    
    Parameters:
    
    sharedStrings - list of shared strings
  - getSharedStrings
```
public List<String> getSharedStrings()
```
    Description copied from interface: EXIFactory
    
    (Experimental) Return list of shared strings.
    
    Specified by:
    
    getSharedStrings in interface EXIFactory
    
    Returns:
    
    null or shared strings if any
  - setUsingNonEvolvingGrammars
```
public void setUsingNonEvolvingGrammars(boolean isNonEvolving)
```
    Description copied from interface: EXIFactory
    
    (Experimental) Feature which dictates that grammar does not grow in any circumstance
    
    Specified by:
    
    setUsingNonEvolvingGrammars in interface EXIFactory
    
    Parameters:
    
    isNonEvolving - whether instead of built-in grammars schema-informed Element Fragment Grammar is used
  - isUsingNonEvolvingGrammars
```
public boolean isUsingNonEvolvingGrammars()
```
    Description copied from interface: EXIFactory
    
    (Experimental) Returns whether non-evolving grammars are used
    
    Specified by:
    
    isUsingNonEvolvingGrammars in interface EXIFactory
    
    Returns:
    
    true or false
  - doSanityCheck
```
protected void doSanityCheck()
                      throws EXIException
```
    Throws:
    
    EXIException
  - createEXIBodyEncoder
```
public EXIBodyEncoder createEXIBodyEncoder()
                                    throws EXIException
```
    Description copied from interface: EXIFactory
    
    Returns an EXIBodyEncoder
    
    Specified by:
    
    createEXIBodyEncoder in interface EXIFactory
    
    Returns:
    
    encoder using the previously set coding options.
    
    Throws:
    
    EXIException - EXI exception
  - createEXIStreamEncoder
```
public EXIStreamEncoder createEXIStreamEncoder()
                                        throws EXIException
```
    Description copied from interface: EXIFactory
    
    Returns an EXIStreamEncoder
    
    Specified by:
    
    createEXIStreamEncoder in interface EXIFactory
    
    Returns:
    
    stream encoder using the previously set coding options.
    
    Throws:
    
    EXIException - EXI exception
  - updateFactoryAccordingCanonicalEXI
```
protected void updateFactoryAccordingCanonicalEXI()
                                           throws UnsupportedOption
```
    Throws:
    
    UnsupportedOption
  - bubbleSort
```
protected void bubbleSort(QName[] dtrMapTypes,
                          QName[] dtrMapRepresentations)
```
  - createEXIBodyDecoder
```
public EXIBodyDecoder createEXIBodyDecoder()
                                    throws EXIException
```
    Description copied from interface: EXIFactory
    
    Returns an EXIBodyDecoder
    
    Specified by:
    
    createEXIBodyDecoder in interface EXIFactory
    
    Returns:
    
    decoder using the previously set coding options.
    
    Throws:
    
    EXIException - EXI exception
  - createEXIStreamDecoder
```
public EXIStreamDecoder createEXIStreamDecoder()
                                        throws EXIException
```
    Description copied from interface: EXIFactory
    
    Returns an EXIStreamDecoder
    
    Specified by:
    
    createEXIStreamDecoder in interface EXIFactory
    
    Returns:
    
    stream decoder using the previously set coding options.
    
    Throws:
    
    EXIException - EXI exception
  - createStringEncoder
```
public StringEncoder createStringEncoder()
```
    Description copied from interface: EXIFactory
    
    Returns an EXI StringEncoder according coding options
    
    Specified by:
    
    createStringEncoder in interface EXIFactory
    
    Returns:
    
    String Encoder
  - createStringDecoder
```
public StringDecoder createStringDecoder()
```
    Description copied from interface: EXIFactory
    
    Returns an EXI StringDecoder according coding options
    
    Specified by:
    
    createStringDecoder in interface EXIFactory
    
    Returns:
    
    String Decoder
  - createTypeEncoder
```
public TypeEncoder createTypeEncoder()
                              throws EXIException
```
    Description copied from interface: EXIFactory
    
    Returns an EXI TypeEncoder according coding options such as schema-informed or schema-less grammar and options like Preserve.LexicalValues
    
    Specified by:
    
    createTypeEncoder in interface EXIFactory
    
    Returns:
    
    type encoder according given EXI options
    
    Throws:
    
    EXIException - EXI exception
    
    See Also:
    
    TypeEncoder
  - createTypeDecoder
```
public TypeDecoder createTypeDecoder()
                              throws EXIException
```
    Description copied from interface: EXIFactory
    
    Returns an EXI TypeDecoder according coding options such as schema-informed or schema-less grammar and options like Preserve.LexicalValues
    
    Specified by:
    
    createTypeDecoder in interface EXIFactory
    
    Returns:
    
    type decoder according given EXI options
    
    Throws:
    
    EXIException - EXI exception
    
    See Also:
    
    TypeDecoder
  - clone
```
public EXIFactory clone()
```
    Description copied from interface: EXIFactory
    
    Returns a shallow copy of this EXI factory.
    
    Specified by:
    
    clone in interface EXIFactory
    
    Overrides:
    
    clone in class Object
    
    Returns:
    
    EXIFactory
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class DefaultEXIFactory

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

grammar

isFragment

codingMode

fidelityOptions

encodingOptions

decodingOptions

schemaIdResolver

dtrMapTypes

dtrMapRepresentations

dtrMapRepresentationsDatatype

scElements

scHandler

blockSize

valueMaxLength

valuePartitionCapacity

localValuePartitions

maximumNumberOfBuiltInElementGrammars

maximumNumberOfBuiltInProductions

grammarLearningDisabled

sharedStrings

isUsingNonEvolvingGrammrs

qnameSort

Constructor Detail

DefaultEXIFactory

Method Detail

setDefaultValues

newInstance

setFidelityOptions

getFidelityOptions

setEncodingOptions

getEncodingOptions

setDecodingOptions

getDecodingOptions

setSchemaIdResolver

getSchemaIdResolver

setDatatypeRepresentationMap

registerDatatypeRepresentationMapDatatype

getDatatypeRepresentationMapTypes

getDatatypeRepresentationMapRepresentations

setSelfContainedElements

setSelfContainedElements

isSelfContainedElement

getSelfContainedHandler

setGrammars

getGrammars

isSchemaInformed

setFragment

isFragment

setCodingMode

getCodingMode

setBlockSize

getBlockSize

setValueMaxLength

getValueMaxLength

setValuePartitionCapacity

getValuePartitionCapacity

setLocalValuePartitions

isLocalValuePartitions

setMaximumNumberOfBuiltInElementGrammars

getMaximumNumberOfBuiltInElementGrammars

setMaximumNumberOfBuiltInProductions

getMaximumNumberOfBuiltInProductions

isGrammarLearningDisabled

setSharedStrings

getSharedStrings

setUsingNonEvolvingGrammars

isUsingNonEvolvingGrammars

doSanityCheck

createEXIBodyEncoder

createEXIStreamEncoder

updateFactoryAccordingCanonicalEXI

bubbleSort

createEXIBodyDecoder

createEXIStreamDecoder