com.ibm.di.fc.idml.md
Class MetaData

java.lang.Object
  com.ibm.di.fc.idml.md.MetaData

public abstract class MetaData
extends Object

An abstract class that declares the routines to be used to retrieve the CDM meta-data.

Field Summary

static String	CDM_PREFIX A prefix used for each CDM type and attribute name.
protected static ResourceHash	resHash NLS Property set holding name-value pairs for the resource.

Constructor Summary

MetaData()

Method Summary

abstract Vector<Entry>	getAttributes(String artifactType, String classType) Retrieves the attributes of a given artifact (CI or a Relationship).
abstract String	getCdmVersion() Retrieves the version of the Common Data Model, which meta-data is extracted.
protected Vector<Entry>	getRelationshipAttributes() Returns the attributes supported by a Relationship.
abstract Map<String,Object>	getTypes(String artifactType) Returns the CDM meta-data types artifacts (CIs or Relationships).

Methods inherited from class java.lang.Object

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

Field Detail

resHash

protected static ResourceHash resHash

NLS Property set holding name-value pairs for the resource.

CDM_PREFIX

public static final String CDM_PREFIX

A prefix used for each CDM type and attribute name.

See Also:

Constant Field Values

Constructor Detail

MetaData

public MetaData()

Method Detail

getAttributes

public abstract Vector<Entry> getAttributes(String artifactType,
                                            String classType)
                                     throws Exception

Retrieves the attributes of a given artifact (CI or a Relationship).

Parameters:

artifactType - determines the type of artifact, which attributes we want. Accepts either IdMLConstants.ARTIFACT_CI or IdMLConstants.ARTIFACT_RELATIONSHIP.

classType - the type of the artifact, which attributes we want.

Returns:

a Vector containing the CI/Relationship attributes.

Throws:

Exception - if a problem occurs.

getCdmVersion

public abstract String getCdmVersion()
                              throws Exception

Retrieves the version of the Common Data Model, which meta-data is extracted.

Returns:

a string representing the CDM version. Its format is '<version>.<release>.<modifier>'.

Throws:

Exception - if a problem occurs.

getTypes

public abstract Map<String,Object> getTypes(String artifactType)
                                     throws Exception

Returns the CDM meta-data types artifacts (CIs or Relationships).

Parameters:

artifactType - determines the type of artifact - either IdMLConstants.ARTIFACT_CI or IdMLConstants.ARTIFACT_RELATIONSHIP.

Returns:

a Map containing the CDM type names and additional data for them as an Object.

Throws:

Exception - if a problem occurs.

getRelationshipAttributes

protected Vector<Entry> getRelationshipAttributes()
                                           throws Exception

Returns the attributes supported by a Relationship. Each Relationship has two mandatory attributes - source and target.

Returns:

a Vector containing the Relationship attributes.

Throws:

Exception - if a problem occurs.