oracle.odi.domain.model

Class OdiModel

java.lang.Object

oracle.odi.domain.support.BusinessObject

oracle.odi.domain.support.AbstractRepositoryEntity

oracle.odi.domain.support.AbstractOdiEntity

oracle.odi.domain.model.OdiModel

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, oracle.odi.core.audit.support.IAuditableFirstClassObject, IFlexFieldUser, IModelObject, IModelObjectBase, IModelObjectWithLocation, IProcedureUser, IModel, oracle.odi.domain.impexp.IExportable, IImportRoot, IOdiEntity, IRepositoryEntity, IWorkDevelopmentOdiEntity, oracle.odi.impexp.smartie.ISmartExportable

public class OdiModel
extends oracle.odi.domain.support.AbstractOdiEntity
implements IProcedureUser, IFlexFieldUser, IWorkDevelopmentOdiEntity, oracle.odi.domain.impexp.IExportable, IImportRoot, oracle.odi.impexp.smartie.ISmartExportable, IModel, oracle.odi.core.audit.support.IAuditableFirstClassObject

An OdiModel represents a set of datastores corresponding to data structures contained in a physical schema.

Models can be organized into model folders.

Note that access to the datastores is not direct. The datastores are actually contained in the OdiSubModel object. An OdiModel may contain many sub models, but will always contain one global sub model.

The UI presents the following hierarchy:
model1
---datastore1
---datastore2
---submodel2
------datastore2
Access to datastore 1 and datastore2 would be:
Collection<OdiDataStore> dataStores = model1.getGlobalSubModel().getDataStores();

Since:

11.1.1.3.0

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OdiModel.ReverseObjectType Defines the object type to be reverse engineered.
static class	OdiModel.ReverseType Defines the type of reverse engineering.

Field Summary

Fields

Modifier and Type	Field and Description
static int	CODE_MAX_LENGTH The maximum length of an OdiModel's code.
static int	NAME_MAX_LENGTH The maximum length of an OdiModel's name.

Fields inherited from class oracle.odi.domain.support.AbstractOdiEntity

STARTING_INTERNAL_VERSION

Constructor Summary

Constructors

Constructor and Description
OdiModel(OdiLogicalSchema pLogicalSchema, java.lang.String pName, java.lang.String pCode) Constructor that sets the logical schema, name and the code.

Method Summary

Modifier and Type	Method and Description
void	addSubModel(OdiSubModel pSubModel) Add the given sub model to the collection of sub models owned by this OdiModel instance.
OdiCKM	getCKM() Gets the Control knowledge module associated to this OdiModel instance.
java.util.List	getCKMOptions() Return the control knowledge module's options.
java.lang.String	getCode() Return the code of this OdiModel instance.
OdiLogicalSchema	getDataServiceContainer() Get the logical schema referencing the data service.
java.lang.String	getDataServiceDataSourceName() Get the name of the data source that you defined in the data server, and that corresponds to the server containing your model's data.
java.lang.String	getDataServiceName() Get the name of the data service that is providing the (CDC related) features at model level.
java.lang.String	getDataServiceNamespace() Get the namespace for your web services.
java.lang.String	getDataServicePackageName() Get the Name of the Java package generated to contain all the web services.
java.util.Collection	getDataStores()
OdiFolder	getDefaultFolder() Returns the default folder of this OdiModel instance.
java.lang.String	getDescription() Returns the description of this OdiModel instance.
OdiLogicalSchema	getExtractProcess() Method returns Oracle Golden Gate's extract process set as the extract process for the model.
java.util.Collection	getFlexFieldsValues() Obtains flex fields values related to this IFlexFieldUser.
OdiGlobalSubModel	getGlobalSubModel() Returns the global sub-model of this OdiModel instance.
OdiLogicalSchema	getInitialLoadExtractProcess() Method returns Oracle Golden Gate's extract process set as the initial load extract process for the model.
OdiLogicalSchema	getInitialLoadReplicatProcess() Method returns Oracle Golden Gate's replicat process set as the initial load replicat process for the model.
java.lang.Number	getInstanceId() Return the internal identifier of the instance that is marked by this interface.
java.io.Serializable	getInternalId() Return the internal id of the module.
OdiJKM	getJKM() Returns the journalization knowledge module associated to this OdiModel instance.
java.util.List	getJKMOptions() Return the journalization knowledge module's options.
OdiLogicalSchema	getLogicalSchema() Returns the logical schema associated to this OdiModel instance.
java.lang.Number	getModelId() Returns the internal identifier of this OdiModel instance.
java.lang.String	getName() Returns the name of this entity instance.
OdiModelFolder	getParentModelFolder() Returns the parent model folder of this OdiModel instance.
IReleaseTag	getReleaseTag() Get the IReleaseTag object.
OdiLogicalSchema	getReplicatProcess() Method returns Oracle Golden Gate's replicat process set as the replicat process for the model.
OdiLogicalAgent	getReverseAgent() Get the logical agent to be used during customized reverse of this OdiModel instance.
int	getReverseAliasLength() Get the reverse alias length for this OdiModel instance.
java.lang.String	getReverseAliasTrim() Get the reverse alias trim for this OdiModel instance.
OdiContext	getReverseContext() Returns the reverse engineering context associated to this OdiModel instance.
java.lang.String	getReverseObjectMask() Get the reverse alias object mask for this OdiModel instance.
java.util.Collection	getReverseObjectTypes() Get the reverse object types for this OdiModel instance.
OdiModel.ReverseType	getReverseType() Get the reverse type of this OdiModel instance.
OdiRKM	getRKM() Returns the Reverse Knowledge Module associated to this OdiModel instance.
java.util.List	getRKMOptions() Return the reverse knowledge module's options.
OdiSKM	getSKM() Returns the service knowledge module associated to this OdiModel instance.
java.util.Collection	getSubModels() Obtains the unmodifiable collection of all OdiSubModels contained by this OdiModel instance.
OdiTechnology	getTechnology() Returns the technology associated to this OdiModel instance.
void	initFlexFields(IOdiFlexFieldFinder pOdiFlexFieldFinder) Initialize flex fields related to this IFlexFieldUser.
boolean	isActualMetadataChangeDisplayRequired() Returns whether this OdiModel instance is required to be displayed with actual meta data changes in underlying schema, or not.
boolean	isConsistantJournalize() Returns whether this OdiModel instance uses consistent journalization or not.
boolean	isInstanceLevelSecurityNeeded() Internal: this method is for internal purpose and must not be considered as part of the public API.
void	removeSubModel(OdiSubModel pSubModel) Remove the given sub model from the collection of sub models.
void	setActualMetadataChangeDisplayRequired(boolean pActualMetadataChangeDisplayRequired) Set whether this OdiModel instance is required to be displayed with actual meta data change in underlying schema, or not.
void	setCKM(OdiCKM pCKM) Sets the control Knowledge module associated to this OdiModel instance.
void	setDataServiceContainer(OdiLogicalSchema pDataServiceContainer) Set the logical schema referencing the data service.
void	setDataServiceDataSourceName(java.lang.String pDataServiceDataSourceName) Set the name of the data source that you defined in the data server, and that corresponds to the server containing your model's data.
void	setDataServiceName(java.lang.String pDataServiceName) Name of the data service that is providing the (CDC related) features at model level.
void	setDataServiceNamespace(java.lang.String pDataServiceNamespace) Set the namespace for your web services.
void	setDataServicePackageName(java.lang.String pDataServicePackageName) Set the Name of the Java package generated to contain all the web services.
void	setDefaultFolder(OdiFolder pDefaultFolder) Sets the default OdiFolder of this OdiModel instance.
void	setDescription(java.lang.String pDescription) Sets the description of this OdiModel instance.
void	setExtractProcess(OdiLogicalSchema pExtractProcess) Method sets Oracle Golden Gate's extract process as the extract process for the model.
void	setInitialLoadExtractProcess(OdiLogicalSchema pInitialLoadExtractProcess) Method sets Oracle Golden Gate's extract process as the extract process for the model.
void	setInitialLoadReplicatProcess(OdiLogicalSchema pInitialLoadReplicatProcess) Method sets Oracle Golden Gate's replicat process as the initial load replicat process for the model.
void	setJKM(OdiJKM pJKM) Sets the journalization knowledge module associated to this OdiModel instance.
void	setLogicalSchema(OdiLogicalSchema pLogicalSchema) Sets the OdiLogicalSchema and the OdiTechnology of this OdiModel instance.
void	setName(java.lang.String pName) Sets the name of this OdiModel instance.
void	setReleaseTag(IReleaseTag pReleaseTag) Set the IReleaseTag object.
void	setReplicatProcess(OdiLogicalSchema pReplicatProcess) Method sets Oracle Golden Gate's replicat process as the replicat process for the model.
void	setReverseAgent(OdiLogicalAgent pLogicalAgent) Set the logical agent that should be used to execute customized reverse engineering of this OdiModel instance.
void	setReverseAliasLength(int pReverseAliasLength) Set the reverse alias length for this OdiModel instance.
void	setReverseAliasTrim(java.lang.String pReverseAliasTrim) Set the reverse alias trim for this OdiModel instance.
void	setReverseContext(OdiContext pContext) Sets the OdiContext that will be used during reverse engineering.
void	setReverseObjectMask(java.lang.String pReverseObjectMask) Set the reverse object mask for this OdiModel instance.
void	setReverseObjectTypes(java.util.Collection pReverseObjectTypes) Set the reverse object types for this OdiModel instance.
void	setReverseType(OdiModel.ReverseType pReverseType) Set the reverse type to be applied to this OdiModel instance.
void	setRKM(OdiRKM pRKM) Sets the Reverse Knowledge Module to be associated to this OdiModel instance.
void	setSKM(OdiSKM pSKM) Sets the service knowledge module associated to this OdiModel instance.
boolean	supportsImport(java.lang.Class pChildClass) Returns whether the given entity type is supported to be imported into that root import object.

Methods inherited from class oracle.odi.domain.support.AbstractOdiEntity

getFirstDate, getFirstUser, getInternalVersion, getLastDate, getLastUser, isNew, preCommit, toString

Methods inherited from class oracle.odi.domain.support.AbstractRepositoryEntity

equals, getBigNumericId, getGlobalId, getNumericId, getParent, hashCode

Methods inherited from class oracle.odi.domain.support.BusinessObject

clone

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface oracle.odi.domain.IOdiEntity

getFirstDate, getFirstUser, getLastDate, getLastUser

Methods inherited from interface oracle.odi.domain.IRepositoryEntity

getGlobalId, getParent

Methods inherited from interface oracle.odi.domain.adapter.IModelObjectBase

getBigNumericId, getGlobalId, getNumericId

Field Detail

NAME_MAX_LENGTH

public static final int NAME_MAX_LENGTH

The maximum length of an OdiModel's name.

See Also:

Constant Field Values

CODE_MAX_LENGTH

public static final int CODE_MAX_LENGTH

The maximum length of an OdiModel's code.

See Also:

Constant Field Values

Constructor Detail

OdiModel

public OdiModel(OdiLogicalSchema pLogicalSchema,
                java.lang.String pName,
                java.lang.String pCode)

Constructor that sets the logical schema, name and the code.

Parameters:

pLogicalSchema - logical schema for model

pName - name of model

pCode - unique code of model

Throws:

DomainRuntimeException - if the logical schema is null
or if the name is null, empty or longer than 400,
or if the code is null, empty, longer than 35, contains whitespaces or is not totally uppercase.

Method Detail

getCKM

public OdiCKM getCKM()

Gets the Control knowledge module associated to this OdiModel instance.

Use a CKM to perform a static control.

The static control determines if all the data in a model meets the integrity constraints defined on the datastores. These constraints include references, primary keys, alternate keys, conditions and mandatory columns. Specifying the appropriate Check Knowledge Module (CKM) is mandatory in order to perform the control.

Returns:

the Control Knowledge module associated to this model

See Also:

OdiCKM, setCKM(OdiCKM)

setCKM

public void setCKM(OdiCKM pCKM)

Sets the control Knowledge module associated to this OdiModel instance.

Use a CKM to perform a static control.

The static control determines if all the data in a model meets the integrity constraints defined on the datastores. These constraints include references, primary keys, alternate keys, conditions and mandatory columns. Specifying the appropriate Check Knowledge Module (CKM) is mandatory in order to perform the control.

Parameters:

pCKM - the CKM to set or null

See Also:

OdiCKM, getCKM()

getCKMOptions

public java.util.List getCKMOptions()

Return the control knowledge module's options.

CKM Options are parameters specified by the CKM. The default values of the parameters can be changed by a user.

Returns:

control knowledge module's options

Throws:

DomainRuntimeException - if no CKM is defined for this model

See Also:

OdiCKM, setCKM(OdiCKM), getCKM(), IOptionValue

setJKM

public void setJKM(OdiJKM pJKM)

Sets the journalization knowledge module associated to this OdiModel instance.

The strategy used for data journalizing. Only a JKM that is valid for the technology of the model should be used. If pJKM.isConsistentJournalize() returns true, then the model method isConsistentJournalize will return true.

Parameters:

pJKM - the JKM to set or null

See Also:

OdiJKM, isConsistantJournalize(), getJKM()

getJKM

public OdiJKM getJKM()

Returns the journalization knowledge module associated to this OdiModel instance.

The OdiJKM is the strategy used for data journalizing.

Returns:

journalization knowledge module associated to this model

See Also:

OdiJKM, setJKM(OdiJKM)

getJKMOptions

public java.util.List getJKMOptions()

Return the journalization knowledge module's options.

JKM Options are parameters specified by the JKM. The default values of the parameters can be changed by a user.

Returns:

journalization knowledge module's options

Throws:

DomainRuntimeException - if no JKM is defined for this model

See Also:

OdiJKM, setJKM(OdiJKM), getJKM(), IOptionValue

setRKM

public void setRKM(OdiRKM pRKM)

Sets the Reverse Knowledge Module to be associated to this OdiModel instance.

Customized reverse-engineering uses a procedure, the Reverse Knowledge Module (RKM), to extract the metadata for a specific type of application, and to store it in the Repository.

Valid only in CUSTOMIZED reverse mode.

Parameters:

pRKM - the RKM to set or null

Throws:

java.lang.IllegalStateException - if the model is not in CUSTOMIZED ReverseType Mode

See Also:

OdiRKM, getRKM()

getRKM

public OdiRKM getRKM()

Returns the Reverse Knowledge Module associated to this OdiModel instance.

Customized reverse-engineering uses a procedure, the Reverse Knowledge Module (RKM), to extract the metadata for a specific type of application, and to store it in the Repository.

Returns:

the Reverse Knowledge Module associated to this model

See Also:

OdiRKM, setRKM(OdiRKM)

getRKMOptions

public java.util.List getRKMOptions()

Return the reverse knowledge module's options.

RKM Options are parameters specified by the RKM. The default values of the parameters can be changed by a user.

Returns:

reverse engineering knowledge module's options

Throws:

DomainRuntimeException - if no JKM is defined for this model

See Also:

OdiRKM, setRKM(OdiRKM), getRKM(), IOptionValue

setSKM

public void setSKM(OdiSKM pSKM)

Sets the service knowledge module associated to this OdiModel instance.

The service knowledge module is used to generate the web service.

Parameters:

pSKM - the SKM to set or null

See Also:

OdiSKM, getSKM()

getSKM

public OdiSKM getSKM()

Returns the service knowledge module associated to this OdiModel instance.

The service knowledge module is used to generate the web service.

Returns:

the service knowledge module associated to this model

See Also:

OdiSKM, setSKM(OdiSKM)

setReverseContext

public void setReverseContext(OdiContext pContext)

Sets the OdiContext that will be used during reverse engineering.

The context in which the reverse is executed.
The combination of the context and the logical schema allows Oracle Data Integrator to connect to the required data server to access the metadata.

Parameters:

pContext - the context to set or null

See Also:

getReverseContext()

getReverseContext

public OdiContext getReverseContext()

Returns the reverse engineering context associated to this OdiModel instance.

The context in which the reverse is executed.
The combination of the context and the logical schema allows Oracle Data Integrator to connect to the required data server to access the metadata.

Returns:

the reverse engineering context associated to this model

See Also:

setReverseContext(OdiContext)

getInternalId

public java.io.Serializable getInternalId()

Return the internal id of the module.

Specified by:

getInternalId in interface IRepositoryEntity

Returns:

the persistence identity of this instance

See Also:

getModelId()

getGlobalSubModel

public OdiGlobalSubModel getGlobalSubModel()

Returns the global sub-model of this OdiModel instance. It is never null.

The global sub model object controls access to the datastores associated with this model.

Returns:

an OdiGlobalSubModel object for this model. Should never be null.

getSubModels

public java.util.Collection getSubModels()

Obtains the unmodifiable collection of all OdiSubModels contained by this OdiModel instance.

Even sub-models contained inside other sub-models are returned.
Use removeSubModel(OdiSubModel) and addSubModel(OdiSubModel) to respectively add and remove sub models.

Specified by:

getSubModels in interface IModel

Returns:

a Collection object representing the sub models value

See Also:

addSubModel(OdiSubModel), removeSubModel(OdiSubModel)

addSubModel

public void addSubModel(OdiSubModel pSubModel)

Add the given sub model to the collection of sub models owned by this OdiModel instance.

This will also set the model of the given sub model to this OdiModel instance.

Parameters:

pSubModel - an OdiSubModel object to add

Throws:

DomainRuntimeException - if pSubModel is null or if pSubModel is already owned by a different OdiModel instance

removeSubModel

public void removeSubModel(OdiSubModel pSubModel)

Remove the given sub model from the collection of sub models.

This will also reset the OdiModel of the given sub model to null.

Note: IOdiEntityManager.remove(pSubModel) must also be called in order to remove the sub model from the repository

Parameters:

pSubModel - an OdiSubModel object

Throws:

DomainRuntimeException - if pSubModel is null or does not belong to this OdiModel

getDescription

public java.lang.String getDescription()

Returns the description of this OdiModel instance.

Returns:

a String representing the description value

See Also:

setDescription(String)

setDescription

public void setDescription(java.lang.String pDescription)

Sets the description of this OdiModel instance.

Parameters:

pDescription - a String specifying the description value

See Also:

getDescription()

getName

public java.lang.String getName()

Description copied from interface: IOdiEntity

Returns the name of this entity instance.

Specified by:

getName in interface IFlexFieldUser

Specified by:

getName in interface IModelObject

Specified by:

getName in interface IOdiEntity

Overrides:

getName in class oracle.odi.domain.support.AbstractOdiEntity

Returns:

the name

setName

public void setName(java.lang.String pName)

Sets the name of this OdiModel instance.

Parameters:

pName - name

Throws:

DomainRuntimeException - if the name is null, empty or longer than 400

See Also:

getName()

getCode

public java.lang.String getCode()

Return the code of this OdiModel instance.

Code is a Unique code for this model.

Returns:

the code of this model

getLogicalSchema

public OdiLogicalSchema getLogicalSchema()

Returns the logical schema associated to this OdiModel instance.

Represents the logical schema of the topology to which this model is attached.

Returns:

an OdiLogicalSchema object

See Also:

OdiLogicalSchema

getModelId

public java.lang.Number getModelId()

Returns the internal identifier of this OdiModel instance.

Returns:

a Number object representing the id of this model

getTechnology

public OdiTechnology getTechnology()

Returns the technology associated to this OdiModel instance.

Represents the technology of the data model.
As a data model is linked to a single technology, it is a physical data model whose datatypes are native to this technology.

Returns:

the OdiTechnology object associated to this model

See Also:

OdiTechnology

isInstanceLevelSecurityNeeded

public boolean isInstanceLevelSecurityNeeded()

Description copied from interface: IOdiEntity

Internal: this method is for internal purpose and must not be considered as part of the public API.

Defines a method to capture the info on which object needs instance level privilege.

Specified by:

isInstanceLevelSecurityNeeded in interface IOdiEntity

Overrides:

isInstanceLevelSecurityNeeded in class oracle.odi.domain.support.AbstractOdiEntity

Returns:

true if instance level security needed, false otherwise

getParentModelFolder

public OdiModelFolder getParentModelFolder()

Returns the parent model folder of this OdiModel instance.

Null value means that this model is not under a model folder.

Returns:

an OdiModelFolder object representing the parent model folder value

See Also:

OdiModelFolder, setParentModelFolder(OdiModelFolder)

setLogicalSchema

public void setLogicalSchema(OdiLogicalSchema pLogicalSchema)

Sets the OdiLogicalSchema and the OdiTechnology of this OdiModel instance.

Parameters:

pLogicalSchema - the logical schema

Throws:

DomainRuntimeException - if the logical schema is null

getDefaultFolder

public OdiFolder getDefaultFolder()

Returns the default folder of this OdiModel instance.

Returns:

an OdiFolder object representing the default folder of this model

setDefaultFolder

public void setDefaultFolder(OdiFolder pDefaultFolder)

Sets the default OdiFolder of this OdiModel instance.

Parameters:

pDefaultFolder -

isConsistantJournalize

public boolean isConsistantJournalize()

Returns whether this OdiModel instance uses consistent journalization or not.

This method returns whether the defined JKM is for simple or consistent CDC. Returns false of no JKM is set or JKM is defined as a simple JKM.

Returns:

true if this OdiModel use consistent CDC, false otherwise.

See Also:

setJKM(OdiJKM)

getFlexFieldsValues

public java.util.Collection getFlexFieldsValues()

Description copied from interface: IFlexFieldUser

Obtains flex fields values related to this IFlexFieldUser. In most implementations method IFlexFieldUser.initFlexFields(IOdiFlexFieldFinder) should be called before calling this method.

Specified by:

getFlexFieldsValues in interface IFlexFieldUser

Returns:

an unmodifiable Collection of flex field values

initFlexFields

public void initFlexFields(IOdiFlexFieldFinder pOdiFlexFieldFinder)

Description copied from interface: IFlexFieldUser

Initialize flex fields related to this IFlexFieldUser.

Specified by:

initFlexFields in interface IFlexFieldUser

Parameters:

pOdiFlexFieldFinder - OdiFlexField finder to be used to query flex fields

supportsImport

public boolean supportsImport(java.lang.Class pChildClass)

Description copied from interface: IImportRoot

Returns whether the given entity type is supported to be imported into that root import object.

Specified by:

supportsImport in interface IImportRoot

Parameters:

pChildClass - the class of object to be imported into this one

Returns:

true if the given type could be imported, false otherwise

getInstanceId

public java.lang.Number getInstanceId()

Description copied from interface: IProcedureUser

Return the internal identifier of the instance that is marked by this interface. (e.g. OdiModel implementation of that method return the modelId).

Specified by:

getInstanceId in interface IProcedureUser

Returns:

the ODI instance id.

setReverseType

public void setReverseType(OdiModel.ReverseType pReverseType)

Set the reverse type to be applied to this OdiModel instance.

OdiModel.ReverseType.STANDARD reverse-engineering uses the capacities of the driver (JDBC, ODBC, and so forth) to retrieve the metadata and store it in the repository.
OdiModel.ReverseType.CUSTOMIZED reverse-engineering uses a procedure, the Reverse Knowledge Module (RKM), to extract the metadata for a specific type of application, and to store it in the Repository.
By default, is set to OdiModel.ReverseType.STANDARD.

Parameters:

pReverseType - reverse type to be applied.

Throws:

DomainRuntimeException - if given reverse type is null

See Also:

getReverseType()

getReverseType

public OdiModel.ReverseType getReverseType()

Get the reverse type of this OdiModel instance.

OdiModel.ReverseType.STANDARD reverse-engineering uses the capacities of the driver (JDBC, ODBC, and so forth) to retrieve the metadata and store it in the repository.
OdiModel.ReverseType.CUSTOMIZED reverse-engineering uses a procedure, the Reverse Knowledge Module (RKM), to extract the metadata for a specific type of application, and to store it in the Repository.

Returns:

a ReverseType object representing the reverse type value

See Also:

setReverseType(ReverseType)

setReverseObjectTypes

public void setReverseObjectTypes(java.util.Collection pReverseObjectTypes)

Set the reverse object types for this OdiModel instance.

This represents the types of the objects that should be taken into account by the reverse-engineering process. This list may include tables, views, queues, system tables, table aliases and synonyms. All object types in the collection will be reverse engineered.

By default is set to OdiModel.ReverseObjectType.TABLE.

Parameters:

pReverseObjectTypes - a collection of ReverseObjectType to be reverse engineered.

Throws:

DomainRuntimeException - if given collection is null

See Also:

OdiModel.ReverseObjectType, getReverseObjectTypes()

getReverseObjectTypes

public java.util.Collection getReverseObjectTypes()

Get the reverse object types for this OdiModel instance.

This represents the types of the objects that should be taken into account by the reverse-engineering process. This list may include tables, views, queues, system tables, table aliases and synonyms. All object types in the collection will be reverse engineered.

Returns:

unmodifiable collection of OdiModel.ReverseObjectType.

See Also:

setReverseObjectTypes(Collection)

setReverseAliasLength

public void setReverseAliasLength(int pReverseAliasLength)

Set the reverse alias length for this OdiModel instance.

This is the maximum length of a generated alias for this model. Characters after this length are truncated.

By default is '35'.

Note: used only in OdiModel.ReverseType.STANDARD reverse mode.

Parameters:

pReverseAliasLength - reverse maximum alias length

See Also:

getReverseAliasLength()

getReverseAliasLength

public int getReverseAliasLength()

Get the reverse alias length for this OdiModel instance.

Used only in OdiModel.ReverseType.STANDARD reverse mode.

Returns:

reverse maximum alias length

See Also:

setReverseAliasLength(int)

setReverseObjectMask

public void setReverseObjectMask(java.lang.String pReverseObjectMask)

Set the reverse object mask for this OdiModel instance.

The mask pre-selects the objects to reverse. This mask uses the LIKE syntax of the SQL language, that is: the % symbol stands for zero or more characters, and the _ symbol stands for one character.

By default is set to '%'.

Parameters:

pReverseObjectMask - reverse object mask

See Also:

getReverseObjectMask()

getReverseObjectMask

public java.lang.String getReverseObjectMask()

Get the reverse alias object mask for this OdiModel instance.

The mask pre-selects the objects to reverse. This mask uses the LIKE syntax of the SQL language, that is: the % symbol stands for zero or more characters, and the _ symbol stands for one character.

Returns:

a String representing the reverse object mask value

See Also:

setReverseObjectMask(String)

setReverseAliasTrim

public void setReverseAliasTrim(java.lang.String pReverseAliasTrim)

Set the reverse alias trim for this OdiModel instance.

These are the characters to delete in order to derive data store aliases. For example, the value 'DWG_' allows you to derive the aliases PRO, CUS, ITE for the tables named DWG_PROD, DWG_CUS, DW_ITEM

Parameters:

pReverseAliasTrim - the reverse alias trim

See Also:

getReverseAliasTrim()

getReverseAliasTrim

public java.lang.String getReverseAliasTrim()

Get the reverse alias trim for this OdiModel instance.

These are the characters to delete in order to derive data store aliases. For example, the value 'DWG_' allows you to derive the aliases PRO, CUS, ITE for the tables named DWG_PROD, DWG_CUS, DW_ITEM

Returns:

a String representing the reverse alias trim value

See Also:

setReverseAliasTrim(String)

setReverseAgent

public void setReverseAgent(OdiLogicalAgent pLogicalAgent)

Set the logical agent that should be used to execute customized reverse engineering of this OdiModel instance.

Parameters:

pLogicalAgent - the logical agent, or null if none

See Also:

getReverseAgent()

getReverseAgent

public OdiLogicalAgent getReverseAgent()

Get the logical agent to be used during customized reverse of this OdiModel instance.

Returns:

logical agent or null if none

See Also:

setReverseAgent(OdiLogicalAgent)

isActualMetadataChangeDisplayRequired

public boolean isActualMetadataChangeDisplayRequired()

Returns whether this OdiModel instance is required to be displayed with actual meta data changes in underlying schema, or not.

Returns:

true if changes are required to be displayed, false otherwise

setActualMetadataChangeDisplayRequired

public void setActualMetadataChangeDisplayRequired(boolean pActualMetadataChangeDisplayRequired)

Set whether this OdiModel instance is required to be displayed with actual meta data change in underlying schema, or not.

Parameters:

pActualMetadataChangeDisplayRequired - true to display changes, false otherwise

setDataServiceContainer

public void setDataServiceContainer(OdiLogicalSchema pDataServiceContainer)

Set the logical schema referencing the data service.

Represents the logical schema corresponding to the application server (web services container) into which the generated web services will be deployed.

Parameters:

pDataServiceContainer - data service container. This may be null.

Throws:

DomainRuntimeException - if pDataServiceContainer is not a data service container

See Also:

getDataServiceContainer()

getDataServiceContainer

public OdiLogicalSchema getDataServiceContainer()

Get the logical schema referencing the data service.

Represents the logical schema corresponding to the application server (web services container) into which the generated web services will be deployed.

Returns:

data service container (or null if none found)

See Also:

setDataServiceContainer(OdiLogicalSchema)

setDataServiceNamespace

public void setDataServiceNamespace(java.lang.String pDataServiceNamespace)

Set the namespace for your web services.

The namespace is used to generate the Web Services Description Language (WSDL).

Parameters:

pDataServiceNamespace - data service namespace. This may be null.

See Also:

getDataServiceNamespace()

getDataServiceNamespace

public java.lang.String getDataServiceNamespace()

Get the namespace for your web services.

The namespace is used to generate the Web Services Description Language (WSDL).

Returns:

data service namespace. This may be null.

See Also:

setDataServiceNamespace(String)

setDataServicePackageName

public void setDataServicePackageName(java.lang.String pDataServicePackageName)

Set the Name of the Java package generated to contain all the web services.

Generally, this is of the form com.(company name).(project name).

Parameters:

pDataServicePackageName - the Name of the Java package generated to contain all the web services. This may be null.

See Also:

getDataServicePackageName()

getDataServicePackageName

public java.lang.String getDataServicePackageName()

Get the Name of the Java package generated to contain all the web services.

Generally, this is of the form com.(company name).(project name).

Returns:

the Name of the Java package generated to contain all the web service. This may be null.

See Also:

setDataServicePackageName(String)

setDataServiceDataSourceName

public void setDataServiceDataSourceName(java.lang.String pDataServiceDataSourceName)

Set the name of the data source that you defined in the data server, and that corresponds to the server containing your model's data.

This name should be prefixed by java:/comp/env/.

Parameters:

pDataServiceDataSourceName - name of the data source that you defined in the data server

See Also:

getDataServiceDataSourceName()

getDataServiceDataSourceName

public java.lang.String getDataServiceDataSourceName()

Get the name of the data source that you defined in the data server, and that corresponds to the server containing your model's data.

Returns:

the name of the data source

See Also:

setDataServiceDataSourceName(String)

setDataServiceName

public void setDataServiceName(java.lang.String pDataServiceName)

Name of the data service that is providing the (CDC related) features at model level.

Parameters:

pDataServiceName - name of the data service (may be null)

See Also:

getDataServiceName()

getDataServiceName

public java.lang.String getDataServiceName()

Get the name of the data service that is providing the (CDC related) features at model level.

Returns:

name of the data service (may be null)

See Also:

setDataServiceName(String)

setReleaseTag

public void setReleaseTag(IReleaseTag pReleaseTag)

Set the IReleaseTag object.

The release tag associated models and folders participating in the same release. IReleaseTag.getValue() == null implies that the release tag is not set.

This will actually set the values of the the release tag. Passing in a null will set the value of this release tag to null.

Parameters:

pReleaseTag - release tag to be set

See Also:

getReleaseTag()

getReleaseTag

public IReleaseTag getReleaseTag()

Get the IReleaseTag object.

The release tag associated models and folders participating in the same release. IReleaseTag.getValue() == null implies that the release tag is not set.

Returns:

IReleaseTag release tag. The release tag will never be null. getValue() may be.

See Also:

setReleaseTag(oracle.odi.domain.IReleaseTag)

getExtractProcess

public OdiLogicalSchema getExtractProcess()

Method returns Oracle Golden Gate's extract process set as the extract process for the model. Applicable for models which has Oracle Golden Gate Online JKM set only.

Returns:

model's extract process

Throws:

DomainRuntimeException - if model's JKM is not OGG online JKM

setExtractProcess

public void setExtractProcess(OdiLogicalSchema pExtractProcess)

Method sets Oracle Golden Gate's extract process as the extract process for the model. Applicable for models which has Oracle Golden Gate Online JKM set only.

Parameters:

pExtractProcess - extract process to be set as the extract process for the model

Throws:

DomainRuntimeException - if pExtractProcess is not OGG extract process or if model's JKM is not OGG online JKM or if extract and initial load extract processes are the same

getReplicatProcess

public OdiLogicalSchema getReplicatProcess()

Method returns Oracle Golden Gate's replicat process set as the replicat process for the model. Applicable for models which has Oracle Golden Gate Online JKM set only.

Returns:

model's replicat process

Throws:

DomainRuntimeException - if model's JKM is not OGG online JKM

setReplicatProcess

public void setReplicatProcess(OdiLogicalSchema pReplicatProcess)

Method sets Oracle Golden Gate's replicat process as the replicat process for the model. Applicable for models which has Oracle Golden Gate Online JKM set only.

Parameters:

pReplicatProcess - replicat process to be set as the replicat process for the model

Throws:

DomainRuntimeException - if pReplicatProcess is not OGG replicat process or if model's JKM is not OGG online JKM or if replicat and initial load replicat processes are the same

getInitialLoadExtractProcess

public OdiLogicalSchema getInitialLoadExtractProcess()

Method returns Oracle Golden Gate's extract process set as the initial load extract process for the model. Applicable for models which has Oracle Golden Gate Online JKM set only.

Returns:

model's initial load extract process

Throws:

DomainRuntimeException - if model's JKM is not OGG online JKM

setInitialLoadExtractProcess

public void setInitialLoadExtractProcess(OdiLogicalSchema pInitialLoadExtractProcess)

Method sets Oracle Golden Gate's extract process as the extract process for the model. Applicable for models which has Oracle Golden Gate Online JKM set only.

Parameters:

pInitialLoadExtractProcess - extract process to be set as the initial load extract process for the model

Throws:

DomainRuntimeException - if pInitialLoadExtractProcess is not OGG extract process or if model's JKM is not OGG online JKM or if extract and initial load extract processes are the same

getInitialLoadReplicatProcess

public OdiLogicalSchema getInitialLoadReplicatProcess()

Method returns Oracle Golden Gate's replicat process set as the initial load replicat process for the model. Applicable for models which has Oracle Golden Gate Online JKM set only.

Returns:

model's initial load replicat process

Throws:

DomainRuntimeException - if model's JKM is not OGG online JKM

setInitialLoadReplicatProcess

public void setInitialLoadReplicatProcess(OdiLogicalSchema pInitialLoadReplicatProcess)

Method sets Oracle Golden Gate's replicat process as the initial load replicat process for the model. Applicable for models which has Oracle Golden Gate Online JKM set only.

Parameters:

pInitialLoadReplicatProcess - replicat process to be set as the initial load replicat process for the model

Throws:

DomainRuntimeException - if pInitialLoadReplicatProcess is not OGG replicat process or if model's JKM is not OGG online JKM or if replicat and initial load replicat processes are the same

getDataStores

public java.util.Collection getDataStores()

Specified by:

getDataStores in interface IModel