EXIficient

com.siemens.ct.exi
Class FidelityOptions

java.lang.Object
  extended by com.siemens.ct.exi.FidelityOptions

public class FidelityOptions
extends java.lang.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.

Version:
0.3.20080922
Author:
Daniel.Peintner.EXT@siemens.com, Joerg.Heuer@siemens.com

Field Summary
static java.lang.String FEATURE_COMMENT
           
static java.lang.String FEATURE_DTD
           
static java.lang.String FEATURE_LEXICAL_VALUE
           
static java.lang.String FEATURE_PI
           
static java.lang.String FEATURE_PREFIX
           
static java.lang.String FEATURE_SC
           
static java.lang.String FEATURE_STRICT
           
static java.lang.String FEATURE_WS
           
static java.lang.String FEATURE_XSI_SCHEMALOCATION
           
 
Method Summary
static FidelityOptions createAll()
          Creates fidelity options using the maximum compatibility mode, e.g.
static FidelityOptions createDefault()
          Creates fidelity options using default options
static FidelityOptions createStrict()
          Creates fidelity options using strict option.
 boolean equals(java.lang.Object o)
           
 int hashCode()
           
 boolean isFidelityEnabled(java.lang.String key)
          Informs whether the specified feature is enabled.
 boolean isStrict()
          Convenience method returning whether all fidelity options are turned off.
 void setFidelity(java.lang.String key, boolean decision)
          Enables or disables the specified fidelity feature.
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

FEATURE_COMMENT

public static final java.lang.String FEATURE_COMMENT
See Also:
Constant Field Values

FEATURE_PI

public static final java.lang.String FEATURE_PI
See Also:
Constant Field Values

FEATURE_DTD

public static final java.lang.String FEATURE_DTD
See Also:
Constant Field Values

FEATURE_PREFIX

public static final java.lang.String FEATURE_PREFIX
See Also:
Constant Field Values

FEATURE_XSI_SCHEMALOCATION

public static final java.lang.String FEATURE_XSI_SCHEMALOCATION
See Also:
Constant Field Values

FEATURE_LEXICAL_VALUE

public static final java.lang.String FEATURE_LEXICAL_VALUE
See Also:
Constant Field Values

FEATURE_WS

public static final java.lang.String FEATURE_WS
See Also:
Constant Field Values

FEATURE_SC

public static final java.lang.String FEATURE_SC
See Also:
Constant Field Values

FEATURE_STRICT

public static final java.lang.String FEATURE_STRICT
See Also:
Constant Field Values
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 compatibility mode, e.g. preserving unsignificant whitespaces.

Returns:
default fidelity options

setFidelity

public void setFidelity(java.lang.String key,
                        boolean decision)
                 throws UnsupportedOption
Enables or disables the specified fidelity feature.

Parameters:
key - refering to a specific feature
decision - enabling or disabling feature
Throws:
UnsupportedOption

isFidelityEnabled

public boolean isFidelityEnabled(java.lang.String key)
Informs whether the specified feature is enabled.

Parameters:
key - feature
Returns:
whether option is turned on

isStrict

public boolean isStrict()
Convenience method returning whether all fidelity options are turned off.

Returns:
boolean whether strict mode is in play

equals

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

hashCode

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

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

EXIficient