oracle.odi.interfaces.basic
Interface IBasicInterfaceCreationHelper

public interface IBasicInterfaceCreationHelper

Any class implementing this interface is a helper to create basic ODI interfaces from scratch.

These interfaces must comply with the following:

• only one dataset
• only one source table which may be journalized (in that case, the journalization filter text may be set by the user)
• only one filter to be executed on source
• mappings are to be executed on source or staging area only
• three knowledge modules can be specified with their options: LKM, IKM and CKM
• prepareSave() must be called before saving the interface to make sure that it is consistent and can be correctly saved

Method Summary

void	prepareSave() This method should be called before saving the interface to make sure that it is consistent and will be correctly persisted.
void	setCheckNotNullIndicator(java.lang.String pTargetColumnName, boolean pValue) Defines the Check Not Null indicator value for the given column name.
void	setCKM(OdiCKM pCkm) Sets the CKM on the target datastore.
void	setCKM(OdiCKM pCkm, java.util.Map<java.lang.String,java.lang.Object> pOptions) Sets the CKM on the target datastore with custom option values.
void	setIKM(OdiIKM pIkm) Sets the IKM on the staging area.
void	setIKM(OdiIKM pIkm, java.util.Map<java.lang.String,java.lang.Object> pOptions) Sets the IKM on the staging area with custom option values.
void	setInsertIndicator(java.lang.String pTargetColumnName, boolean pValue) Defines the Insert indicator value for the given column name.
void	setJournalizedSourceDataStore(OdiDataStore pDataStore) Sets the source datastore for this interface as a journalized datastore with the default filter text.
void	setJournalizedSourceDataStore(OdiDataStore pDataStore, java.lang.String pJournalizationFilterSQL) Sets the source datastore for this interface as a journalized datastore with a customized filter expression.
void	setJournalizedSourceDataStore(OdiDataStore pDataStore, java.lang.String pJournalizationFilterSQL, java.lang.String pAlias) Sets the source datastore for this interface as a journalized datastore with a customized filter expression.
void	setLKM(OdiLKM pLkm) Sets the LKM if needed on the source set.
void	setLKM(OdiLKM pLkm, java.util.Map<java.lang.String,java.lang.Object> pOptions) Sets the LKM if needed on the source set with custom option values.
void	setSourceDataStore(OdiDataStore pDataStore) Sets the non-journalized datastore of the interface.
void	setSourceDataStore(OdiDataStore pDataStore, java.lang.String pAlias) Sets the non-journalized datastore of the interface with alias.
void	setSourceFilter(java.lang.String pString) Sets the source filter of this interface.
void	setTargetDataStore(OdiDataStore pTargetDatastore, java.util.Set<MappingDefinition> pMappingDefinitions) Sets the target datastore and mappings.
void	setUpdateIndicator(java.lang.String pTargetColumnName, boolean pValue) Defines the Update indicator value for the given column name.
void	setUpdateKeyIndicator(java.lang.String pTargetColumnName, boolean pValue) Defines the Update Key indicator value for the given column name.
void	setUserDefinedIndicator1(java.lang.String pColumnName, boolean pValue) Defines the UD1 indicator for the given column name.
void	setUserDefinedIndicator2(java.lang.String pColumnName, boolean pValue) Defines the UD2 indicator for the given column name.
void	setUserDefinedIndicator3(java.lang.String pColumnName, boolean pValue) Defines the UD3 indicator for the given column name.
void	setUserDefinedIndicator4(java.lang.String pColumnName, boolean pValue) Defines the UD4 indicator for the given column name.
void	setUserDefinedIndicator5(java.lang.String pColumnName, boolean pValue) Defines the UD5 indicator for the given column name.

Method Detail

prepareSave

void prepareSave()
                 throws OdiInterfaceNotReadyForPersistException

This method should be called before saving the interface to make sure that it is consistent and will be correctly persisted.

Throws:

OdiInterfaceNotReadyForPersistException - if the interface cannot be saved

setCheckNotNullIndicator

void setCheckNotNullIndicator(java.lang.String pTargetColumnName,
                              boolean pValue)

Defines the Check Not Null indicator value for the given column name.

Parameters:

pTargetColumnName - The target column name.

pValue - true to set the Check Not Null indicator of this column, false otherwise.

setCKM

void setCKM(OdiCKM pCkm)
            throws TargetIsTemporaryException

Sets the CKM on the target datastore.

Parameters:

pCkm - The CKM to be used for the target datastore.

Throws:

TargetIsTemporaryException - if the target datastore is temporary.

setCKM

void setCKM(OdiCKM pCkm,
            java.util.Map<java.lang.String,java.lang.Object> pOptions)
            throws TargetIsTemporaryException

Sets the CKM on the target datastore with custom option values.

Parameters:

pCkm - The CKM to be used for the target datastore.

pOptions - A map of where the option value is a Boolean if the option is a checkbox, or a String if the option is a text value.

Throws:

TargetIsTemporaryException - if the target datastore is temporary.

setIKM

void setIKM(OdiIKM pIkm)

Sets the IKM on the staging area.

Parameters:

pIkm - The IKM to be used on the staging area.

setIKM

void setIKM(OdiIKM pIkm,
            java.util.Map<java.lang.String,java.lang.Object> pOptions)

Sets the IKM on the staging area with custom option values.

Parameters:

pIkm - The IKM to be used on the staging area.

pOptions - A map of where the option value is a Boolean if the option is a checkbox, or a String if the option is a text value.

setInsertIndicator

void setInsertIndicator(java.lang.String pTargetColumnName,
                        boolean pValue)

Defines the Insert indicator value for the given column name.

Parameters:

pTargetColumnName - The target column name.

pValue - true to set the Insert indicator of this column, false otherwise.

setJournalizedSourceDataStore

void setJournalizedSourceDataStore(OdiDataStore pDataStore)

Sets the source datastore for this interface as a journalized datastore with the default filter text.

Parameters:

pDataStore - The journalized source datastore of the interface.

setJournalizedSourceDataStore

void setJournalizedSourceDataStore(OdiDataStore pDataStore,
                                   java.lang.String pJournalizationFilterSQL)

Sets the source datastore for this interface as a journalized datastore with a customized filter expression.

Parameters:

pDataStore - The journalized source datastore of the interface.

pJournalizationFilterSQL - The custom journalized filter expression.

setJournalizedSourceDataStore

void setJournalizedSourceDataStore(OdiDataStore pDataStore,
                                   java.lang.String pJournalizationFilterSQL,
                                   java.lang.String pAlias)

Sets the source datastore for this interface as a journalized datastore with a customized filter expression.

Parameters:

pDataStore - The journalized source datastore of the interface.

pJournalizationFilterSQL - The custom journalized filter expression.

pAlias - The alias used for the source datastore.

setLKM

void setLKM(OdiLKM pLkm)
            throws NoSourceSetException

Sets the LKM if needed on the source set.

Parameters:

pLkm - The LKM to be used for the source set.

Throws:

NoSourceSetException - if there is no source set on this interface.

setLKM

void setLKM(OdiLKM pLkm,
            java.util.Map<java.lang.String,java.lang.Object> pOptions)
            throws NoSourceSetException

Sets the LKM if needed on the source set with custom option values.

Parameters:

pLkm - The LKM to use used for the source set.

pOptions - A map of where the option value is a Boolean if the option is a checkbox, or a String if the option is a text value.

Throws:

NoSourceSetException - if there is no source set on this interface.

setSourceDataStore

void setSourceDataStore(OdiDataStore pDataStore)

Sets the non-journalized datastore of the interface.

Parameters:

pDataStore - The source datastore of the interface.

setSourceDataStore

void setSourceDataStore(OdiDataStore pDataStore,
                        java.lang.String pAlias)

Sets the non-journalized datastore of the interface with alias.

Parameters:

pDataStore - The source datastore of the interface.

pAlias - The alias used for the source datastore.

setSourceFilter

void setSourceFilter(java.lang.String pString)

Sets the source filter of this interface. This source filter will be executed on the same connection than the source datastore. A source datastore must have be set before invoking this method.

Parameters:

pString - The expression text for the source filter.

setTargetDataStore

void setTargetDataStore(OdiDataStore pTargetDatastore,
                        java.util.Set<MappingDefinition> pMappingDefinitions)

Sets the target datastore and mappings.

Parameters:

pTargetDatastore - The target datastore of the interface.

pMappingDefinitions - A set of MappingDefinition describing the desired mappings.

setUpdateIndicator

void setUpdateIndicator(java.lang.String pTargetColumnName,
                        boolean pValue)

Defines the Update indicator value for the given column name.

Parameters:

pTargetColumnName - The target column name.

pValue - true to set the Update indicator of this column, false otherwise.

setUpdateKeyIndicator

void setUpdateKeyIndicator(java.lang.String pTargetColumnName,
                           boolean pValue)

Defines the Update Key indicator value for the given column name.

Parameters:

pTargetColumnName - The target column name.

pValue - true to set the Update Key indicator of this column, false otherwise.

setUserDefinedIndicator1

void setUserDefinedIndicator1(java.lang.String pColumnName,
                              boolean pValue)

Defines the UD1 indicator for the given column name.

Parameters:

pColumnName - The column name.

pValue - true to use this column as UD1, false otherwise.

setUserDefinedIndicator2

void setUserDefinedIndicator2(java.lang.String pColumnName,
                              boolean pValue)

Defines the UD2 indicator for the given column name.

Parameters:

pColumnName - The column name.

pValue - true to use this column as UD2, false otherwise.

setUserDefinedIndicator3

void setUserDefinedIndicator3(java.lang.String pColumnName,
                              boolean pValue)

Defines the UD3 indicator for the given column name.

Parameters:

pColumnName - The column name.

pValue - true to use this column as UD3, false otherwise.

setUserDefinedIndicator4

void setUserDefinedIndicator4(java.lang.String pColumnName,
                              boolean pValue)

Defines the UD4 indicator for the given column name.

Parameters:

pColumnName - The column name.

pValue - true to use this column as UD4, false otherwise.

setUserDefinedIndicator5

void setUserDefinedIndicator5(java.lang.String pColumnName,
                              boolean pValue)

Defines the UD5 indicator for the given column name.

Parameters:

pColumnName - The column name.

pValue - true to use this column as UD5, false otherwise.