FidelityOptions (EXIficient-Core 1.0.4 API)

java.lang.Object
- com.siemens.ct.exi.core.FidelityOptions

```
public class FidelityOptions
extends Object
```
Some XML applications do not require the entire XML feature set and would prefer to eliminate the overhead associated with unused features. Applications can use a set of fidelity options to specify the XML features they require.

Author:

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

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`FEATURE_COMMENT`
`static String`	`FEATURE_DTD`
`static String`	`FEATURE_LEXICAL_VALUE`
`static String`	`FEATURE_PI`
`static String`	`FEATURE_PREFIX`
`static String`	`FEATURE_SC`
`static String`	`FEATURE_STRICT`
`protected boolean`	`isComment`
`protected boolean`	`isDTD`
`protected boolean`	`isLexicalValue`
`protected boolean`	`isPI`
`protected boolean`	`isPrefix`
`protected boolean`	`isSC`
`protected boolean`	`isStrict`
`protected Set<String>`	`options`

Constructor Summary

Constructors
Modifier Constructor and Description

protected FidelityOptions()

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static FidelityOptions`	`createAll()` Creates fidelity options using the maximum XML compatibility mode, e.g.
`static FidelityOptions`	`createDefault()` Creates fidelity options using default options
`static FidelityOptions`	`createStrict()` Creates fidelity options using strict option.
`boolean`	`equals(Object o)`
`int`	`get1stLevelEventCodeLength(Grammar grammar)`
`int`	`get2ndLevelCharacteristics(Grammar grammar)`
`int`	`get2ndLevelEventCode(EventType eventType, Grammar grammar)`
`EventType`	`get2ndLevelEventType(int ec2, Grammar grammar)`
`int`	`get3rdLevelCharacteristics()`
`int`	`get3rdLevelEventCode(EventType eventType)`
`EventType`	`get3rdLevelEventType(int ec3)`
`int`	`hashCode()`
`boolean`	`isFidelityEnabled(String key)` Informs whether the specified feature is enabled.
`boolean`	`isStrict()` Convenience method returning whether all fidelity options that affect grammars are turned off (e.g.
`void`	`setFidelity(String key, boolean decision)` Enables or disables the specified fidelity feature.
`String`	`toString()`

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

- Field Detail
  - FEATURE_COMMENT
```
public static final String FEATURE_COMMENT
```
    See Also:
    
    Constant Field Values
  - FEATURE_PI
```
public static final String FEATURE_PI
```
    See Also:
    
    Constant Field Values
  - FEATURE_DTD
```
public static final String FEATURE_DTD
```
    See Also:
    
    Constant Field Values
  - FEATURE_PREFIX
```
public static final String FEATURE_PREFIX
```
    See Also:
    
    Constant Field Values
  - FEATURE_LEXICAL_VALUE
```
public static final String FEATURE_LEXICAL_VALUE
```
    See Also:
    
    Constant Field Values
  - FEATURE_SC
```
public static final String FEATURE_SC
```
    See Also:
    
    Constant Field Values
  - FEATURE_STRICT
```
public static final String FEATURE_STRICT
```
    See Also:
    
    Constant Field Values
  - options
```
protected Set<String> options
```
  - isStrict
```
protected boolean isStrict
```
  - isComment
```
protected boolean isComment
```
  - isPI
```
protected boolean isPI
```
  - isDTD
```
protected boolean isDTD
```
  - isPrefix
```
protected boolean isPrefix
```
  - isLexicalValue
```
protected boolean isLexicalValue
```
  - isSC
```
protected boolean isSC
```
- Constructor Detail
  - FidelityOptions
```
protected FidelityOptions()
```
- Method Detail
  - createDefault
```
public static FidelityOptions createDefault()
```
    Creates fidelity options using default options
    
    Returns:
    
    default fidelity options
  - createStrict
```
public static FidelityOptions createStrict()
```
    Creates fidelity options using strict option. Note: no namespace prefixes, comments etc are preserved nor schema deviations are allowed.
    
    Returns:
    
    default fidelity options
  - createAll
```
public static FidelityOptions createAll()
```
    Creates fidelity options using the maximum XML compatibility mode, e.g. preserving comments, unsignificant whitespaces et cetera.
    Note: Per default SelfContained Element support is not set to TRUE. It cannot work together with (Pre-)Compression!
    
    Returns:
    
    default fidelity options
  - setFidelity
```
public void setFidelity(String key,
                        boolean decision)
                 throws UnsupportedOption
```
    Enables or disables the specified fidelity feature.
    
    Parameters:
    
    key - referring to a specific feature
    
    decision - enabling or disabling feature
    
    Throws:
    
    UnsupportedOption - if option is not supported
  - isFidelityEnabled
```
public boolean isFidelityEnabled(String key)
```
    Informs whether the specified feature is enabled.
    
    Parameters:
    
    key - feature
    
    Returns:
    
    whether option is turned on
  - isStrict
```
public final boolean isStrict()
```
    Convenience method returning whether all fidelity options that affect grammars are turned off (e.g. Preserve.LEXICAL_VALUE is still allowed).
    
    Returns:
    
    boolean whether strict mode is in play
  - 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
  - get1stLevelEventCodeLength
```
public int get1stLevelEventCodeLength(Grammar grammar)
```
  - get2ndLevelEventType
```
public EventType get2ndLevelEventType(int ec2,
                                      Grammar grammar)
```
  - get2ndLevelEventCode
```
public int get2ndLevelEventCode(EventType eventType,
                                Grammar grammar)
```
  - get2ndLevelCharacteristics
```
public int get2ndLevelCharacteristics(Grammar grammar)
```
  - get3rdLevelEventType
```
public EventType get3rdLevelEventType(int ec3)
```
  - get3rdLevelEventCode
```
public int get3rdLevelEventCode(EventType eventType)
```
  - get3rdLevelCharacteristics
```
public int get3rdLevelCharacteristics()
```

Class FidelityOptions

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

FEATURE_COMMENT

FEATURE_PI

FEATURE_DTD

FEATURE_PREFIX

FEATURE_LEXICAL_VALUE

FEATURE_SC

FEATURE_STRICT

options

isStrict

isComment

isPI

isDTD

isPrefix

isLexicalValue

isSC

Constructor Detail

FidelityOptions

Method Detail

createDefault

createStrict

createAll

setFidelity

isFidelityEnabled

isStrict

equals

hashCode

toString

get1stLevelEventCodeLength

get2ndLevelEventType

get2ndLevelEventCode

get2ndLevelCharacteristics

get3rdLevelEventType

get3rdLevelEventCode

get3rdLevelCharacteristics