com.ibm.di.cdm.itregistry
Class ITRegistryMetaData

java.lang.Object
  extended by com.ibm.di.cdm.core.MetaData
      extended by com.ibm.di.cdm.itregistry.ITRegistryMetaData

public class ITRegistryMetaData
extends MetaData

This class is used to retrieve CDM meta-data from an IT registry.


Field Summary
 
Fields inherited from class com.ibm.di.cdm.core.MetaData
resHash
 
Constructor Summary
ITRegistryMetaData(String jdbcUrl, String jdbcDriver, String dbUsername, String dbPassword)
          Constructor.
 
Method Summary
 Vector<Entry> getAttributes(String artifactType, String classType)
          Retrieves the attributes of a given artifact (CI or a Relationship).
 String getCdmVersion()
          Retrieves the version of the Common Data Model, which meta-data is extracted.
protected  String getIdentifierName(NamingRuleIdentifier identifier)
          Generate proper name for provided NamingRuleIdentifier.
protected  List<NamingRule> getNamingRules(String classType)
          FIXME:
 Map<String,Object> getTypes(String artifactType)
          Returns the CDM meta-data types artifacts (CIs or Relationships).
 
Methods inherited from class com.ibm.di.cdm.core.MetaData
createExplicitAttribute, createImplicitAttribute, getClassType, getExtendedAttributeName, getMSSClassName, getNamingRuleIdentifier, getRelationshipAttributes, getUnsatisfiedNamingRules, matchesNamingRules
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ITRegistryMetaData

public ITRegistryMetaData(String jdbcUrl,
                          String jdbcDriver,
                          String dbUsername,
                          String dbPassword)
                   throws Exception
Constructor.

Parameters:
jdbcUrl - the JDBC URL used for connecting to the IT registry.
jdbcDriver - the JDBC driver for connecting to the IT registry.
dbUsername - the user name used for connecting to the IT registry.
dbPassword - the password used for connecting to the IT registry.
Throws:
Exception - if the JDBC driver is unavailable.
Method Detail

getAttributes

public Vector<Entry> getAttributes(String artifactType,
                                   String classType)
                            throws Exception
Retrieves the attributes of a given artifact (CI or a Relationship).

Specified by:
getAttributes in class MetaData
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 String getCdmVersion()
                     throws Exception
Retrieves the version of the Common Data Model, which meta-data is extracted.

Specified by:
getCdmVersion in class MetaData
Returns:
a string representing the CDM version. Its format is '<version>.<release>.<modifier>'.
Throws:
Exception - if a problem occurs.

getTypes

public Map<String,Object> getTypes(String artifactType)
                            throws Exception
Returns the CDM meta-data types artifacts (CIs or Relationships).

Specified by:
getTypes in class MetaData
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.

getNamingRules

protected List<NamingRule> getNamingRules(String classType)
                                   throws Exception
FIXME:

Important: Once the DIS team starts supporting Naming Rule-s via the DataIntegrationServices API this method should be extended to return their IT registry adapter classes.

Specified by:
getNamingRules in class MetaData
Parameters:
classType - the class type of interest.
Returns:
a list of the available naming rules.
Throws:
Exception - if a problem occurs when reading the rules.
See Also:
JarNamingRulesReader, TADDMNamingRulesReader

getIdentifierName

protected String getIdentifierName(NamingRuleIdentifier identifier)
Generate proper name for provided NamingRuleIdentifier.

Overrides:
getIdentifierName in class MetaData
Parameters:
identifier - whose name will be generate.
Returns:
a proper name