com.siemens.ct.exi.core

Class EncodingOptions

java.lang.Object

com.siemens.ct.exi.core.EncodingOptions

public class EncodingOptions
extends Object

Some applications may require EXI coding options shared via the EXI Header (e.g., EXI Cookie). This class allows one to specify which coding options are needed.

Author:

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	CANONICAL_EXI To indicate that the EXI stream should respect the Canonical EXI rules (see http://www.w3.org/TR/exi-c14n)
static String	DEFLATE_COMPRESSION_VALUE To set the deflate stream with a specified compression level.
static String	INCLUDE_COOKIE Include EXI Cookie
static String	INCLUDE_INSIGNIFICANT_XSI_NIL Include Insignificant xsi:nil values e.g., xsi:nil="false"
static String	INCLUDE_OPTIONS Include EXI Options (or opposite of omitOptionsDocument in Canonical EXI)
static String	INCLUDE_PROFILE_VALUES To indicate that the EXI profile is in use and advertising each parameter value (exi:p element)
static String	INCLUDE_SCHEMA_ID Include schemaID as part of EXI Options
static String	INCLUDE_XSI_SCHEMALOCATION Include attribute "schemaLocation" and "noNamespaceSchemaLocation"
protected Map<String,Object>	options
static String	RETAIN_ENTITY_REFERENCE Encode entity references as ER event instead of trying to resolve them
static String	UTC_TIME The utcTime option is used to specify whether Date-Time values must be represented using Coordinated Universal Time (UTC, sometimes called "Greenwich Mean Time").

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	EncodingOptions()

Method Summary

Modifier and Type	Method and Description
static EncodingOptions	createDefault() Creates encoding options using default options (NO Cookie, option or schemaID).
boolean	equals(Object o)
Object	getOptionValue(String key) Returns the specified option value.
int	hashCode()
boolean	isOptionEnabled(String key) Informs whether the specified option is enabled.
void	setOption(String key) Enables given option.
void	setOption(String key, Object value) Enables given option with value.
String	toString()
boolean	unsetOption(String key) Disables given option.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

INCLUDE_COOKIE

public static final String INCLUDE_COOKIE

Include EXI Cookie

See Also:

Constant Field Values

INCLUDE_OPTIONS

public static final String INCLUDE_OPTIONS

Include EXI Options (or opposite of omitOptionsDocument in Canonical EXI)

See Also:

Constant Field Values

INCLUDE_SCHEMA_ID

public static final String INCLUDE_SCHEMA_ID

Include schemaID as part of EXI Options

See Also:

Constant Field Values

RETAIN_ENTITY_REFERENCE

public static final String RETAIN_ENTITY_REFERENCE

Encode entity references as ER event instead of trying to resolve them

See Also:

Constant Field Values

INCLUDE_XSI_SCHEMALOCATION

public static final String INCLUDE_XSI_SCHEMALOCATION

Include attribute "schemaLocation" and "noNamespaceSchemaLocation"

See Also:

Constant Field Values

INCLUDE_INSIGNIFICANT_XSI_NIL

public static final String INCLUDE_INSIGNIFICANT_XSI_NIL

Include Insignificant xsi:nil values e.g., xsi:nil="false"

See Also:

Constant Field Values

INCLUDE_PROFILE_VALUES

public static final String INCLUDE_PROFILE_VALUES

To indicate that the EXI profile is in use and advertising each parameter value (exi:p element)

See Also:

Constant Field Values

UTC_TIME

public static final String UTC_TIME

The utcTime option is used to specify whether Date-Time values must be represented using Coordinated Universal Time (UTC, sometimes called "Greenwich Mean Time").

See Also:

Constant Field Values

CANONICAL_EXI

public static final String CANONICAL_EXI

To indicate that the EXI stream should respect the Canonical EXI rules (see http://www.w3.org/TR/exi-c14n)

See Also:

INCLUDE_OPTIONS, UTC_TIME, Constant Field Values

DEFLATE_COMPRESSION_VALUE

public static final String DEFLATE_COMPRESSION_VALUE

To set the deflate stream with a specified compression level.

See Also:

Deflater.setLevel(int), Constant Field Values

options

protected Map<String,Object> options

Constructor Detail

EncodingOptions

protected EncodingOptions()

Method Detail

createDefault

public static EncodingOptions createDefault()

Creates encoding options using default options (NO Cookie, option or schemaID).

Returns:

default encoding options

setOption

public void setOption(String key)
               throws UnsupportedOption

Enables given option.

Note: Some options (e.g. INCLUDE_SCHEMA_ID) will only take effect if the EXI options document is set to encode options in general (see INCLUDE_OPTIONS).

Parameters:

key - referring to a specific option

Throws:

UnsupportedOption - if option is not supported

setOption

public void setOption(String key,
                      Object value)
               throws UnsupportedOption

Enables given option with value.

Note: Some options (e.g. INCLUDE_SCHEMA_ID) will only take effect if the EXI options document is set to encode options in general (see INCLUDE_OPTIONS).

Parameters:

key - referring to a specific option

value - specific option value

Throws:

UnsupportedOption - if option is not supported

unsetOption

public boolean unsetOption(String key)

Disables given option.

Parameters:

key - referring to a specific option

Returns:

whether option was set

isOptionEnabled

public boolean isOptionEnabled(String key)

Informs whether the specified option is enabled.

Parameters:

key - feature

Returns:

whether option is turned on

getOptionValue

public Object getOptionValue(String key)

Returns the specified option value.

Parameters:

key - feature

Returns:

whether option is turned on

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