|
Oracle® Data Integrator Java API Reference 11g Release 1 (11.1.1.3.0) E17060-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object oracle.odi.domain.support.BusinessObject oracle.odi.domain.support.AbstractRepositoryEntity oracle.odi.domain.support.AbstractOdiEntity oracle.odi.domain.model.OdiModel
public class OdiModel
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();
Nested Class Summary | |
---|---|
static class |
OdiModel.ReverseObjectType
Defines the object type to be reverse engineered. |
static class |
OdiModel.ReverseType
Defines the type of reverse engineering. |
Field Summary | |
---|---|
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 | |
---|---|
OdiModel(OdiLogicalSchema pLogicalSchema,
java.lang.String pName,
java.lang.String pCode)
Constructor that sets the logical schema, name and the code. |
Method Summary | |
---|---|
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<IOptionValue> |
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.lang.String |
getDescription()
Returns the description of this OdiModel instance. |
java.util.Collection<IFlexFieldValue> |
getFlexFieldsValues()
Obtains flex fields values related to this IFlexFieldUser . |
OdiGlobalSubModel |
getGlobalSubModel()
Returns the global sub-model of this OdiModel instance. |
java.lang.Number |
getInstanceId()
|
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<IOptionValue> |
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. |
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<OdiModel.ReverseObjectType> |
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<IOptionValue> |
getRKMOptions()
Return the reverse knowledge module's options. |
IRepositoryEntity |
getSecurityContainer()
Define a generic way to retrieve container for entities. |
OdiSKM |
getSKM()
Returns the service knowledge module associated to this OdiModel instance. |
java.util.Collection<OdiSubModel> |
getSubModels()
Obtains the unmodifiable collection of all OdiSubModel s 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 |
setDescription(java.lang.String pDescription)
Sets the description of this OdiModel instance. |
void |
setJKM(OdiJKM pJKM)
Sets the journalization knowledge module associated to this OdiModel instance. |
void |
setName(java.lang.String pName)
Sets the name of this OdiModel instance. |
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<OdiModel.ReverseObjectType> 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<IOdiEntity> 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 |
---|
equals, getFirstDate, getFirstUser, getInternalVersion, getLastDate, getLastUser, hashCode, isNew, toString |
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 |
Field Detail |
---|
public static final int CODE_MAX_LENGTH
public static final int NAME_MAX_LENGTH
Constructor Detail |
---|
public OdiModel(OdiLogicalSchema pLogicalSchema, java.lang.String pName, java.lang.String pCode)
pLogicalSchema
- logical schema for modelpName
- name of modelpCode
- unique code of model
java.lang.IllegalArgumentException
- if the logical schema is null Method Detail |
---|
public void addSubModel(OdiSubModel pSubModel)
OdiModel
instance.
This will also set the model of the given sub model to this OdiModel instance.
pSubModel
- an OdiSubModel object to add
java.lang.IllegalArgumentException
- if pSubModel is null or if pSubModel is already ownded by a different OdiMOdel instancepublic OdiCKM getCKM()
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.
OdiCKM
,
setCKM(OdiCKM)
public java.util.List<IOptionValue> getCKMOptions()
CKM Options are parameters specified by the CKM. The default values of the parameters can be changed by a user.
java.lang.IllegalArgumentException
- if no CKM is defined for this modelOdiCKM
,
setCKM(OdiCKM)
,
getCKM()
,
IOptionValue
public java.lang.String getCode()
OdiModel
instance.
Code is a Unique code for this model.
public OdiLogicalSchema getDataServiceContainer()
Represents the logical schema corresponding to the application server (web services container) into which the generated web services will be deployed.
setDataServiceContainer(OdiLogicalSchema)
public java.lang.String getDataServiceDataSourceName()
setDataServiceDataSourceName(String)
public java.lang.String getDataServiceName()
setDataServiceName(String)
public java.lang.String getDataServiceNamespace()
The namespace is used to generate the Web Services Description Language (WSDL).
setDataServiceNamespace(String)
public java.lang.String getDataServicePackageName()
Generally, this is of the form com.(company name).(project name).
setDataServicePackageName(String)
public java.lang.String getDescription()
OdiModel
instance.
setDescription(String)
public java.util.Collection<IFlexFieldValue> getFlexFieldsValues()
IFlexFieldUser
IFlexFieldUser
.
getFlexFieldsValues
in interface IFlexFieldUser
public OdiGlobalSubModel getGlobalSubModel()
OdiModel
instance. It is never null
.
The global sub model object controls access to the datastores associated with this model.
public java.lang.Number getInstanceId()
getInstanceId
in interface oracle.odi.domain.procusage.IProcedureUser
public java.io.Serializable getInternalId()
getInternalId
in interface IRepositoryEntity
getModelId()
public OdiJKM getJKM()
OdiModel
instance.
The OdiJKM is the strategy used for data journalizing.
OdiJKM
,
setJKM(OdiJKM)
public java.util.List<IOptionValue> getJKMOptions()
JKM Options are parameters specified by the JKM. The default values of the parameters can be changed by a user.
java.lang.IllegalArgumentException
- if no JKM is defined for this modelOdiJKM
,
setJKM(OdiJKM)
,
getJKM()
,
IOptionValue
public OdiLogicalSchema getLogicalSchema()
OdiModel
instance.
Represents the logical schema of the topology to which this model is attached.
OdiLogicalSchema
public java.lang.Number getModelId()
OdiModel
instance.
public java.lang.String getName()
IOdiEntity
getName
in interface IOdiEntity
getName
in class oracle.odi.domain.support.AbstractOdiEntity
public OdiModelFolder getParentModelFolder()
OdiModel
instance.
Null value means that this model is not under a model folder.
OdiModelFolder
,
setParentModelFolder(OdiModelFolder)
public OdiLogicalAgent getReverseAgent()
OdiModel
instance.
null
if nonesetReverseAgent(OdiLogicalAgent)
public int getReverseAliasLength()
OdiModel
instance.
Used only in OdiModel.ReverseType.STANDARD
reverse mode.
setReverseAliasLength(int)
public java.lang.String getReverseAliasTrim()
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
setReverseAliasTrim(String)
public OdiContext getReverseContext()
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.
setReverseContext(OdiContext)
public java.lang.String getReverseObjectMask()
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.
setReverseObjectMask(String)
public java.util.Collection<OdiModel.ReverseObjectType> getReverseObjectTypes()
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.
OdiModel.ReverseObjectType
.setReverseObjectTypes(Collection)
public OdiModel.ReverseType getReverseType()
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.
setReverseType(ReverseType)
public OdiRKM getRKM()
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.
OdiRKM
,
setRKM(OdiRKM)
public java.util.List<IOptionValue> getRKMOptions()
RKM Options are parameters specified by the RKM. The default values of the parameters can be changed by a user.
java.lang.IllegalArgumentException
- if no JKM is defined for this modelOdiRKM
,
setRKM(OdiRKM)
,
getRKM()
,
IOptionValue
public IRepositoryEntity getSecurityContainer()
IRepositoryEntity
getSecurityContainer
in interface IRepositoryEntity
public OdiSKM getSKM()
OdiModel
instance.
The service knowledge module is used to generate the web service.
OdiSKM
,
setSKM(OdiSKM)
public java.util.Collection<OdiSubModel> getSubModels()
OdiSubModel
s 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.
addSubModel(OdiSubModel)
,
removeSubModel(OdiSubModel)
public OdiTechnology getTechnology()
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.
OdiTechnology
public void initFlexFields(IOdiFlexFieldFinder pOdiFlexFieldFinder)
IFlexFieldUser
IFlexFieldUser
.
initFlexFields
in interface IFlexFieldUser
pOdiFlexFieldFinder
- OdiFlexField
finder to be used to query flex fieldspublic boolean isActualMetadataChangeDisplayRequired()
OdiModel
instance is required to be displayed with actual
meta data changes in underlying schema, or not.
true
if changes are required to be displayed,
false
otherwisepublic boolean isConsistantJournalize()
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.
true
if this OdiModel use consistent CDC, false
otherwise.setJKM(OdiJKM)
public boolean isInstanceLevelSecurityNeeded()
IOdiEntity
Defines a method to capture the info on which object needs instance level privilege.
isInstanceLevelSecurityNeeded
in interface IOdiEntity
isInstanceLevelSecurityNeeded
in class oracle.odi.domain.support.AbstractOdiEntity
true
if instance level security needed,
false
otherwisepublic void removeSubModel(OdiSubModel pSubModel)
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
pSubModel
- an OdiSubModel object
java.lang.IllegalArgumentException
- if pSubModel is null or does not belong to this OdiModelpublic void setActualMetadataChangeDisplayRequired(boolean pActualMetadataChangeDisplayRequired)
OdiModel
instance is required to be displayed with actual
meta data change in underlying schema, or not.
pActualMetadataChangeDisplayRequired
- true
to display changes,
false
otherwisepublic void setCKM(OdiCKM pCKM)
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.
pCKM
- the CKM to set or null
OdiCKM
,
getCKM()
public void setDataServiceContainer(OdiLogicalSchema pDataServiceContainer)
Represents the logical schema corresponding to the application server (web services container) into which the generated web services will be deployed.
pDataServiceContainer
- data service container. This may be null.
java.lang.IllegalArgumentException
- if pDataServiceContainer is not a data service containergetDataServiceContainer()
public void setDataServiceDataSourceName(java.lang.String pDataServiceDataSourceName)
This name should be prefixed by java:/comp/env/.
pDataServiceDataSourceName
- name of the data source that you defined in the data servergetDataServiceDataSourceName()
public void setDataServiceName(java.lang.String pDataServiceName)
pDataServiceName
- name of the data service (may be null)getDataServiceName()
public void setDataServiceNamespace(java.lang.String pDataServiceNamespace)
The namespace is used to generate the Web Services Description Language (WSDL).
pDataServiceNamespace
- data service namespace. This may be null.getDataServiceNamespace()
public void setDataServicePackageName(java.lang.String pDataServicePackageName)
Generally, this is of the form com.(company name).(project name).
pDataServicePackageName
- the Name of the Java package generated to contain all the web services. This may be null.getDataServicePackageName()
public void setDescription(java.lang.String pDescription)
OdiModel
instance.
pDescription
- a String specifying the description valuegetDescription()
public void setJKM(OdiJKM pJKM)
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.
pJKM
- the JKM to set or null
OdiJKM
,
isConsistantJournalize()
,
getJKM()
public void setName(java.lang.String pName)
OdiModel
instance.
pName
- name
java.lang.IllegalArgumentException
- if the name is null, empty or longer than 400getName()
public void setReverseAgent(OdiLogicalAgent pLogicalAgent)
OdiModel
instance.
pLogicalAgent
- the logical agent, or null if nonegetReverseAgent()
public void setReverseAliasLength(int pReverseAliasLength)
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.
pReverseAliasLength
- reverse maximum alias lengthgetReverseAliasLength()
public void setReverseAliasTrim(java.lang.String pReverseAliasTrim)
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
pReverseAliasTrim
- the reverse alias trimgetReverseAliasTrim()
public void setReverseContext(OdiContext pContext)
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.
pContext
- the context to set or null
getReverseContext()
public void setReverseObjectMask(java.lang.String pReverseObjectMask)
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 '%'.
pReverseObjectMask
- reverse object maskgetReverseObjectMask()
public void setReverseObjectTypes(java.util.Collection<OdiModel.ReverseObjectType> pReverseObjectTypes)
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
.
pReverseObjectTypes
- a collection of ReverseObjectType to be reverse engineered.
java.lang.IllegalArgumentException
- if given collection is null
OdiModel.ReverseObjectType
,
getReverseObjectTypes()
public void setReverseType(OdiModel.ReverseType pReverseType)
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
.
pReverseType
- reverse type to be applied.
java.lang.IllegalArgumentException
- if given reverse type is null
getReverseType()
public void setRKM(OdiRKM pRKM)
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.
pRKM
- the RKM to set or null
java.lang.IllegalStateException
- if the model is not in CUSTOMIZED ReverseType ModeOdiRKM
,
getRKM()
public void setSKM(OdiSKM pSKM)
OdiModel
instance.
The service knowledge module is used to generate the web service.
pSKM
- the SKM to set or null
OdiSKM
,
getSKM()
public boolean supportsImport(java.lang.Class<IOdiEntity> pChildClass)
IImportRoot
supportsImport
in interface IImportRoot
pChildClass
- the class of object to be imported into this one
true
if the given type could be imported, false
otherwise
|
Oracle® Data Integrator Java API Reference 11g Release 1 (11.1.1.3.0) E17060-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |