|
Oracle® Data Integrator Java API Reference 11g Release 1 (11.1.1.6.0) E17060-03 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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:
prepareSave()
must be called before saving the interface to make sure that it is consistent and can be correctly savedMethod 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 |
---|
void setSourceDataStore(OdiDataStore pDataStore)
pDataStore
- The source datastore of the interface.void setJournalizedSourceDataStore(OdiDataStore pDataStore)
pDataStore
- The journalized source datastore of the interface.void setJournalizedSourceDataStore(OdiDataStore pDataStore, java.lang.String pJournalizationFilterSQL)
pDataStore
- The journalized source datastore of the interface.pJournalizationFilterSQL
- The custom journalized filter expression.void setSourceDataStore(OdiDataStore pDataStore, java.lang.String pAlias)
pDataStore
- The source datastore of the interface.pAlias
- The alias used for the source datastore.void setJournalizedSourceDataStore(OdiDataStore pDataStore, java.lang.String pJournalizationFilterSQL, java.lang.String pAlias)
pDataStore
- The journalized source datastore of the interface.pJournalizationFilterSQL
- The custom journalized filter expression.pAlias
- The alias used for the source datastore.void setSourceFilter(java.lang.String pString)
pString
- The expression text for the source filter.void setTargetDataStore(OdiDataStore pTargetDatastore, java.util.Set<MappingDefinition> pMappingDefinitions)
pTargetDatastore
- The target datastore of the interface.pMappingDefinitions
- A set of MappingDefinition
describing the desired mappings.void setLKM(OdiLKM pLkm) throws NoSourceSetException
pLkm
- The LKM to be used for the source set.NoSourceSetException
- if there is no source set on this interface.void setLKM(OdiLKM pLkm, java.util.Map<java.lang.String,java.lang.Object> pOptions) throws NoSourceSetException
pLkm
- The LKM to use used for the source set.pOptions
- A map ofwhere the option value is a Boolean if the option is a checkbox, or a String if the option is a text value.
NoSourceSetException
- if there is no source set on this interface.void setIKM(OdiIKM pIkm)
pIkm
- The IKM to be used on the staging area.void setIKM(OdiIKM pIkm, java.util.Map<java.lang.String,java.lang.Object> pOptions)
pIkm
- The IKM to be used on the staging area.pOptions
- A map ofwhere the option value is a Boolean if the option is a checkbox, or a String if the option is a text value.
void setCKM(OdiCKM pCkm) throws TargetIsTemporaryException
pCkm
- The CKM to be used for the target datastore.TargetIsTemporaryException
- if the target datastore is temporary.void setCKM(OdiCKM pCkm, java.util.Map<java.lang.String,java.lang.Object> pOptions) throws TargetIsTemporaryException
pCkm
- The CKM to be used for the target datastore.pOptions
- A map ofwhere the option value is a Boolean if the option is a checkbox, or a String if the option is a text value.
TargetIsTemporaryException
- if the target datastore is temporary.void prepareSave() throws OdiInterfaceNotReadyForPersistException
OdiInterfaceNotReadyForPersistException
- if the interface cannot be savedvoid setUserDefinedIndicator1(java.lang.String pColumnName, boolean pValue)
pColumnName
- The column name.pValue
- true
to use this column as UD1, false
otherwise.void setUserDefinedIndicator2(java.lang.String pColumnName, boolean pValue)
pColumnName
- The column name.pValue
- true
to use this column as UD2, false
otherwise.void setUserDefinedIndicator3(java.lang.String pColumnName, boolean pValue)
pColumnName
- The column name.pValue
- true
to use this column as UD3, false
otherwise.void setUserDefinedIndicator4(java.lang.String pColumnName, boolean pValue)
pColumnName
- The column name.pValue
- true
to use this column as UD4, false
otherwise.void setUserDefinedIndicator5(java.lang.String pColumnName, boolean pValue)
pColumnName
- The column name.pValue
- true
to use this column as UD5, false
otherwise.void setCheckNotNullIndicator(java.lang.String pTargetColumnName, boolean pValue)
pTargetColumnName
- The target column name.pValue
- true
to set the Check Not Null indicator of this column, false
otherwise.void setInsertIndicator(java.lang.String pTargetColumnName, boolean pValue)
pTargetColumnName
- The target column name.pValue
- true
to set the Insert indicator of this column, false
otherwise.void setUpdateIndicator(java.lang.String pTargetColumnName, boolean pValue)
pTargetColumnName
- The target column name.pValue
- true
to set the Update indicator of this column, false
otherwise.void setUpdateKeyIndicator(java.lang.String pTargetColumnName, boolean pValue)
pTargetColumnName
- The target column name.pValue
- true
to set the Update Key indicator of this column, false
otherwise.
|
Oracle® Data Integrator Java API Reference 11g Release 1 (11.1.1.6.0) E17060-03 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |