OdiDataStore (Oracle Fusion Middleware Java API Reference for Oracle Data Integrator)

java.lang.Object
- AbstractOdiEntity
- - oracle.odi.domain.model.OdiDataStore

All Implemented Interfaces:

IFlexFieldUser, IModelObject, IModelObjectBase, IModelObjectWithLocation, IShortcutableModelObject, IDataStore, IOdiEntity, IRepositoryEntity, IWorkDevelopmentOdiEntity
```
public class OdiDataStore
extends AbstractOdiEntity
implements IDataStore, IFlexFieldUser, IWorkDevelopmentOdiEntity, IDataStore, IShortcutableModelObject
```
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.

Since:

11.1.1.3.0

See Also:

OdiKey, OdiCondition, OdiReference, OdiFilter

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`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 and other file related technologies like HDFS and Oracle ERP cloud `OdiTechnology`.
`static class`	`OdiDataStore.HadoopStorageDescriptor` A HadoopStorageDescriptor holds the `OdiDataStore` configuration specific to datastore defined on a Hive/HDFS/Kafka `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

Fields
Modifier and Type	Field and Description
`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.

Constructor Summary

Constructors
Constructor and Description
`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

doclet.All_Methods doclet.Instance_Methods doclet.Concrete_Methods doclet.Deprecated_Methods
Modifier and Type	Method and Description
`boolean`	`changeShortcutReferenceObject(OdiDataStore pReferenceObject)`
`void`	`checkValidReference(OdiDataStore pReferenceObject)`
`OdiDataStore.CdcDescriptor`	`getCdcDescriptor()` Returns the `OdiDataStore.CdcDescriptor` for this datastore.
`OdiColumn`	`getColumn(java.lang.String pName)` Returns the column named after the given name.
`java.util.List`	`getColumns()` Obtains the columns owned by this data store.
`java.util.Collection`	`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`	`getFilters()` Returns an unmodifiable collection of `OdiFilter`s that belongs to this datastore.
`java.util.Collection`	`getFlexFieldsValues()` Obtains flex fields values related to this object.
`OdiDataStore.HadoopStorageDescriptor`	`getHadoopStorageDescriptor()` Gets the Hadoop Storage information for this Data Store
`java.io.Serializable`	`getInternalId()` Returns the internal identifier for this datastore.
`java.util.Collection`	`getKeys()` Obtains the keys defined on this data store.
`OdiDataStore.PartitioningPolicy`	`getMainPartitionPolicy()` Returns the `OdiDataStore.PartitioningPolicy` policy used for the main partitions of this datastore.
`java.util.Collection`	`getMainPartitions()` Returns an unmodifiable collection of the `OdiMainPartition`s that belongs 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`	`getOutboundReferences()` Returns an unmodifiable Collection of outbound references for this `OdiDataStore`.
`java.util.Collection`	`getOutboundRelationships()` Returns an unmodifiable Collection of outbound references for this `IDataStore`.
`java.util.Collection`	`getPartitions()` Returns an unmodifiable Collection of partitions for this `IDataStore`.
`OdiKey`	`getPrimaryKey()` Returns the current primary key of the datastore.
`java.util.Collection`	`getRealKeys()` Returns the unmodifiable collection of `OdiKey`s.
`IModelObject`	`getRealModelObject()` Returns the real model object of the current shortcut
`OdiDataStore`	`getRealObject()` Returns the real object if this object is a shortcut.
`IReleaseTag`	`getReleaseTag()`
`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()`
`OdiDataStore`	`getShortcutBaseObject()`
`java.lang.Number`	`getShortcutBigNumericId()` Gets a numeric ID of the shortcut object, for repositories that support numeric id.
`java.lang.String`	`getShortcutGlobalId()` Gets the global ID of the shortcut object, which should be unique across the repository.
`java.lang.Integer`	`getShortcutNumericId()` Deprecated.
`OdiDataStore`	`getShortcutOrigObject()` Deprecated.
`OdiDataStore`	`getShortcutReferenceObject()`
`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.
`OdiDataStoreFormatType`	`getTableFormatType()` Return the format type of this `OdiDataStore`.
`java.lang.String`	`getTableProperties()` Return the tables properties of this `OdiDataStore`.
`void`	`initFlexFields(IOdiFlexFieldFinder pOdiFlexFieldFinder)` See interface for specifics.
`boolean`	`isChangeDataCaptureEnabled()` Checks whether this data store object is set up to support change data capture.
`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()` Checks whether this object is a shortcut.
`boolean`	`isShortcutModelObject()` Returns true if the model object is shortcut.
`boolean`	`isVirtual()` Checks whether this is a virtual data storage.
`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 belongs 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`	`setHadoopStorageDescriptor(OdiDataStore.HadoopStorageDescriptor pHadoopStorageDescriptor)` Sets the Hadoop Storage Information for this Data Store
`void`	`setMainPartitionPolicy(OdiDataStore.PartitioningPolicy pMainPartitionPolicy)` Defines the `OdiDataStore.PartitioningPolicy` used for main partitions.
`void`	`setName(java.lang.String pName)` Sets name for this datastore.
`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)`
`boolean`	`setShortcutReferenceObject(OdiDataStore pReferenceObject)`
`void`	`setSubPartitionPolicy(OdiDataStore.PartitioningPolicy pSubPartitionPolicy)` Defines the `OdiDataStore.PartitioningPolicy` used for main partitions.
`void`	`setTableFormatType(OdiDataStoreFormatType dataStoreFormatType)` Define the format type of this `OdiDataStore`.
`void`	`setTableProperties(java.lang.String tableProperties)` Define the table properties of this `OdiDataStore`.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, 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
  - ALIAS_MAX_LENGTH
```
public static final int ALIAS_MAX_LENGTH
```
    Maximum length supported for the "defaultAlias" property.
    
    See Also:
    
    setDefaultAlias(String), Constant Field Values
  - ALIAS_DEFAULT_LENGTH
```
public static final int ALIAS_DEFAULT_LENGTH
```
    Length of the alias automatically computed from the datastore name when the OdiDataStore is created.
    
    See Also:
    
    setDefaultAlias(String), Constant Field Values
  - RESOURCE_NAME_MAX_LENGTH
```
public static final int RESOURCE_NAME_MAX_LENGTH
```
    Maximum length supported for the "resourceName" property.
    
    See Also:
    
    setResourceName(String), Constant Field Values
  - NAME_MAX_LENGTH
```
public static final int NAME_MAX_LENGTH
```
    Maximum length supported for the "name" property.
    
    See Also:
    
    OdiDataStore(AbstractOdiSubModel, String), OdiDataStore(OdiModel, String), Constant Field Values
- Constructor Detail
  - OdiDataStore
```
public OdiDataStore(AbstractOdiSubModel pSubModel,
                    java.lang.String pName)
```
    Construct a new 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.
    
    Parameters:
    
    pSubModel - the parent sub-model
    
    pName - the name of the datastore
    
    Throws:
    
    DomainRuntimeException - if the submodel is null or if the name is null, empty or longer that 128
  - OdiDataStore
```
public OdiDataStore(AbstractOdiSubModel pSubModel,
                    java.lang.String pName,
                    OdiDataStore pReferenceDataStore)
```
    Construct a new datastore. If preferenceDataStore is not null, this will be a shortcut datastore.
    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.
    
    Parameters:
    
    pSubModel - the parent sub-model
    
    pName - the name of the datastore
    
    pReferenceDataStore - The reference datastore for this datastore shortcut.
    
    Throws:
    
    DomainRuntimeException - if the submodel is null or if the name is null, empty or longer that
  - OdiDataStore
```
public OdiDataStore(OdiModel pModel,
                    java.lang.String pName,
                    OdiDataStore pReferenceDataStore)
```
    Construct a new datastore. If preferenceDataStore is not null, this will be a shortcut datastore.
    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.
    
    Parameters:
    
    pModel - the parent model
    
    pName - the name of the datastore
    
    pReferenceDataStore - The reference datastore for this datastore shortcut.
    
    Throws:
    
    DomainRuntimeException - if the submodel is null or if the name is null, empty or longer that 128
  - OdiDataStore
```
public OdiDataStore(OdiModel pModel,
                    java.lang.String pName)
```
    Construct a new 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.
    
    Parameters:
    
    pModel - the parent model
    
    pName - the name of the datastore
    
    Throws:
    
    DomainRuntimeException - if the model is null or if the name is null, empty or longer that 128
- Method Detail
  - 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
    
    Returns:
    
    true if instance level security needed, false otherwise
  - getColumn
```
public OdiColumn getColumn(java.lang.String pName)
```
    Returns the column named after the given name.
    
    Specified by:
    
    getColumn in interface IDataStore
    
    Parameters:
    
    pName - the name of the column to find.
    
    Returns:
    
    the column named pName or null if no column was found with the given name in this datastore.
    
    Throws:
    
    DomainRuntimeException - if this is a shortcut. Use getRealObject to access.
    
    See Also:
    
    getColumns(), removeColumn(OdiColumn)
  - getColumns
```
public java.util.List getColumns()
```
    Description copied from interface: IDataStore
    
    Obtains the columns owned by this data store.
    
    Specified by:
    
    getColumns in interface IDataStore
    
    Returns:
    
    a list of columns. The returned list is typically unmodifiable.
  - removeColumn
```
public void removeColumn(OdiColumn pColumn)
```
    Remove the given OdiColumn from the collection of OdiColumns.
    
    Parameters:
    
    pColumn - the column to remove
    
    Throws:
    
    DomainRuntimeException - if pColumn is null or does not belong to this OdiDataStore or if this is a shortcut. Use getRealObject to access.
  - moveColumn
```
public void moveColumn(OdiColumn pColumn,
                       int pNewPosition)
```
    Change the position of the column in this datastore.
    Note that the position of all the column between the current position and the new position will be changed
    
    Parameters:
    
    pColumn - the column to move.
    
    pNewPosition - the position to which this column will be moved.
    
    Throws:
    
    DomainRuntimeException - if the column is null or not associated to this OdiDataStore instance, or if the new position is not valid or if this is a shortcut. Use getRealObject to access.
  - getCdcDescriptor
```
public OdiDataStore.CdcDescriptor getCdcDescriptor()
```
    Returns the OdiDataStore.CdcDescriptor for this datastore.
    
    Returns:
    
    the CdcDescriptor for this datastore
    
    Throws:
    
    DomainRuntimeException - if this is a shortcut. Use getRealObject to access.
    
    See Also:
    
    OdiDataStore.CdcDescriptor, setCdcDescriptor(CdcDescriptor)
  - setCdcDescriptor
```
public void setCdcDescriptor(OdiDataStore.CdcDescriptor pCdcDescriptor)
```
    Sets a OdiDataStore.CdcDescriptor (i.e. journalization information) for this OdiDataStore instance.
    
    Parameters:
    
    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.
    
    See Also:
    
    OdiDataStore.CdcDescriptor, getCdcDescriptor()
  - getDataStoreId
```
public java.lang.Number getDataStoreId()
```
    Returns the internal identifier of this OdiDataStore instance.
    
    Returns:
    
    the datastore internal id.
  - getDataStoreType
```
public OdiDataStore.DataStoreType getDataStoreType()
```
    Returns the OdiDataStore.DataStoreType of this OdiDataStore instance.
    
    Returns:
    
    the datastore type
    
    See Also:
    
    setDataStoreType(DataStoreType)
  - getShortcutBaseObject
```
public OdiDataStore getShortcutBaseObject()
```
  - setShortcutBaseObject
```
public boolean setShortcutBaseObject(OdiDataStore pBaseObject)
```
  - getShortcutReferenceObject
```
public OdiDataStore getShortcutReferenceObject()
```
  - setShortcutReferenceObject
```
public boolean setShortcutReferenceObject(OdiDataStore pReferenceObject)
```
  - getShortcutOrigObject
```
public OdiDataStore getShortcutOrigObject()
```
    Deprecated.
  - isShortcut
```
public boolean isShortcut()
```
    Description copied from interface: IDataStore
    
    Checks whether this object is a shortcut.
    
    Specified by:
    
    isShortcut in interface IDataStore
    
    Returns:
    
    true if it is a shortcut, false otherwise
  - getReleaseTag
```
public IReleaseTag getReleaseTag()
```
  - getRealObject
```
public OdiDataStore getRealObject()
```
    Description copied from interface: IDataStore
    
    Returns the real object if this object is a shortcut. Otherwise, return this object itself.
    
    Specified by:
    
    getRealObject in interface IDataStore
    
    Returns:
    
    the real object of this object
  - setDataStoreType
```
public void setDataStoreType(OdiDataStore.DataStoreType pDatastoreType)
```
    Sets the OdiDataStore.DataStoreType for this OdiDataStore instance.
    By default, an OdiDataStore is defined with OdiDataStore.DataStoreType.TABLE.
    
    Parameters:
    
    pDatastoreType - the type of datastore
    
    Throws:
    
    DomainRuntimeException - if the parameter is null or if this is a shortcut. Use getRealObject to access.
    
    See Also:
    
    OdiDataStore.DataStoreType, getDataStoreType()
  - getDefaultAlias
```
public java.lang.String getDefaultAlias()
```
    Returns the default alias for this OdiDataStore instance.
    
    Specified by:
    
    getDefaultAlias in interface IDataStore
    
    Returns:
    
    the alias.
    
    Throws:
    
    DomainRuntimeException - if this is a shortcut. Use getRealObject to access.
    
    See Also:
    
    setDefaultAlias(String)
  - setDefaultAlias
```
public void setDefaultAlias(java.lang.String pDefaultAlias)
```
    Sets the default alias for this OdiDataStore. By default, this value is defined with this datastore's upper case name substring of length ALIAS_DEFAULT_LENGTH.
    
    Parameters:
    
    pDefaultAlias - the alias
    
    Throws:
    
    DomainRuntimeException - if the alias is null, empty or longer than ALIAS_MAX_LENGTH or if this is a shortcut. Use getRealObject to access.
    
    See Also:
    
    ALIAS_MAX_LENGTH, getDefaultAlias()
  - getDescription
```
public java.lang.String getDescription()
```
    Returns the description for this OdiDataStore instance.
    
    Returns:
    
    the description.
    
    See Also:
    
    setDescription(String)
  - setDescription
```
public void setDescription(java.lang.String pDescription)
```
    Defines the description for this OdiDataStore instance.
    
    Parameters:
    
    pDescription - the description
    
    See Also:
    
    getDescription()
  - getFileDescriptor
```
public OdiDataStore.FileDescriptor getFileDescriptor()
```
    Get the 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.
    
    Specified by:
    
    getFileDescriptor in interface IDataStore
    
    Returns:
    
    the file descriptor
    
    See Also:
    
    setFileDescriptor(FileDescriptor)
  - setFileDescriptor
```
public void setFileDescriptor(OdiDataStore.FileDescriptor pFileDescriptor)
```
    Set the 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.
    
    Parameters:
    
    pFileDescriptor - file descriptor
    
    Throws:
    
    DomainRuntimeException - if this OdiDataStore is not defined on a File based Technology or if this is a shortcut. Use getRealObject to access.
    
    See Also:
    
    getFileDescriptor()
  - getOlapType
```
public OdiDataStore.OlapType getOlapType()
```
    Returns the OdiDataStore.OlapType of this OdiDataStore instance.
    null value means that it has not been specified
    
    Returns:
    
    the OlapType of this datastore.
    
    Throws:
    
    DomainRuntimeException - if this is a shortcut. Use getRealObject to access.
    
    See Also:
    
    setOlapType(OlapType)
  - setOlapType
```
public void setOlapType(OdiDataStore.OlapType pOlapType)
```
    Sets the OdiDataStore.OlapType for this OdiDataStore instance. null value is accepted and means that it has not been specified.
    
    Parameters:
    
    pOlapType - OLAP type
    
    Throws:
    
    DomainRuntimeException - if this is a shortcut. Use getRealObject to access.
    
    See Also:
    
    getOlapType()
  - getResourceName
```
public java.lang.String getResourceName()
```
    Returns the resource name of this OdiDataStore instance.
    
    Returns:
    
    the resource name.
    
    Throws:
    
    DomainRuntimeException - if this is a shortcut. Use getRealObject to access.
    
    See Also:
    
    setResourceName(String)
  - setResourceName
```
public void setResourceName(java.lang.String pResourceName)
```
    Sets the resource name of this 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.
    
    Parameters:
    
    pResourceName - the resource name.
    
    Throws:
    
    DomainRuntimeException - if the resource name is null, empty or longer than 400 or if this is a shortcut. Use getRealObject to access.
    
    See Also:
    
    getResourceName()
  - getModel
```
public OdiModel getModel()
```
    Convenient method to obtain the OdiModel this OdiDataStore is referring from the AbstractOdiSubModel to which this datastore belongs. Same as invoking getSubModel().getModel().
    
    Specified by:
    
    getModel in interface IDataStore
    
    Returns:
    
    the model to which this datastore belongs.
  - getName
```
public java.lang.String getName()
```
    Returns the name of this datastore.
    
    Specified by:
    
    getName in interface IFlexFieldUser
    
    Specified by:
    
    getName in interface IModelObject
    
    Specified by:
    
    getName in interface IOdiEntity
    
    Returns:
    
    the name.
    
    See Also:
    
    setName(String)
  - getRowCount
```
public java.lang.Integer getRowCount()
```
    Returns the number of row of this OdiDataStore instance.
    null value means it hasn't been computed yet.
    
    Returns:
    
    the number of row.
    
    Throws:
    
    DomainRuntimeException - if this is a shortcut. Use getRealObject to access.
  - getSecurityContainer
```
public IRepositoryEntity getSecurityContainer()
```
    Specified by:
    
    getSecurityContainer in interface IRepositoryEntity
    
    Returns:
    
    container entity
  - getSubModel
```
public AbstractOdiSubModel getSubModel()
```
    Returns the AbstractOdiSubModel that owns this datastore.
    
    Specified by:
    
    getSubModel in interface IDataStore
    
    Returns:
    
    the parent sub-model.
    
    See Also:
    
    AbstractOdiSubModel
  - getInternalId
```
public java.io.Serializable getInternalId()
```
    Returns the internal identifier for this datastore.
    
    Specified by:
    
    getInternalId in interface IRepositoryEntity
    
    Returns:
    
    the internal identifier.
    
    See Also:
    
    getDataStoreId()
  - getPrimaryKey
```
public OdiKey getPrimaryKey()
```
    Returns the current primary key of the datastore.
    
    Returns:
    
    null if no primary key defined yet, the OdiKey otherwise
    
    Throws:
    
    DomainRuntimeException - if this is a shortcut. Use getRealObject to access.
    
    See Also:
    
    OdiKey, getKeys()
  - getKeys
```
public java.util.Collection getKeys()
```
    Description copied from interface: IDataStore
    
    Obtains the keys defined on this data store.
    
    Specified by:
    
    getKeys in interface IDataStore
    
    Returns:
    
    a collection of keys. The returned collection is typically unmodifiable.
  - getRealKeys
```
public java.util.Collection getRealKeys()
```
    Returns the unmodifiable collection of OdiKeys.
    Use removeKey(OdiKey) to remove elements from this collection.
    
    Returns:
    
    the collection of keys.
    
    Throws:
    
    DomainRuntimeException - if this is a shortcut. Use getRealObject to access.
    
    See Also:
    
    removeKey(OdiKey)
  - removeKey
```
public void removeKey(OdiKey pKey)
```
    Remove the given OdiKey from the collection of OdiKeys.
    
    Parameters:
    
    pKey - the key to remove.
    
    Throws:
    
    DomainRuntimeException - if pKey is null or does not belong to this datastore if this is a shortcut. Use getRealObject to access.
    
    See Also:
    
    getKeys()
  - getConditions
```
public java.util.Collection getConditions()
```
    Returns an unmodifiable collection of OdiConditions that belongs to this datastore.
    Use removeCondition(OdiCondition) to remove conditions from this collection.
    
    Specified by:
    
    getConditions in interface IDataStore
    
    Returns:
    
    the collection of conditions.
    
    Throws:
    
    DomainRuntimeException - if this is a shortcut. Use getRealObject to access.
    
    See Also:
    
    removeCondition(OdiCondition)
  - removeCondition
```
public void removeCondition(OdiCondition pCondition)
```
    Remove the given OdiCondition from the collection of OdiConditions that belongs to this OdiDataStore.
    
    Parameters:
    
    pCondition - the condition to remove.
    
    Throws:
    
    DomainRuntimeException - if pCondition is null or does not belong to this datastore or if this is a shortcut. Use getRealObject to access.
    
    See Also:
    
    getConditions()
  - getFilters
```
public java.util.Collection getFilters()
```
    Returns an unmodifiable collection of OdiFilters that belongs to this datastore.
    Use removeFilter(OdiFilter) to remove filter from this collection.
    
    Specified by:
    
    getFilters in interface IDataStore
    
    Returns:
    
    the collection of filters.
    
    Throws:
    
    DomainRuntimeException - if this is a shortcut. Use getRealObject to access.
    
    See Also:
    
    removeFilter(OdiFilter)
  - removeFilter
```
public void removeFilter(OdiFilter pFilter)
```
    Remove the given OdiFilter from the collection of OdiFilters that belong to this datastore.
    
    Parameters:
    
    pFilter - the filter to remove.
    
    Throws:
    
    DomainRuntimeException - if pFilter is null or does not belong to this OdiDataStore or if this is a shortcut. Use getRealObject to access.
    
    See Also:
    
    getFilters()
  - getOutboundReferences
```
public java.util.Collection getOutboundReferences()
```
    Returns an unmodifiable Collection of outbound references for this OdiDataStore.
    Outbound references are references that use this datastore as foreign datastore. Use removeOutboundReference(OdiReference) to remove an outbound reference from this collection.
    
    Returns:
    
    the collection of outbound references.
    
    Throws:
    
    DomainRuntimeException - if this is a shortcut. Use getRealObject to access.
    
    See Also:
    
    removeOutboundReference(OdiReference)
  - removeOutboundReference
```
public void removeOutboundReference(OdiReference pReference)
```
    Remove the given OdiReference from the collection of outbound OdiReferences that belong to this datastore.
    
    Parameters:
    
    pReference - the reference to remove
    
    Throws:
    
    DomainRuntimeException - if the given reference is null or if the given reference is not an outbound reference of this datastore or or if this is a shortcut. Use getRealObject to access.
    
    See Also:
    
    getOutboundReferences()
  - setName
```
public void setName(java.lang.String pName)
```
    Sets name for this datastore.
    
    Parameters:
    
    pName - name to set
    
    Throws:
    
    DomainRuntimeException - if the name is null, empty or longer that NAME_MAX_LENGTH
    
    See Also:
    
    NAME_MAX_LENGTH
  - getFlexFieldsValues
```
public java.util.Collection getFlexFieldsValues()
```
    Obtains flex fields values related to this object.
    
    Method initFlexFields(IOdiFlexFieldFinder) should be called before calling this method.
    
    Specified by:
    
    getFlexFieldsValues in interface IFlexFieldUser
    
    Returns:
    
    an unmodifiable Collection of flex field values
    
    Throws:
    
    DomainRuntimeException - if this is a shortcut. Use getRealObject to access.
    
    See Also:
    
    IFlexFieldUser.getFlexFieldsValues()
  - initFlexFields
```
public void initFlexFields(IOdiFlexFieldFinder pOdiFlexFieldFinder)
```
    See interface for specifics.
    
    Specified by:
    
    initFlexFields in interface IFlexFieldUser
    
    Parameters:
    
    pOdiFlexFieldFinder - OdiFlexField finder to be used to query flex fields
    
    Throws:
    
    DomainRuntimeException - if this is a shortcut. Use getRealObject to access.
  - getMainPartitionPolicy
```
public OdiDataStore.PartitioningPolicy getMainPartitionPolicy()
```
    Returns the OdiDataStore.PartitioningPolicy policy used for the main partitions of this datastore.
    
    Returns:
    
    the main partitions policy.
    
    Throws:
    
    DomainRuntimeException - if this is a shortcut. Use getRealObject to access.
    
    See Also:
    
    setMainPartitionPolicy(PartitioningPolicy), getMainPartitions()
  - setMainPartitionPolicy
```
public void setMainPartitionPolicy(OdiDataStore.PartitioningPolicy pMainPartitionPolicy)
```
    Defines the OdiDataStore.PartitioningPolicy used for main partitions.
    
    Parameters:
    
    pMainPartitionPolicy - the partition policy.
    
    Throws:
    
    DomainRuntimeException - if this is a shortcut. Use getRealObject to access.
    
    See Also:
    
    getMainPartitionPolicy(), getMainPartitions()
  - getSubPartitionPolicy
```
public OdiDataStore.PartitioningPolicy getSubPartitionPolicy()
```
    Returns the OdiDataStore.PartitioningPolicy policy used for the sub partitions of this datastore.
    
    Returns:
    
    the sub partitions policy.
    
    Throws:
    
    DomainRuntimeException - if this is a shortcut. Use getRealObject to access.
    
    See Also:
    
    OdiMainPartition.getSubPartitions(), OdiSubPartition, setSubPartitionPolicy(PartitioningPolicy)
  - setSubPartitionPolicy
```
public void setSubPartitionPolicy(OdiDataStore.PartitioningPolicy pSubPartitionPolicy)
```
    Defines the OdiDataStore.PartitioningPolicy used for main partitions.
    
    Parameters:
    
    pSubPartitionPolicy - the partition policy.
    
    Throws:
    
    DomainRuntimeException - if this is a shortcut. Use getRealObject to access.
    
    See Also:
    
    OdiMainPartition.getSubPartitions(), OdiSubPartition, getSubPartitionPolicy()
  - removeMainPartition
```
public void removeMainPartition(OdiMainPartition pMainPartition)
```
    Remove the given OdiMainPartition from the collection of OdiMainPartitions that belongs to this datastore.
    
    Parameters:
    
    pMainPartition - the partition to remove
    
    Throws:
    
    DomainRuntimeException - if pMainPartition is null or does not belong to this OdiDataStore or if this is a shortcut. Use getRealObject to access.
  - getMainPartitions
```
public java.util.Collection getMainPartitions()
```
    Returns an unmodifiable collection of the OdiMainPartitions that belongs to this datastore.
    Use removeMainPartition(OdiMainPartition) to remove elements from this collection.
    
    Returns:
    
    the collection of partitions.
    
    Throws:
    
    DomainRuntimeException - if this is a shortcut. Use getRealObject to access.
    
    See Also:
    
    removeMainPartition(OdiMainPartition)
  - setDisplayRequired
```
public void setDisplayRequired(boolean pRequired)
```
    Defines whether this OdiDataStore is required to be displayed, or not.
    
    Parameters:
    
    pRequired - true to require this data store to be displayed, false otherwise.
  - isDisplayRequired
```
public boolean isDisplayRequired()
```
    Returns whether this OdiDataStore is required to be displayed, or not.
    
    Returns:
    
    true if this data store should be displayed, false otherwise
  - setDeployAsDataService
```
public void setDeployAsDataService(boolean pDeployAsDataService)
```
    Defines whether this datastore should be deployed as a data service.
    When this is set to true and the dataServiceName and dataServicePublishedEntityName properties are undefined defaults value for this properties will be computed.
    
    For a table name of DEPT
    - dataServiceName property will be set to Dept
    - dataServicePublishedEntityName property will be set to WSDept
    Parameters:
    
    pDeployAsDataService - true if this data service should be deployed, false otherwise
    
    Throws:
    
    DomainRuntimeException - if this is a shortcut. Use getRealObject to access.
    
    See Also:
    
    setDataServiceName(String), setDataServicePublishedEntityName(String)
  - isDeployAsDataService
```
public boolean isDeployAsDataService()
```
    Will this datastore to be deployed as a data service.
    
    Returns:
    
    true if this data service will be deployed, false otherwise
    
    Throws:
    
    DomainRuntimeException - if this is a shortcut. Use getRealObject to access.
  - setDataServiceName
```
public void setDataServiceName(java.lang.String pDataServiceName)
```
    Set the name of the data service generated for this datastore.
    
    Parameters:
    
    pDataServiceName - name of the data service generated for this datastore. (May be null)
    
    Throws:
    
    DomainRuntimeException - if this is a shortcut. Use getRealObject to access.
    
    See Also:
    
    getDataServiceName()
  - getDataServiceName
```
public java.lang.String getDataServiceName()
```
    Returns the name of the data service generated or to be generated for this datastore.
    
    Returns:
    
    he name of the data service. (May be null)
    
    Throws:
    
    DomainRuntimeException - if this is a shortcut. Use getRealObject to access.
    
    See Also:
    
    setDataServiceName(String)
  - setDataServicePublishedEntityName
```
public void setDataServicePublishedEntityName(java.lang.String pDataServicePublishedEntityName)
```
    Defines the name that is used to generate all operations names for the data service.
    For example, if you specify customer as the published entity, the generated operations will be named addcustomer, getcustomer, etc
    
    Parameters:
    
    pDataServicePublishedEntityName - the name that is used to generate all operations names. (May be null)
    
    Throws:
    
    DomainRuntimeException - if this is a shortcut. Use getRealObject to access.
    
    See Also:
    
    getDataServicePublishedEntityName()
  - getDataServicePublishedEntityName
```
public java.lang.String getDataServicePublishedEntityName()
```
    Returns the name that is used to generate all operations names for the data service.
    For example, if you specify customer as the published entity, the generated operations will be named addcustomer, getcustomer, etc
    
    Returns:
    
    the name that is used to generate all operations names for the data service (may be null)
    
    See Also:
    
    setDataServicePublishedEntityName(String)
  - checkValidReference
```
public void checkValidReference(OdiDataStore pReferenceObject)
```
  - changeShortcutReferenceObject
```
public boolean changeShortcutReferenceObject(OdiDataStore pReferenceObject)
```
  - getOutboundRelationships
```
public java.util.Collection getOutboundRelationships()
```
    Description copied from interface: IDataStore
    
    Returns an unmodifiable Collection of outbound references for this IDataStore.
    Outbound references are references that use this datastore as foreign datastore.
    
    Specified by:
    
    getOutboundRelationships in interface IDataStore
    
    Returns:
    
    the collection of outbound references.
  - isVirtual
```
public boolean isVirtual()
```
    Description copied from interface: IDataStore
    
    Checks whether this is a virtual data storage.
    
    Specified by:
    
    isVirtual in interface IDataStore
    
    Returns:
    
    true if it is virtual, false otherwise
  - getShortcutGlobalId
```
public java.lang.String getShortcutGlobalId()
```
    Description copied from interface: IShortcutableModelObject
    
    Gets the global ID of the shortcut object, which should be unique across the repository. The global ID, or GUID, is used as the primary way to look up references to the shortcut model object.
    
    Specified by:
    
    getShortcutGlobalId in interface IShortcutableModelObject
    
    Returns:
    
    global ID of the object.
  - getShortcutNumericId
```
@Deprecated
public java.lang.Integer getShortcutNumericId()
```
    Deprecated.
    
    Specified by:
    
    getShortcutNumericId in interface IShortcutableModelObject
    
    Returns:
    
    numeric ID of the object, or null if not supported.
  - getShortcutBigNumericId
```
public java.lang.Number getShortcutBigNumericId()
```
    Description copied from interface: IShortcutableModelObject
    
    Gets a numeric ID of the shortcut object, for repositories that support numeric id. Otherwise return null.
    
    Specified by:
    
    getShortcutBigNumericId in interface IShortcutableModelObject
    
    Returns:
    
    numeric ID of the object, or null if not supported.
  - getRealModelObject
```
public IModelObject getRealModelObject()
```
    Description copied from interface: IShortcutableModelObject
    
    Returns the real model object of the current shortcut
    
    Specified by:
    
    getRealModelObject in interface IShortcutableModelObject
    
    Returns:
    
    IModelObject
  - isShortcutModelObject
```
public boolean isShortcutModelObject()
```
    Description copied from interface: IShortcutableModelObject
    
    Returns true if the model object is shortcut.
    
    Specified by:
    
    isShortcutModelObject in interface IShortcutableModelObject
    
    Returns:
    
    true if this object is a shortcut, otherwise false.
  - getPartitions
```
public java.util.Collection getPartitions()
```
    Description copied from interface: IDataStore
    
    Returns an unmodifiable Collection of partitions for this IDataStore.
    
    Specified by:
    
    getPartitions in interface IDataStore
    
    Returns:
    
    the collection of partitions
  - isChangeDataCaptureEnabled
```
public boolean isChangeDataCaptureEnabled()
```
    Description copied from interface: IDataStore
    
    Checks whether this data store object is set up to support change data capture.
    
    Specified by:
    
    isChangeDataCaptureEnabled in interface IDataStore
    
    Returns:
    
    true if enabled, false otherwise
  - getHadoopStorageDescriptor
```
public OdiDataStore.HadoopStorageDescriptor getHadoopStorageDescriptor()
```
    Gets the Hadoop Storage information for this Data Store
    
    Returns:
    
    Hadoop Storage Information
    
    See Also:
    
    OdiDataStore.HadoopStorageDescriptor
  - setHadoopStorageDescriptor
```
public void setHadoopStorageDescriptor(OdiDataStore.HadoopStorageDescriptor pHadoopStorageDescriptor)
```
    Sets the Hadoop Storage Information for this Data Store
    This is not relevant for datastore that are not defined on Hive, Kafka, HDFS OdiTechnology.
    
    Parameters:
    
    pHadoopStorageDescriptor - Storage Information
    
    Throws:
    
    DomainRuntimeException - if this is a shortcut. Use getRealObject to access.
    
    See Also:
    
    OdiDataStore.HadoopStorageDescriptor
  - getTableProperties
```
public java.lang.String getTableProperties()
```
    Return the tables properties of this OdiDataStore.
    
    Returns:
    
    table properties
    
    See Also:
    
    setTableProperties(String)
  - setTableProperties
```
public void setTableProperties(java.lang.String tableProperties)
```
    Define the table properties of this OdiDataStore.
    
    Parameters:
    
    tableProperties - the table properties to be set.
    
    See Also:
    
    getTableProperties()
  - getTableFormatType
```
public OdiDataStoreFormatType getTableFormatType()
```
    Return the format type of this OdiDataStore.
    
    Returns:
    
    format type
    
    See Also:
    
    setTableFormatType(OdiDataStoreFormatType)
  - setTableFormatType
```
public void setTableFormatType(OdiDataStoreFormatType dataStoreFormatType)
```
    Define the format type of this OdiDataStore.
    
    Parameters:
    
    dataStoreFormatType - the format type.
    
    See Also:
    
    getTableFormatType()

Class OdiDataStore

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface oracle.odi.domain.IOdiEntity

Methods inherited from interface oracle.odi.domain.IRepositoryEntity

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

Field Detail

ALIAS_MAX_LENGTH

ALIAS_DEFAULT_LENGTH

RESOURCE_NAME_MAX_LENGTH

NAME_MAX_LENGTH

Constructor Detail

OdiDataStore

OdiDataStore

OdiDataStore

OdiDataStore

Method Detail

isInstanceLevelSecurityNeeded

getColumn

getColumns

removeColumn

moveColumn

getCdcDescriptor

setCdcDescriptor

getDataStoreId

getDataStoreType

getShortcutBaseObject

setShortcutBaseObject

getShortcutReferenceObject

setShortcutReferenceObject

getShortcutOrigObject

isShortcut

getReleaseTag

getRealObject

setDataStoreType

getDefaultAlias

setDefaultAlias

getDescription

setDescription

getFileDescriptor

setFileDescriptor

getOlapType

setOlapType

getResourceName

setResourceName

getModel

getName

getRowCount

getSecurityContainer

getSubModel

getInternalId

getPrimaryKey

getKeys

getRealKeys

removeKey

getConditions

removeCondition

getFilters

removeFilter

getOutboundReferences

removeOutboundReference

setName

getFlexFieldsValues

initFlexFields

getMainPartitionPolicy

setMainPartitionPolicy

getSubPartitionPolicy

setSubPartitionPolicy

removeMainPartition

getMainPartitions

setDisplayRequired

isDisplayRequired

setDeployAsDataService

isDeployAsDataService

setDataServiceName

getDataServiceName

setDataServicePublishedEntityName