Package com.ibm.di.connector.ccmdb

Class AbstractMetaData

java.lang.Object

com.ibm.di.connector.ccmdb.AbstractMetaData

Direct Known Subclasses:

CCMDBMetaData, CDMMetaData

public abstract class AbstractMetaData
extends java.lang.Object

This is an abstract class designed to implement data transformation between internal data model and TDI data model. There is one implementation of this class for each schema supported by the connector.

Field Summary

Fields

Modifier and Type	Field	Description
protected ExecutionContext	ctx

Constructor Summary

Constructors

Constructor	Description
AbstractMetaData()

Method Summary

Modifier and Type	Method	Description
protected abstract void	applyMapping(ActualCIDefinition definition)	Add mapping information that is based on the selected schema to an ActualCIDefinition instance
protected abstract void	applyMapping(CIRelationDefinition definition)	Add mapping information that is based on the selected schema to a CIRelationDefinition instance.
abstract ActualCI	createActualCI(Entry entry)	Creates an instance of ActualCI based on a given DI Entry object.
abstract CIRelation	createCIRelation(Entry entry)	Creates an instance of CIRelation based on a given DI Entry object.
abstract Entry	createEntry(ActualCI configItem)	Creates an instance of DI Entry based on a given configuration item.
abstract Entry	createEntry(CIRelation relation)	Creates an instance of DI Entry based on a given relation.
abstract Entry	createSchema(ActualCIDefinition definition)	Creates a schema based on a given definition.
abstract Entry	createSchema(CIRelationDefinition definition)	Creates a schema based on a given definition.
ActualCIDefinition	getActualCIDefinition()	Returns an instance of ActualCIDefinition that is common for all configuration items.
ActualCIDefinition	getActualCIDefinition(java.lang.String className)	Returns an ActualCIDefinition instance for the specified configuration item class.
ActualCIDefinition	getActualCIDefinition(java.lang.String className, boolean loadSrcRelations, boolean loadTrgRelations)	Returns a definition object for the specified configuration item class.
CIRelationDefinition	getCIRelationDefinition(java.lang.String className)	Returns a definition object for the specified relation class.
CIRelationDefinition	getCIRelationDefinition(java.lang.String className, boolean loadRelationRules)	Returns a definition object for the specified relation class.
java.lang.String	getSelectedClassification()
void	init(ExecutionContext context)

Methods inherited from class java.lang.Object

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

Field Detail

ctx

protected ExecutionContext ctx

Constructor Detail

AbstractMetaData

public AbstractMetaData()

Method Detail

init

public void init(ExecutionContext context)
          throws CCMDBException

Parameters:

context - the ExecutionContext instance associated with current execution.

Throws:

CCMDBException

applyMapping

protected abstract void applyMapping(ActualCIDefinition definition)
                              throws CCMDBException

Add mapping information that is based on the selected schema to an ActualCIDefinition instance

Parameters:

definition - ActualCIDefinition instance to be updated

Throws:

CCMDBException - if a problem occurs.

applyMapping

protected abstract void applyMapping(CIRelationDefinition definition)
                              throws CCMDBException

Add mapping information that is based on the selected schema to a CIRelationDefinition instance.

Parameters:

definition - CIRelationDefinition instance to be updated

Throws:

CCMDBException - if a problem occurs.

createSchema

public abstract Entry createSchema(ActualCIDefinition definition)
                            throws CCMDBException

Creates a schema based on a given definition.

Parameters:

definition - ActualCIDefinition

Returns:

Entry the schema Entry

Throws:

CCMDBException - if a problem occurs.

createSchema

public abstract Entry createSchema(CIRelationDefinition definition)
                            throws CCMDBException

Creates a schema based on a given definition.

Parameters:

definition - CIRelationDefinition

Returns:

Entry the schema Entry

Throws:

CCMDBException - if a problem occurs.

createEntry

public abstract Entry createEntry(ActualCI configItem)
                           throws CCMDBException

Creates an instance of DI Entry based on a given configuration item.

Parameters:

configItem - the ActualCI instance to be transformed

Returns:

Entry the data Entry

Throws:

CCMDBException - if a problem occurs.

createEntry

public abstract Entry createEntry(CIRelation relation)
                           throws CCMDBException

Creates an instance of DI Entry based on a given relation.

Parameters:

relation - CIRelation instance to be transformed

Returns:

Entry the data Entry

Throws:

CCMDBException - if a problem occurs.

createActualCI

public abstract ActualCI createActualCI(Entry entry)
                                 throws CCMDBException

Creates an instance of ActualCI based on a given DI Entry object.

Parameters:

entry - the data Entry

Returns:

ActualCI an instance of ActualCI created from the input entry

Throws:

CCMDBException - if a problem occurs

createCIRelation

public abstract CIRelation createCIRelation(Entry entry)
                                     throws CCMDBException

Creates an instance of CIRelation based on a given DI Entry object.

Parameters:

entry - the data Entry

Returns:

CIRelation an instance of CIRelation created from the input entry

Throws:

CCMDBException - if a problem occurs

getActualCIDefinition

public ActualCIDefinition getActualCIDefinition()
                                         throws CCMDBException

Returns an instance of ActualCIDefinition that is common for all configuration items.

Returns:

ActualCIDefinition the common definition

Throws:

CCMDBException - if a problem occurs

getActualCIDefinition

public ActualCIDefinition getActualCIDefinition(java.lang.String className)
                                         throws CCMDBException

Returns an ActualCIDefinition instance for the specified configuration item class.

Parameters:

className - the actual CI class name

Returns:

ActualCIDefinition the corresponding ActualCIDefinition instance

Throws:

CCMDBException - if a problem occurs

getActualCIDefinition

public ActualCIDefinition getActualCIDefinition(java.lang.String className,
                                                boolean loadSrcRelations,
                                                boolean loadTrgRelations)
                                         throws CCMDBException

Returns a definition object for the specified configuration item class.

Parameters:

className - the actual CI class name

loadSrcRelations - a boolean that determines whether source relation rules should be loaded.

loadTrgRelations - a boolean that determines whether target relation rules should be loaded.

Returns:

ActualCIDefinition the corresponding ActualCIDefinition instance

Throws:

CCMDBException - if a problem occurs

getCIRelationDefinition

public CIRelationDefinition getCIRelationDefinition(java.lang.String className)
                                             throws CCMDBException

Returns a definition object for the specified relation class.

Parameters:

className - the relation class name

Returns:

CIRelationDefinition the corresponding CIRelationDefinition instance

Throws:

CCMDBException - if a problem occurs

getCIRelationDefinition

public CIRelationDefinition getCIRelationDefinition(java.lang.String className,
                                                    boolean loadRelationRules)
                                             throws CCMDBException

Returns a definition object for the specified relation class.

Parameters:

className - the relation class name

loadRelationRules - a boolean that determines whether relation rules should be loaded.

Returns:

CIRelationDefinition the corresponding CIRelationDefinition instance

Throws:

CCMDBException - if a problem occurs

getSelectedClassification

public java.lang.String getSelectedClassification()