EXIFactory (EXIficient-Core 1.0.4 API)

All Superinterfaces:

Cloneable

All Known Implementing Classes:

DefaultEXIFactory
```
public interface EXIFactory
extends Cloneable
```
An EXI Factory is used for setting EXI coding options on one hand and retrieving the according reader and writer classes on the other hand.

Author:

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

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`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
`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
`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
`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
`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 options)` Sets the options used by the EXI Decoder(e.g., ignore schemaId).
`void`	`setEncodingOptions(EncodingOptions headerOptions)` 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.

- Method Detail
  - setFidelityOptions
```
void setFidelityOptions(FidelityOptions fidelityOptions)
```
    Sets the fidelity options used by the EXI factory (e.g. preserving XML comments or DTDs).
    
    Parameters:
    
    fidelityOptions - new fidelity options
    
    See Also:
    
    FidelityOptions
  - getFidelityOptions
```
FidelityOptions getFidelityOptions()
```
    Returns the fidelity options used by the EXI factory (e.g. preserving XML comments or DTDs).
    
    Returns:
    
    fidelity options currently used by the factory
    
    See Also:
    
    FidelityOptions
  - setEncodingOptions
```
void setEncodingOptions(EncodingOptions headerOptions)
```
    Sets the header options used by the EXI Encoder(e.g., include EXI Cookie, EXI Options document).
    
    Parameters:
    
    headerOptions - header options
    
    See Also:
    
    EncodingOptions
  - getEncodingOptions
```
EncodingOptions getEncodingOptions()
```
    Returns the header options used by the EXI encoder.
    
    Returns:
    
    header options currently used by the factory
    
    See Also:
    
    EncodingOptions
  - setDecodingOptions
```
void setDecodingOptions(DecodingOptions options)
```
    Sets the options used by the EXI Decoder(e.g., ignore schemaId).
    
    Parameters:
    
    options - decoding options
    
    See Also:
    
    decoding options
  - getDecodingOptions
```
DecodingOptions getDecodingOptions()
```
    Returns the options used by the EXI decoder.
    
    Returns:
    
    options currently used by the factory
    
    See Also:
    
    DecodingOptions
  - setSchemaIdResolver
```
void setSchemaIdResolver(SchemaIdResolver schemaIdResolver)
```
    Sets specific schemaId resolver.
    
    Parameters:
    
    schemaIdResolver - schemaId resolver
    
    See Also:
    
    SchemaIdResolver
  - getSchemaIdResolver
```
SchemaIdResolver getSchemaIdResolver()
```
    Returns schemaId resolver for this factory;
    
    Returns:
    
    Schema Id Resolver
  - setFragment
```
void setFragment(boolean isFragment)
```
    Informs the factory that we are dealing with an XML fragment instead of an XML document
    
    Parameters:
    
    isFragment - true if is fragment
  - isFragment
```
boolean isFragment()
```
    Returns whether we deal with a fragment
    
    Returns:
    
    is fragment
  - setGrammars
```
void setGrammars(Grammars grammar)
```
    Sets the EXI Grammars used for coding.
    
    Parameters:
    
    grammar - grammar
  - getGrammars
```
Grammars getGrammars()
```
    Returns the currently used EXI Grammars. By default a SchemaLessGrammars is used.
    
    Returns:
    
    grammar used by the factory
  - setCodingMode
```
void setCodingMode(CodingMode codingMode)
```
    Re-sets the coding mode used by the factory.
    
    Parameters:
    
    codingMode - coding mode
  - getCodingMode
```
CodingMode getCodingMode()
```
    Returns the currently used CodingMode. By default BIT_PACKED is used.
    
    Returns:
    
    coding-mode used by the factory
  - setBlockSize
```
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.
    
    Parameters:
    
    blockSize - blockSize
  - getBlockSize
```
int getBlockSize()
```
    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.
    
    Returns:
    
    blockSize
  - setValueMaxLength
```
void setValueMaxLength(int valueMaxLength)
```
    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
    
    Parameters:
    
    valueMaxLength - the maximum string length of value content items to be considered for addition to the string table
  - getValueMaxLength
```
int getValueMaxLength()
```
    The default value "unbounded" is assumed when the "valueMaxLength" element is absent.
    
    Returns:
    
    value OR negative for unbounded
  - setValuePartitionCapacity
```
void setValuePartitionCapacity(int valuePartitionCapacity)
```
    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
    
    Parameters:
    
    valuePartitionCapacity - the total capacity of value partitions in a string table
  - getValuePartitionCapacity
```
int getValuePartitionCapacity()
```
    The default value "unbounded" is assumed when the "valuePartitionCapacity" element is absent
    
    Returns:
    
    value OR negative for unbounded
  - setDatatypeRepresentationMap
```
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. 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.
    
    Parameters:
    
    dtrMapTypes - dtrMap types
    
    dtrMapRepresentations - dtrMap representations
  - registerDatatypeRepresentationMapDatatype
```
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. This method allows to register the datatype that should be used.
    
    Parameters:
    
    dtrMapRepresentation - dtrMap type
    
    datatype - dtrMap datatype
    
    Returns:
    
    the previous value associated with dtrMapRepresentation, or null if there was no mapping
  - getDatatypeRepresentationMapTypes
```
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.
    
    Returns:
    
    qualified name array for dtr types OR null
  - getDatatypeRepresentationMapRepresentations
```
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.
    
    Returns:
    
    qualified name array for dtr representations OR null
  - setSelfContainedElements
```
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. 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.
    
    Parameters:
    
    scElements - selfContained elements
  - setSelfContainedElements
```
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. 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.
    
    Parameters:
    
    scElements - selfContained elements
    
    scHandler - handler for SC elements
  - isSelfContainedElement
```
boolean isSelfContainedElement(QName element)
```
    Returns boolean value telling whether a certain element is encoded as selfContained fragment.
    
    Parameters:
    
    element - qualified element name
    
    Returns:
    
    true if a certain element is selfContained
  - getSelfContainedHandler
```
SelfContainedHandler getSelfContainedHandler()
```
    Returns selfContained element handler.
    
    Returns:
    
    selfContained element handler or null
  - setLocalValuePartitions
```
void setLocalValuePartitions(boolean useLocalValuePartitions)
```
    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
    
    Parameters:
    
    useLocalValuePartitions - whether to use localValue partitions
  - isLocalValuePartitions
```
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
    
    Returns:
    
    whether local value partitions are used
  - setMaximumNumberOfBuiltInElementGrammars
```
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.
    The value "unbounded" (-1) indicates that no restrictions are used and represents the behavior of the EXI 1.0 specification
    
    Parameters:
    
    maximumNumberOfBuiltInElementGrammars - maximum number of Built-In element grammars
  - getMaximumNumberOfBuiltInElementGrammars
```
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.
    
    Returns:
    
    maximum number of evolving built-in element grammars
  - setMaximumNumberOfBuiltInProductions
```
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.
    The value "unbounded" (-1) indicates that no restrictions are used and represents the behavior of the EXI 1.0 specification
    
    Parameters:
    
    maximumNumberOfBuiltInProductions - maximum number of Built-In productions
  - getMaximumNumberOfBuiltInProductions
```
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.
    
    Returns:
    
    maximum number of built-in productions
  - isGrammarLearningDisabled
```
boolean isGrammarLearningDisabled()
```
    The EXI profile defines parameters that restrict grammar learning. This is a convenience method to indicate whether grammar restriction is in use.
    
    Returns:
    
    whether schema learning is disabled
  - setSharedStrings
```
void setSharedStrings(List<String> sharedStrings)
```
    (Experimental) Feature to pre-agree on shared strings.
    
    Parameters:
    
    sharedStrings - list of shared strings
  - getSharedStrings
```
List<String> getSharedStrings()
```
    (Experimental) Return list of shared strings.
    
    Returns:
    
    null or shared strings if any
  - setUsingNonEvolvingGrammars
```
void setUsingNonEvolvingGrammars(boolean isNonEvolving)
```
    (Experimental) Feature which dictates that grammar does not grow in any circumstance
    
    Parameters:
    
    isNonEvolving - whether instead of built-in grammars schema-informed Element Fragment Grammar is used
  - isUsingNonEvolvingGrammars
```
boolean isUsingNonEvolvingGrammars()
```
    (Experimental) Returns whether non-evolving grammars are used
    
    Returns:
    
    true or false
  - createEXIBodyEncoder
```
EXIBodyEncoder createEXIBodyEncoder()
                             throws EXIException
```
    Returns an EXIBodyEncoder
    
    Returns:
    
    encoder using the previously set coding options.
    
    Throws:
    
    EXIException - EXI exception
  - createEXIStreamEncoder
```
EXIStreamEncoder createEXIStreamEncoder()
                                 throws EXIException
```
    Returns an EXIStreamEncoder
    
    Returns:
    
    stream encoder using the previously set coding options.
    
    Throws:
    
    EXIException - EXI exception
  - createEXIBodyDecoder
```
EXIBodyDecoder createEXIBodyDecoder()
                             throws EXIException
```
    Returns an EXIBodyDecoder
    
    Returns:
    
    decoder using the previously set coding options.
    
    Throws:
    
    EXIException - EXI exception
  - createEXIStreamDecoder
```
EXIStreamDecoder createEXIStreamDecoder()
                                 throws EXIException
```
    Returns an EXIStreamDecoder
    
    Returns:
    
    stream decoder using the previously set coding options.
    
    Throws:
    
    EXIException - EXI exception
  - createStringEncoder
```
StringEncoder createStringEncoder()
```
    Returns an EXI StringEncoder according coding options
    
    Returns:
    
    String Encoder
  - createTypeEncoder
```
TypeEncoder createTypeEncoder()
                       throws EXIException
```
    Returns an EXI TypeEncoder according coding options such as schema-informed or schema-less grammar and options like Preserve.LexicalValues
    
    Returns:
    
    type encoder according given EXI options
    
    Throws:
    
    EXIException - EXI exception
    
    See Also:
    
    TypeEncoder
  - createStringDecoder
```
StringDecoder createStringDecoder()
```
    Returns an EXI StringDecoder according coding options
    
    Returns:
    
    String Decoder
  - createTypeDecoder
```
TypeDecoder createTypeDecoder()
                       throws EXIException
```
    Returns an EXI TypeDecoder according coding options such as schema-informed or schema-less grammar and options like Preserve.LexicalValues
    
    Returns:
    
    type decoder according given EXI options
    
    Throws:
    
    EXIException - EXI exception
    
    See Also:
    
    TypeDecoder
  - clone
```
EXIFactory clone()
```
    Returns a shallow copy of this EXI factory.
    
    Returns:
    
    EXIFactory

Interface EXIFactory

Method Summary

Method Detail

setFidelityOptions

getFidelityOptions

setEncodingOptions

getEncodingOptions

setDecodingOptions

getDecodingOptions

setSchemaIdResolver

getSchemaIdResolver

setFragment

isFragment

setGrammars

getGrammars

setCodingMode

getCodingMode

setBlockSize

getBlockSize

setValueMaxLength

getValueMaxLength

setValuePartitionCapacity

getValuePartitionCapacity

setDatatypeRepresentationMap

registerDatatypeRepresentationMapDatatype

getDatatypeRepresentationMapTypes

getDatatypeRepresentationMapRepresentations

setSelfContainedElements

setSelfContainedElements

isSelfContainedElement

getSelfContainedHandler

setLocalValuePartitions

isLocalValuePartitions

setMaximumNumberOfBuiltInElementGrammars

getMaximumNumberOfBuiltInElementGrammars

setMaximumNumberOfBuiltInProductions

getMaximumNumberOfBuiltInProductions

isGrammarLearningDisabled

setSharedStrings

getSharedStrings

setUsingNonEvolvingGrammars

isUsingNonEvolvingGrammars

createEXIBodyEncoder

createEXIStreamEncoder

createEXIBodyDecoder

createEXIStreamDecoder

createStringEncoder

createTypeEncoder

createStringDecoder

createTypeDecoder

clone