Package com.aquima.interactions.communication.impl

Class SchemaSetDefinition

java.lang.Object

com.aquima.interactions.communication.impl.SchemaSetDefinition

All Implemented Interfaces:

ISchemaSetDefinition, Serializable

public final class SchemaSetDefinition
extends Object
implements ISchemaSetDefinition

This class holds the static definition of a schema set.

Since:

9.0

Author:

Arjan Pragt

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
SchemaSetDefinition(ISchemaSetDS datasource, IMetaModel metaModel, IRuleEngine ruleEngine)	Construct a schemaset with a datasource.

Method Summary

Modifier and Type	Method	Description
protected void	addSchema(SchemaDefinition def)
IElementMappingDefinition	getElement(QualifiedName qualifiedName)	This method returns the element definition of an element in this schemaset.
String	getName()	This method returns the name of the schemaset.
ISchemaDefinition	getSchema(String name)	This method returns the schema definition.
String[]	getSchemas()	This method returns the names of the schemas that are available in this schema set.
ISchemaDefinition[]	getSchemas(String namespace)
ITypeMappingDefinition	getType(QualifiedName qualifiedName)	This method returns the type definition of an type in this schemaset.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

SchemaSetDefinition

public SchemaSetDefinition(ISchemaSetDS datasource,
 IMetaModel metaModel,
 IRuleEngine ruleEngine)
                    throws InitializationException

Construct a schemaset with a datasource.

Parameters:

datasource - The datasource containing the definition data, may not be null.

metaModel - The meta model, may not be null.

ruleEngine - The rule engine, may not be null.

Throws:

InitializationException - This exception is thrown when the definition could not be created.

Method Details

getName

public String getName()

Description copied from interface: ISchemaSetDefinition

This method returns the name of the schemaset.

Specified by:

getName in interface ISchemaSetDefinition

Returns:

The name of the schemaset, may not be null.

getSchemas

public String[] getSchemas()

Description copied from interface: ISchemaSetDefinition

This method returns the names of the schemas that are available in this schema set.

Specified by:

getSchemas in interface ISchemaSetDefinition

Returns:

The names of the schemas, never null.

getSchemas

public ISchemaDefinition[] getSchemas(String namespace)

getElement

public IElementMappingDefinition getElement(QualifiedName qualifiedName)
                                     throws UnknownElementMappingException

Description copied from interface: ISchemaSetDefinition

This method returns the element definition of an element in this schemaset.

Specified by:

getElement in interface ISchemaSetDefinition

Parameters:

qualifiedName - Full qualified name of the element, may not be null.

Returns:

The definition of the element.

Throws:

UnknownElementMappingException - when there is no element mapping for the given elementName

getType

public ITypeMappingDefinition getType(QualifiedName qualifiedName)
                               throws UnknownTypeMappingException

Description copied from interface: ISchemaSetDefinition

This method returns the type definition of an type in this schemaset.

Specified by:

getType in interface ISchemaSetDefinition

Parameters:

qualifiedName - Full qualified name of the type, may not be null.

Returns:

The definition of the type.

Throws:

UnknownTypeMappingException - when there is no type mapping for the given typeName

getSchema

public ISchemaDefinition getSchema(String name)
                            throws UnknownSchemaException

Description copied from interface: ISchemaSetDefinition

This method returns the schema definition.

Specified by:

getSchema in interface ISchemaSetDefinition

Parameters:

name - The name of the schema.

Returns:

The definition of the schema.

Throws:

UnknownSchemaException - when there is no schema with the given name

addSchema

protected void addSchema(SchemaDefinition def)
                  throws InitializationException

Throws:

InitializationException