org.camunda.bpm.model.xml

Interface Model

All Known Implementing Classes:

ModelImpl

public interface Model

A model contains all defined types and the relationship between them. See ModelBuilder.createInstance(java.lang.String) to create a new model.

Author:

Daniel Meyer

Method Summary

Modifier and Type	Method and Description
String	getActualNamespace(String alternativeNs) Returns the actual namespace URI for an alternative namespace URI
String	getAlternativeNamespace(String actualNs) Returns the alternative namespace URI for a namespace URI
Set<String>	getAlternativeNamespaces(String actualNs)
String	getModelName() Returns the model name, which is the identifier of this model.
ModelElementType	getType(Class<? extends ModelElementInstance> instanceClass) Gets the defined ModelElementType of a ModelElementInstance.
ModelElementType	getTypeForName(String typeName) Gets the defined ModelElementType for a type by its name.
ModelElementType	getTypeForName(String namespaceUri, String typeName) Gets the defined ModelElementType for a type by its name and namespace URI.
Collection<ModelElementType>	getTypes() Gets the collection of all ModelElementType defined in the model.

Method Detail

getTypes

Collection<ModelElementType> getTypes()

Gets the collection of all ModelElementType defined in the model.

Returns:

the list of all defined element types of this model

getType

ModelElementType getType(Class<? extends ModelElementInstance> instanceClass)

Gets the defined ModelElementType of a ModelElementInstance.

Parameters:

instanceClass - the instance class to find the type for

Returns:

the corresponding element type or null if no type is defined for the instance

getTypeForName

ModelElementType getTypeForName(String typeName)

Gets the defined ModelElementType for a type by its name.

Parameters:

typeName - the name of the type

Returns:

the element type or null if no type is defined for the name

getTypeForName

ModelElementType getTypeForName(String namespaceUri,
                                String typeName)

Gets the defined ModelElementType for a type by its name and namespace URI.

Parameters:

namespaceUri - the namespace URI for the type

typeName - the name of the type

Returns:

the element type or null if no type is defined for the name and namespace URI

getModelName

String getModelName()

Returns the model name, which is the identifier of this model.

Returns:

the model name

getActualNamespace

String getActualNamespace(String alternativeNs)

Returns the actual namespace URI for an alternative namespace URI

Parameters:

alternativeNs - the alternative namespace URI

Returns:

the actual namespace URI or null if none is set

getAlternativeNamespace

String getAlternativeNamespace(String actualNs)

Returns the alternative namespace URI for a namespace URI

Parameters:

actualNs - the actual namespace URI

Returns:

the alternative namespace URI or null if none is set

getAlternativeNamespaces

Set<String> getAlternativeNamespaces(String actualNs)