com.siemens.ct.exi.core.grammars

Interface Grammars

All Known Implementing Classes:

AbstractGrammars, SchemaInformedGrammars, SchemaLessGrammars

public interface Grammars

Author:

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

Method Summary

Modifier and Type	Method and Description
Grammar	getDocumentGrammar()
Grammar	getFragmentGrammar()
GrammarContext	getGrammarContext()
String	getSchemaId() The schemaID option may be used to identify the schema information used for processing the EXI body.
boolean	isBuiltInXMLSchemaTypesOnly() The built-in XML schema types are available.
boolean	isSchemaInformed() Schema information is used to create grammar.
void	setSchemaId(String schemaId) Sets the schemaId passed to EXI decoder.

Method Detail

isSchemaInformed

boolean isSchemaInformed()

Schema information is used to create grammar.

Returns:

boolean value indicating whether the grammar is schema-informed

getSchemaId

String getSchemaId()

The schemaID option may be used to identify the schema information used for processing the EXI body. When the "schemaID" is null no schema information is used for processing the EXI body. When the value of the "schemaID" is an empty string, no user defined schema information is used for processing the EXI body; however, the built-in XML schema types are available for use in the EXI body.

An example schemaID scheme is the use of URI that is apt for globally identifying schema resources on the Web.

Returns:

schema identifier

setSchemaId

void setSchemaId(String schemaId)
          throws UnsupportedOption

Sets the schemaId passed to EXI decoder.

Note: Schema-less or XML-types grammars have a schema id associated with them (null and empty string).

Parameters:

schemaId - schemaId

Throws:

UnsupportedOption - if schemaId does not respect EXI restrictions (e.g., schema-less grammars: schemaId == null)

isBuiltInXMLSchemaTypesOnly

boolean isBuiltInXMLSchemaTypesOnly()

The built-in XML schema types are available.

Note: the grammar is schema-informed also (see isSchemaInformed())

Returns:

boolean value indicating whether the grammar uses built-in types only

getDocumentGrammar

Grammar getDocumentGrammar()

getFragmentGrammar

Grammar getFragmentGrammar()

getGrammarContext

GrammarContext getGrammarContext()