|
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 |
java.lang.Object
oracle.odi.domain.support.BusinessObject
oracle.odi.domain.support.AbstractRepositoryEntity
oracle.odi.domain.support.AbstractOdiEntity
oracle.odi.domain.model.OdiDataStore
public class OdiDataStore
An OdiDataStore represents a two-dimensional tabular data structure, generally a database table structure.
Depending on the OdiTechnology
associated with the OdiModel
to which this datastore belongs this datastore can represents a database table, the structure of a file, the structure of a JMS message etc... Constraints can also be defined on the datastores using the OdiKey
, OdiCondition
. Functional links between datastore can also be defined using OdiReference
.
If a datastore is constructed with a reference object, the datastore will represented a shortcut to the reference object. When a datastore is used as a shortcut, most properties are accessed through the base object. The IOdiShortcutable
interface implemented by OdiDatastore provides access and control over the shortcut aspects of this object.
The OdiDataStore also defines how this datastore will be used by different Oracle Data Integrator features.
OdiKey
, OdiCondition
, OdiReference
, OdiFilter
, Serialized FormNested Class Summary | |
---|---|
static class |
OdiDataStore.CdcDescriptor A Change Data Capture descriptor. |
static class |
OdiDataStore.DataStoreType Defines the type of a datastore. |
static class |
OdiDataStore.FileDescriptor A FileDescriptor holds the OdiDataStore configuration specific to datastore defined on a FILE OdiTechnology . |
static class |
OdiDataStore.OlapType Defines the OLAP type of a datastore. |
static class |
OdiDataStore.PartitioningPolicy Defines the partitioning policy on the datastore. |
Field Summary | |
---|---|
static int |
ALIAS_DEFAULT_LENGTH Length of the alias automatically computed from the datastore name when the OdiDataStore is created. |
static int |
ALIAS_MAX_LENGTH Maximum length supported for the "defaultAlias" property. |
static int |
NAME_MAX_LENGTH Maximum length supported for the "name" property. |
static int |
RESOURCE_NAME_MAX_LENGTH Maximum length supported for the "resourceName" property. |
Fields inherited from class oracle.odi.domain.support.AbstractOdiEntity |
---|
STARTING_INTERNAL_VERSION |
Constructor Summary | |
---|---|
OdiDataStore(AbstractOdiSubModel pSubModel, java.lang.String pName) Construct a new OdiDataStore . |
|
OdiDataStore(AbstractOdiSubModel pSubModel, java.lang.String pName, OdiDataStore pReferenceDataStore) Construct a new datastore. |
|
OdiDataStore(OdiModel pModel, java.lang.String pName) Construct a new OdiDataStore . |
|
OdiDataStore(OdiModel pModel, java.lang.String pName, OdiDataStore pReferenceDataStore) Construct a new datastore. |
Method Summary | |
---|---|
OdiDataStore.CdcDescriptor |
getCdcDescriptor() Returns the OdiDataStore.CdcDescriptor for this datastore. |
OdiColumn |
getColumn(java.lang.String pName) Returns the column named after the given name. |
OdiColumn |
getColumnOrNull(java.lang.String pName) Returns the column named after the given name. |
java.util.List<OdiColumn> |
getColumns() Returns an unmodifiable collection of OdiColumn s. |
java.util.Collection<OdiCondition> |
getConditions() Returns an unmodifiable collection of OdiCondition s that belongs to this datastore. |
java.lang.String |
getDataServiceName() Returns the name of the data service generated or to be generated for this datastore. |
java.lang.String |
getDataServicePublishedEntityName() Returns the name that is used to generate all operations names for the data service. |
java.lang.Number |
getDataStoreId() Returns the internal identifier of this OdiDataStore instance. |
OdiDataStore.DataStoreType |
getDataStoreType() Returns the OdiDataStore.DataStoreType of this OdiDataStore instance. |
java.lang.String |
getDefaultAlias() Returns the default alias for this OdiDataStore instance. |
java.lang.String |
getDescription() Returns the description for this OdiDataStore instance. |
OdiDataStore.FileDescriptor |
getFileDescriptor() Get the OdiDataStore.FileDescriptor of this OdiDataStore instance (i.e. |
java.util.Collection<OdiFilter> |
getFilters() Returns an unmodifiable collection of OdiFilter s that belongs to this datastore. |
java.util.Collection<IFlexFieldValue> |
getFlexFieldsValues() See interface for specifics |
java.io.Serializable |
getInternalId() Returns the internal identifier for this datastore. |
java.util.Collection<OdiKey> |
getKeys() Returns the unmodifiable collection of OdiKey s. |
OdiDataStore.PartitioningPolicy |
getMainPartitionPolicy() Returns the OdiDataStore.PartitioningPolicy policy used for the main partitions of this datastore. |
java.util.Collection<OdiMainPartition> |
getMainPartitions() Returns an unmodifiable collection of the OdiMainPartition s that belogns to this datastore. |
OdiModel |
getModel() Convenient method to obtain the OdiModel this OdiDataStore is referring from the AbstractOdiSubModel to which this datastore belongs. |
java.lang.String |
getName() Returns the name of this datastore. |
OdiDataStore.OlapType |
getOlapType() Returns the OdiDataStore.OlapType of this OdiDataStore instance. |
java.util.Collection<OdiReference> |
getOutboundReferences() Returns an unmodifiable Collection of outbound references for this OdiDataStore . |
OdiKey |
getPrimaryKey() Returns the current primary key of the datastore. |
OdiDataStore |
getRealObject() Return the real object associated with this object. |
IReleaseTag |
getReleaseTag() Return the release tag for this object. |
java.lang.String |
getResourceName() Returns the resource name of this OdiDataStore instance. |
java.lang.Integer |
getRowCount() Returns the number of row of this OdiDataStore instance. |
IRepositoryEntity |
getSecurityContainer() Define a generic way to retrieve container for entities. |
OdiDataStore |
getShortcutBaseObject() Return the base object of this shortcutable. |
OdiDataStore |
getShortcutOrigObject() If this is a shortcut, return the original base object |
OdiDataStore |
getShortcutReferenceObject() If this is a shortcut, return the reference object. |
AbstractOdiSubModel |
getSubModel() Returns the AbstractOdiSubModel that owns this datastore. |
OdiDataStore.PartitioningPolicy |
getSubPartitionPolicy() Returns the OdiDataStore.PartitioningPolicy policy used for the sub partitions of this datastore. |
void |
initFlexFields(IOdiFlexFieldFinder pOdiFlexFieldFinder) See interface for specifics. |
boolean |
isDeployAsDataService() Will this datastore to be deployed as a data service. |
boolean |
isDisplayRequired() Returns whether this OdiDataStore is required to be displayed, or not. |
boolean |
isInstanceLevelSecurityNeeded() Internal: this method is for internal purpose and must not be considered as part of the public API. |
boolean |
isShortcut() Returns true if this object is a shortcut. |
void |
moveColumn(OdiColumn pColumn, int pNewPosition) Change the position of the column in this datastore. |
void |
removeColumn(OdiColumn pColumn) Remove the given OdiColumn from the collection of OdiColumn s. |
void |
removeCondition(OdiCondition pCondition) Remove the given OdiCondition from the collection of OdiCondition s that belongs to this OdiDataStore . |
void |
removeFilter(OdiFilter pFilter) Remove the given OdiFilter from the collection of OdiFilter s that belong to this datastore. |
void |
removeKey(OdiKey pKey) Remove the given OdiKey from the collection of OdiKey s. |
void |
removeMainPartition(OdiMainPartition pMainPartition) Remove the given OdiMainPartition from the collection of OdiMainPartition s that belogns to this datastore. |
void |
removeOutboundReference(OdiReference pReference) Remove the given OdiReference from the collection of outbound OdiReference s that belong to this datastore. |
void |
setCdcDescriptor(OdiDataStore.CdcDescriptor pCdcDescriptor) Sets a OdiDataStore.CdcDescriptor (i.e. |
void |
setDataServiceName(java.lang.String pDataServiceName) Set the name of the data service generated for this datastore. |
void |
setDataServicePublishedEntityName(java.lang.String pDataServicePublishedEntityName) Defines the name that is used to generate all operations names for the data service. |
void |
setDataStoreType(OdiDataStore.DataStoreType pDatastoreType) Sets the OdiDataStore.DataStoreType for this OdiDataStore instance. |
void |
setDefaultAlias(java.lang.String pDefaultAlias) Sets the default alias for this OdiDataStore . |
void |
setDeployAsDataService(boolean pDeployAsDataService) Defines whether this datastore should be deployed as a data service. |
void |
setDescription(java.lang.String pDescription) Defines the description for this OdiDataStore instance. |
void |
setDisplayRequired(boolean pRequired) Defines whether this OdiDataStore is required to be displayed, or not. |
void |
setFileDescriptor(OdiDataStore.FileDescriptor pFileDescriptor) Set the OdiDataStore.FileDescriptor of this OdiDataStore instance (i.e. |
void |
setMainPartitionPolicy(OdiDataStore.PartitioningPolicy pMainPartitionPolicy) Defines the OdiDataStore.PartitioningPolicy used for main partitions. |
void |
setName(java.lang.String pName) |
void |
setOlapType(OdiDataStore.OlapType pOlapType) Sets the OdiDataStore.OlapType for this OdiDataStore instance. |
void |
setResourceName(java.lang.String pResourceName) Sets the resource name of this OdiDataStore instance. |
boolean |
setShortcutBaseObject(OdiDataStore pBaseObject) Internal Use Only. |
boolean |
setShortcutReferenceObject(OdiDataStore pReferenceObject) Internal Use Only. |
void |
setSubPartitionPolicy(OdiDataStore.PartitioningPolicy pSubPartitionPolicy) Defines the OdiDataStore.PartitioningPolicy used for main partitions. |
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 ALIAS_MAX_LENGTH
setDefaultAlias(String)
, Constant Field Valuespublic static final int ALIAS_DEFAULT_LENGTH
setDefaultAlias(String)
, Constant Field Valuespublic static final int RESOURCE_NAME_MAX_LENGTH
setResourceName(String)
, Constant Field Valuespublic static final int NAME_MAX_LENGTH
OdiDataStore(AbstractOdiSubModel, String)
, OdiDataStore(OdiModel, String)
, Constant Field ValuesConstructor Detail |
---|
public OdiDataStore(AbstractOdiSubModel pSubModel, java.lang.String pName)
OdiDataStore
.
This constructor sets the parent sub-model of the datastore and its name.
The default alias will be set using the 3 first characters of the name to upper case.
pSubModel
- the parent sub-modelpName
- the name of the datastoreDomainRuntimeException
- if the submodel is null or if the name is null, empty or longer that 128public OdiDataStore(AbstractOdiSubModel pSubModel, java.lang.String pName, OdiDataStore pReferenceDataStore)
This constructor sets the parent sub-model of the datastore shortcut, the datastore that this datastore shortcut refers to, and its name.
The default alias will be set using the 3 first characters of the name to upper case.
pSubModel
- the parent sub-modelpName
- the name of the datastorepReferenceDataStore
- The reference datastore for this datastore shortcut.DomainRuntimeException
- if the submodel is null or if the name is null, empty or longer thatpublic OdiDataStore(OdiModel pModel, java.lang.String pName, OdiDataStore pReferenceDataStore)
This constructor sets the parent model of the datastore and its name. The the datastore that this datastore shortcut refers to, and its name.
The default alias will be set using the 3 first characters of the name to upper case.
pModel
- the parent modelpName
- the name of the datastorepReferenceDataStore
- The reference datastore for this datastore shortcut.DomainRuntimeException
- if the submodel is null or if the name is null, empty or longer that 128public OdiDataStore(OdiModel pModel, java.lang.String pName)
OdiDataStore
.
This constructor sets the parent model of the datastore and its name. The parent sub-model will be set to the model global sub model.
The default alias will be set using the @value #ALIAS_DEFAULT_LENGTH} first characters of the name to upper case.
pModel
- the parent modelpName
- the name of the datastoreDomainRuntimeException
- if the model is null or if the name is null, empty or longer that 128Method Detail |
---|
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 OdiColumn getColumnOrNull(java.lang.String pName)
getColumnOrNull
in interface IDataStore<OdiColumn,OdiKey>
pName
- the name of the column to find.null
if no column was found with the given name in this datastore.DomainRuntimeException
- if this is a shortcut. Use getRealObject to access.getColumns()
, removeColumn(OdiColumn)
public OdiColumn getColumn(java.lang.String pName) throws ColumnNotFoundException
getColumn
in interface IDataStore<OdiColumn,OdiKey>
pName
- the name of the column to find.ColumnNotFoundException
- if no column was found with the given name in this dat astore.DomainRuntimeException
- if this is a shortcut. Use getRealObject to access.getColumns()
, removeColumn(OdiColumn)
public java.util.List<OdiColumn> getColumns()
OdiColumn
s.
Use removeOdiColumn(OdiColumn) to remove elements from this collection.
getColumns
in interface IDataStore<OdiColumn,OdiKey>
DomainRuntimeException
- if this is a shortcut. Use getRealObject to access.removeColumn(OdiColumn)
, getColumnOrNull(String)
public void removeColumn(OdiColumn pColumn)
OdiColumn
from the collection of OdiColumn
s.pColumn
- the column to removeDomainRuntimeException
- if pColumn is null or does not belong to this OdiDataStoreDomainRuntimeException
- if this is a shortcut. Use getRealObject to access.public void moveColumn(OdiColumn pColumn, int pNewPosition)
Note that the position of all the column between the current position and the new position will be changed
pColumn
- the column to move.pNewPosition
- the position to which this column will be moved.DomainRuntimeException
- if the column is null or not associated to this OdiDataStore
instance, or if the new position is not valid.DomainRuntimeException
- if this is a shortcut. Use getRealObject to access.public OdiDataStore.CdcDescriptor getCdcDescriptor()
OdiDataStore.CdcDescriptor
for this datastore.DomainRuntimeException
- if this is a shortcut. Use getRealObject to access.OdiDataStore.CdcDescriptor
, setCdcDescriptor(CdcDescriptor)
public void setCdcDescriptor(OdiDataStore.CdcDescriptor pCdcDescriptor)
OdiDataStore.CdcDescriptor
(i.e. journalization information) for this OdiDataStore
instance.pCdcDescriptor
- the CdcDescriptor. When use setCdcDesciptor to change the Data Capture policy of an OdiDataStore
, it is suggested to set the data store order to 0.OdiDataStore.CdcDescriptor
, getCdcDescriptor()
public java.lang.Number getDataStoreId()
OdiDataStore
instance.public OdiDataStore.DataStoreType getDataStoreType()
OdiDataStore.DataStoreType
of this OdiDataStore
instance.setDataStoreType(DataStoreType)
public OdiDataStore getShortcutBaseObject()
IOdiShortcutable
This will return null if the object never has been a shortcut. If this object is a materialized shortcut, the base object will be the base object at the time that this was shortcuted.
getShortcutBaseObject
in interface IOdiShortcutable<OdiDataStore>
public boolean setShortcutBaseObject(OdiDataStore pBaseObject)
IOdiShortcutable
If the base object is changed, we should correct all consumers of this object.
This method may be called from a precedent shortcut object in the shortcut chain and the precedent shortcut obejct is removed or materialized.
setShortcutBaseObject
in interface IOdiShortcutable<OdiDataStore>
pBaseObject
- new base object.public OdiDataStore getShortcutReferenceObject()
IOdiShortcutable
The reference object may also be a shortcut.
getShortcutReferenceObject
in interface IOdiShortcutable<OdiDataStore>
public boolean setShortcutReferenceObject(OdiDataStore pReferenceObject)
IOdiShortcutable
If pShortcutable is null, set pReference to null. This is no longer a shortcut.
If pShortcutable is not null, set the reference object to pShortcutable, set the base object to pShortcutable.getBaseObject.
This method may be called from a precedent shortcut object in the shortcut chain and the precedent shortcut obejct is removed or materialized.
setShortcutReferenceObject
in interface IOdiShortcutable<OdiDataStore>
pReferenceObject
- new shortcutable object. Can be be nullpublic OdiDataStore getShortcutOrigObject()
IOdiShortcutable
The reference object may also be a shortcut.
getShortcutOrigObject
in interface IOdiShortcutable<OdiDataStore>
public boolean isShortcut()
IOdiShortcutable
isShortcut
in interface IOdiShortcutable<OdiDataStore>
public IReleaseTag getReleaseTag()
IOdiShortcutable
release tag is actually maintained on the container object. This provides consistent access to the tag.
getReleaseTag
in interface IOdiShortcutable<OdiDataStore>
public OdiDataStore getRealObject()
IOdiShortcutable
This is a convenience function to obtain the real object of a shortcutable object. If this object is a shortcut, return the base obejct. If this object is not a shortcut, return this object.
getRealObject
in interface IOdiShortcutable<OdiDataStore>
public void setDataStoreType(OdiDataStore.DataStoreType pDatastoreType)
OdiDataStore.DataStoreType
for this OdiDataStore
instance.
By default, an OdiDataStore is defined with OdiDataStore.DataStoreType.TABLE
.
pDatastoreType
- the type of datastoreDomainRuntimeException
- if the parameter is null
.DomainRuntimeException
- if this is a shortcut. Use getRealObject to access.OdiDataStore.DataStoreType
, getDataStoreType()
public java.lang.String getDefaultAlias()
OdiDataStore
instance.DomainRuntimeException
- if this is a shortcut. Use getRealObject to access.setDefaultAlias(String)
public void setDefaultAlias(java.lang.String pDefaultAlias)
OdiDataStore
. By default, this value is defined with this datastore's upper case name substring of length ALIAS_DEFAULT_LENGTH
.pDefaultAlias
- the aliasDomainRuntimeException
- if the alias is null, empty or longer than ALIAS_MAX_LENGTHDomainRuntimeException
- if this is a shortcut. Use getRealObject to access.ALIAS_MAX_LENGTH
, getDefaultAlias()
public java.lang.String getDescription()
OdiDataStore
instance.setDescription(String)
public void setDescription(java.lang.String pDescription)
OdiDataStore
instance.pDescription
- the descriptiongetDescription()
public OdiDataStore.FileDescriptor getFileDescriptor()
OdiDataStore.FileDescriptor
of this OdiDataStore
instance (i.e. information relative to file technology). If this OdiDataStore
instance is not of technology file, will be null.DomainRuntimeException
- if this is a shortcut. Use getRealObject to access.setFileDescriptor(FileDescriptor)
public void setFileDescriptor(OdiDataStore.FileDescriptor pFileDescriptor)
OdiDataStore.FileDescriptor
of this OdiDataStore
instance (i.e. information relative to file technology).
This is not relevant for datastore that are not defined on a File OdiTechnology
.
pFileDescriptor
- file descriptorDomainRuntimeException
- if this is a shortcut. Use getRealObject to access.getFileDescriptor()
public OdiDataStore.OlapType getOlapType()
OdiDataStore.OlapType
of this OdiDataStore
instance.
null
value means that it has not been specified
DomainRuntimeException
- if this is a shortcut. Use getRealObject to access.setOlapType(OlapType)
public void setOlapType(OdiDataStore.OlapType pOlapType)
OdiDataStore.OlapType
for this OdiDataStore
instance. null
value is accepted and means that it has not been specified.pOlapType
- OLAP typeDomainRuntimeException
- if this is a shortcut. Use getRealObject to access.getOlapType()
public java.lang.String getResourceName()
OdiDataStore
instance.DomainRuntimeException
- if this is a shortcut. Use getRealObject to access.setResourceName(String)
public void setResourceName(java.lang.String pResourceName)
OdiDataStore
instance.
The name of the object in the form recognized by the data server that stores it. This may be a table name or a file name.
pResourceName
- the resource name.DomainRuntimeException
- if the resource name is null, empty or longer than 400DomainRuntimeException
- if this is a shortcut. Use getRealObject to access.getResourceName()
public OdiModel getModel()
OdiModel
this OdiDataStore
is referring from the AbstractOdiSubModel
to which this datastore belongs. Same as invoking getSubModel().getModel()
.public java.lang.String getName()
getName
in interface IOdiEntity
getName
in interface IDataStore<OdiColumn,OdiKey>
getName
in class oracle.odi.domain.support.AbstractOdiEntity
setName(String)
public java.lang.Integer getRowCount()
OdiDataStore
instance.
null
value means it has'nt been computed yet.
DomainRuntimeException
- if this is a shortcut. Use getRealObject to access.public IRepositoryEntity getSecurityContainer()
IRepositoryEntity
getSecurityContainer
in interface IRepositoryEntity
public AbstractOdiSubModel getSubModel()
AbstractOdiSubModel
that owns this datastore.AbstractOdiSubModel
public java.io.Serializable getInternalId()
getInternalId
in interface IRepositoryEntity
getDataStoreId()
public OdiKey getPrimaryKey()
null
if no primary key defined yet, the OdiKey otherwiseDomainRuntimeException
- if this is a shortcut. Use getRealObject to access.OdiKey
, getKeys()
public java.util.Collection<OdiKey> getKeys()
OdiKey
s.
Use removeKey(OdiKey) to remove elements from this collection.
getKeys
in interface IDataStore<OdiColumn,OdiKey>
DomainRuntimeException
- if this is a shortcut. Use getRealObject to access.removeKey(OdiKey)
public void removeKey(OdiKey pKey)
OdiKey
from the collection of OdiKey
s.pKey
- the key to remove.DomainRuntimeException
- if pKey is null or does not belong to this datastore.DomainRuntimeException
- if this is a shortcut. Use getRealObject to access.getKeys()
public java.util.Collection<OdiCondition> getConditions()
OdiCondition
s that belongs to this datastore.
Use removeCondition(OdiCondition)
to remove conditions from this collection.
DomainRuntimeException
- if this is a shortcut. Use getRealObject to access.removeCondition(OdiCondition)
public void removeCondition(OdiCondition pCondition)
OdiCondition
from the collection of OdiCondition
s that belongs to this OdiDataStore
.pCondition
- the condition to remove.DomainRuntimeException
- if pCondition is null or does not belong to this datastoreDomainRuntimeException
- if this is a shortcut. Use getRealObject to access.getConditions()
public java.util.Collection<OdiFilter> getFilters()
OdiFilter
s that belongs to this datastore.
Use removeFilter(OdiFilter)
to remove filter from this collection.
DomainRuntimeException
- if this is a shortcut. Use getRealObject to access.removeFilter(OdiFilter)
public void removeFilter(OdiFilter pFilter)
OdiFilter
from the collection of OdiFilter
s that belong to this datastore.pFilter
- the filter to remove.DomainRuntimeException
- if pFilter is null or does not belong to this OdiDataStoreDomainRuntimeException
- if this is a shortcut. Use getRealObject to access.getFilters()
public java.util.Collection<OdiReference> getOutboundReferences()
OdiDataStore
.
Outbound references are references that use this datastore as foreign datastore. Use removeOutboundReference(OdiReference)
to remove an outbound reference from this collection.
DomainRuntimeException
- if this is a shortcut. Use getRealObject to access.removeOutboundReference(OdiReference)
public void removeOutboundReference(OdiReference pReference)
OdiReference
from the collection of outbound OdiReference
s that belong to this datastore.pReference
- the reference to removeDomainRuntimeException
- if the given reference is null
or if the given reference is not an outbound reference of this datastoreDomainRuntimeException
- if this is a shortcut. Use getRealObject to access.getOutboundReferences()
public void setName(java.lang.String pName)
pName
-DomainRuntimeException
- if the name is null, empty or longer that NAME_MAX_LENGTHNAME_MAX_LENGTH
public java.util.Collection<IFlexFieldValue> getFlexFieldsValues()
getFlexFieldsValues
in interface IFlexFieldUser
DomainRuntimeException
- if this is a shortcut. Use getRealObject to access.public void initFlexFields(IOdiFlexFieldFinder pOdiFlexFieldFinder)
initFlexFields
in interface IFlexFieldUser
pOdiFlexFieldFinder
- OdiFlexField
finder to be used to query flex fieldsDomainRuntimeException
- if this is a shortcut. Use getRealObject to access.public OdiDataStore.PartitioningPolicy getMainPartitionPolicy()
OdiDataStore.PartitioningPolicy
policy used for the main partitions of this datastore.DomainRuntimeException
- if this is a shortcut. Use getRealObject to access.setMainPartitionPolicy(PartitioningPolicy)
, getMainPartitions()
public void setMainPartitionPolicy(OdiDataStore.PartitioningPolicy pMainPartitionPolicy)
OdiDataStore.PartitioningPolicy
used for main partitions.pMainPartitionPolicy
- the partition policy.DomainRuntimeException
- if this is a shortcut. Use getRealObject to access.getMainPartitionPolicy()
, getMainPartitions()
public OdiDataStore.PartitioningPolicy getSubPartitionPolicy()
OdiDataStore.PartitioningPolicy
policy used for the sub partitions of this datastore.DomainRuntimeException
- if this is a shortcut. Use getRealObject to access.OdiMainPartition.getSubPartitions()
, OdiSubPartition
, setSubPartitionPolicy(PartitioningPolicy)
public void setSubPartitionPolicy(OdiDataStore.PartitioningPolicy pSubPartitionPolicy)
OdiDataStore.PartitioningPolicy
used for main partitions.pSubPartitionPolicy
- the partition policy.DomainRuntimeException
- if this is a shortcut. Use getRealObject to access.OdiMainPartition.getSubPartitions()
, OdiSubPartition
, getSubPartitionPolicy()
public void removeMainPartition(OdiMainPartition pMainPartition)
OdiMainPartition
from the collection of OdiMainPartition
s that belogns to this datastore.pMainPartition
- the partition to removeDomainRuntimeException
- if pMainPartition is null or does not belong to this OdiDataStoreDomainRuntimeException
- if this is a shortcut. Use getRealObject to access.public java.util.Collection<OdiMainPartition> getMainPartitions()
OdiMainPartition
s that belogns to this datastore.
Use removeMainPartition(OdiMainPartition) to remove elements from this collection.
DomainRuntimeException
- if this is a shortcut. Use getRealObject to access.removeMainPartition(OdiMainPartition)
public void setDisplayRequired(boolean pRequired)
OdiDataStore
is required to be displayed, or not.pRequired
- true
to require this data store to be displayed, false
otherwise.public boolean isDisplayRequired()
OdiDataStore
is required to be displayed, or not.true
if this data store should be displayed, false
otherwisepublic void setDeployAsDataService(boolean pDeployAsDataService)
When this is set to true and the dataServiceName and dataServicePublishedEntityName properties are undefined defaults value for this propertis will be computed.
For a table name of DEPT
pDeployAsDataService
- true
if this data service should be deployed, false
otherwiseDomainRuntimeException
- if this is a shortcut. Use getRealObject to access.setDataServiceName(String)
, setDataServicePublishedEntityName(String)
public boolean isDeployAsDataService()
true
if this data service will be deployed, false
otherwiseDomainRuntimeException
- if this is a shortcut. Use getRealObject to access.public void setDataServiceName(java.lang.String pDataServiceName)
pDataServiceName
- name of the data service generated for this datastore. (May be null)DomainRuntimeException
- if this is a shortcut. Use getRealObject to access.getDataServiceName()
public java.lang.String getDataServiceName()
DomainRuntimeException
- if this is a shortcut. Use getRealObject to access.setDataServiceName(String)
public void setDataServicePublishedEntityName(java.lang.String pDataServicePublishedEntityName)
For example, if you specify customer as the published entity, the generated operations will be named addcustomer, getcustomer, etc
pDataServicePublishedEntityName
- the name that is used to generate all operations names. (May be null)DomainRuntimeException
- if this is a shortcut. Use getRealObject to access.getDataServicePublishedEntityName()
public java.lang.String getDataServicePublishedEntityName()
For example, if you specify customer as the published entity, the generated operations will be named addcustomer, getcustomer, etc
setDataServicePublishedEntityName(String)
|
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 |