oracle.odi.domain.adapter.relational

Interface IDataStore

All Superinterfaces:

IModelObject, IModelObjectWithLocation

All Known Implementing Classes:

OdiDataStore

public interface IDataStore
extends IModelObjectWithLocation

An interface that represents a data storage type external model object. It will be implemented by objects that are mainly containers for ordered columns and can represent a relational data table.

Method Summary

Methods

Modifier and Type	Method and Description
IColumn	getColumn(java.lang.String pName) Obtains the column matching the given name.
java.util.List	getColumns() Obtains the columns owned by this data store.
java.util.Collection	getConditions() Returns an unmodifiable Collection of conditions for this IDataStore.
java.lang.String	getDefaultAlias() Returns the default alias of this datastore.
IFileDescriptor	getFileDescriptor() Returns the corresponding file descriptor if this datastore represents a file, else null.
java.util.Collection	getFilters() Returns an unmodifiable Collection of filters for this IDataStore.
java.util.Collection	getKeys() Obtains the keys defined on this data store.
IModel	getModel() Returns the owning model for this datastore object, if any, else null.
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.
IDataStore	getRealObject() Returns the real object if this object is a shortcut.
IModel	getSubModel() Returns the submodel that directly owns this datastore.
boolean	isChangeDataCaptureEnabled() Checks whether this data store object is set up to support change data capture.
boolean	isShortcut() Checks whether this object is a shortcut.
boolean	isVirtual() Checks whether this is a virtual data storage.

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

getGlobalId, getName, getNumericId

Method Detail

getColumns

java.util.List getColumns()

Obtains the columns owned by this data store.

Returns:

a list of columns. The returned list is typically unmodifiable.

getColumn

IColumn getColumn(java.lang.String pName)

Obtains the column matching the given name.

Parameters:

pName - column name

Returns:

the column for the given name

getKeys

java.util.Collection getKeys()

Obtains the keys defined on this data store.

Returns:

a collection of keys. The returned collection is typically unmodifiable.

getOutboundRelationships

java.util.Collection getOutboundRelationships()

Returns an unmodifiable Collection of outbound references for this IDataStore.

Outbound references are references that use this datastore as foreign datastore.

Returns:

the collection of outbound references.

getFilters

java.util.Collection getFilters()

Returns an unmodifiable Collection of filters for this IDataStore.

Returns:

the collection of filters.

getConditions

java.util.Collection getConditions()

Returns an unmodifiable Collection of conditions for this IDataStore.

Returns:

the collection of conditions

getPartitions

java.util.Collection getPartitions()

Returns an unmodifiable Collection of partitions for this IDataStore.

Returns:

the collection of partitions

getFileDescriptor

IFileDescriptor getFileDescriptor()

Returns the corresponding file descriptor if this datastore represents a file, else null.

Returns:

the file descriptor

isChangeDataCaptureEnabled

boolean isChangeDataCaptureEnabled()

Checks whether this data store object is set up to support change data capture.

Returns:

true if enabled, false otherwise

isVirtual

boolean isVirtual()

Checks whether this is a virtual data storage.

Returns:

true if it is virtual, false otherwise

isShortcut

boolean isShortcut()

Checks whether this object is a shortcut.

Returns:

true if it is a shortcut, false otherwise

getRealObject

IDataStore getRealObject()

Returns the real object if this object is a shortcut. Otherwise, return this object itself.

Returns:

the real object of this object

getModel

IModel getModel()

Returns the owning model for this datastore object, if any, else null.

Returns:

the model to which this datastore belongs

getSubModel

IModel getSubModel()

Returns the submodel that directly owns this datastore.

Returns:

the submodel to which this datastore belongs

getDefaultAlias

java.lang.String getDefaultAlias()

Returns the default alias of this datastore.

Returns:

the alias