Package com.aquima.interactions.communication.impl

Class SchemaDefinition

java.lang.Object

com.aquima.interactions.communication.impl.SchemaDefinition

All Implemented Interfaces:

ISchemaDefinition, Serializable

public final class SchemaDefinition
extends Object
implements ISchemaDefinition

This class holds the static definition of a schema.

Since:

9.0

Author:

Arjan Pragt

See Also:

• Serialized Form

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	SchemaDefinition(ISchemaDS datasource, IMetaModel metaModel, IRuleEngine ruleEngine)

Method Summary

Modifier and Type	Method	Description
protected void	addElement(ElementMappingDefinition def)
protected void	addType(TypeMappingDefinition def)
boolean	containsElement(String name)	This method indicates whether an element is defined in this schema.
boolean	containsTypeMapping(String name)	This method indicates whether a type is defined in this schema.
SchemaFormType	getAttributeFormDefault()	This method returns the attributeformdefault of the shema.
IElementMappingDefinition	getElement(String name)	This method returns the definition of an element.
SchemaFormType	getElementFormDefault()	This method returns the elementformdefault of the schema.
IElementMappingDefinition[]	getElements()	This method returns all defined elements of this schema.
String	getName()	This method returns the name of the schema.
String	getTargetNamespace()	This method returns the namespace of the schema.
ITypeMappingDefinition	getType(String name)	This method returns the definition of a type.
ITypeMappingDefinition[]	getTypes()	This method returns all defined types of this schema.
protected void	initialize(SchemaSetDefinition schemaSet)

Methods inherited from class java.lang.Object

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

Constructor Details

SchemaDefinition

protected SchemaDefinition(ISchemaDS datasource,
 IMetaModel metaModel,
 IRuleEngine ruleEngine)
                    throws InitializationException

Throws:

InitializationException

Method Details

initialize

protected void initialize(SchemaSetDefinition schemaSet)
                   throws InitializationException

Throws:

InitializationException

getName

public String getName()

Description copied from interface: ISchemaDefinition

This method returns the name of the schema.

Specified by:

getName in interface ISchemaDefinition

Returns:

The name of the schema, may not be null.

getTargetNamespace

public String getTargetNamespace()

Description copied from interface: ISchemaDefinition

This method returns the namespace of the schema.

Specified by:

getTargetNamespace in interface ISchemaDefinition

Returns:

The namespace of the schema, or null.

getElementFormDefault

public SchemaFormType getElementFormDefault()

Description copied from interface: ISchemaDefinition

This method returns the elementformdefault of the schema.

Specified by:

getElementFormDefault in interface ISchemaDefinition

Returns:

The elementFormDefault, may not be null.

getAttributeFormDefault

public SchemaFormType getAttributeFormDefault()

Description copied from interface: ISchemaDefinition

This method returns the attributeformdefault of the shema.

Specified by:

getAttributeFormDefault in interface ISchemaDefinition

Returns:

The attributeFormDefault, may not be null.

containsElement

public boolean containsElement(String name)

Description copied from interface: ISchemaDefinition

This method indicates whether an element is defined in this schema.

Specified by:

containsElement in interface ISchemaDefinition

Parameters:

name - The name of the element, may not be null.

Returns:

Indicator if present or not.

getElement

public IElementMappingDefinition getElement(String name)
                                     throws UnknownElementMappingException

Description copied from interface: ISchemaDefinition

This method returns the definition of an element.

Specified by:

getElement in interface ISchemaDefinition

Parameters:

name - The name of the element, may not be null.

Returns:

The definition of the element.

Throws:

UnknownElementMappingException - when the element does not have a element mapping

getElements

public IElementMappingDefinition[] getElements()

Description copied from interface: ISchemaDefinition

This method returns all defined elements of this schema.

Specified by:

getElements in interface ISchemaDefinition

Returns:

All defined elements, never null.

getType

public ITypeMappingDefinition getType(String name)
                               throws UnknownTypeMappingException

Description copied from interface: ISchemaDefinition

This method returns the definition of a type.

Specified by:

getType in interface ISchemaDefinition

Parameters:

name - The name of the type, may not be null.

Returns:

The definition of the type.

Throws:

UnknownTypeMappingException - when the type type mapping does not exist

containsTypeMapping

public boolean containsTypeMapping(String name)

Description copied from interface: ISchemaDefinition

This method indicates whether a type is defined in this schema.

Specified by:

containsTypeMapping in interface ISchemaDefinition

Parameters:

name - The name of the type, may not be null.

Returns:

Indicator if present or not.

getTypes

public ITypeMappingDefinition[] getTypes()

Description copied from interface: ISchemaDefinition

This method returns all defined types of this schema.

Specified by:

getTypes in interface ISchemaDefinition

Returns:

All defined types, never null.

addElement

protected void addElement(ElementMappingDefinition def)
                   throws InitializationException

Throws:

InitializationException

addType

protected void addType(TypeMappingDefinition def)
                throws InitializationException

Throws:

InitializationException