org.eclipse.cosmos.rm.repository.provisional.resource
Interface ISMLMetadata

public interface ISMLMetadata

Represents the meta information of an SML document

Field Summary

static int	DOCUMENT_TYPE_DEFINITION Represents the definition document type
static int	DOCUMENT_TYPE_INSTANCE Represents the instance document type
static int	DOCUMENT_TYPE_NONE Indicates an unknown document type

Method Summary

java.lang.String[]	getAliases() Retrieves and returns the aliases of the associated SML document
java.util.Map	getBoundRules() Retrieves and returns the bound rules of the associated SML document The returned map is expected to be indexed based on the alias that the rule is bound to
int	getDocumentType() Returns the document type
java.lang.String	getId() Retrieves and returns the id of the associated SML document.
java.lang.String	getRootElementName() Retrieves and returns the root element name of the associated SML document.

Field Detail

DOCUMENT_TYPE_NONE

static final int DOCUMENT_TYPE_NONE

Indicates an unknown document type

See Also:

Constant Field Values

DOCUMENT_TYPE_DEFINITION

static final int DOCUMENT_TYPE_DEFINITION

Represents the definition document type

See Also:

Constant Field Values

DOCUMENT_TYPE_INSTANCE

static final int DOCUMENT_TYPE_INSTANCE

Represents the instance document type

See Also:

Constant Field Values

Method Detail

getDocumentType

int getDocumentType()

Returns the document type

Returns:

DOCUMENT_TYPE_DEFINITION if the associated document is of type definition or DOCUMENT_TYPE_INSTANCE if the associated document is of type instance.

getId

java.lang.String getId()

Retrieves and returns the id of the associated SML document. The id is implementation specific.

Returns:

The id of the associated SML document

getRootElementName

java.lang.String getRootElementName()

Retrieves and returns the root element name of the associated SML document.

Returns:

The qualified root element name of the associated SML document

getAliases

java.lang.String[] getAliases()

Retrieves and returns the aliases of the associated SML document

Returns:

The aliases of the associated SML document

getBoundRules

java.util.Map getBoundRules()

Retrieves and returns the bound rules of the associated SML document The returned map is expected to be indexed based on the alias that the rule is bound to

Returns:

The bound rules of the associated SML document.