OdiDataStore
object that is used as a source in an ODI interface.
This class implements the IInterfaceSubComponent
interface, so it can be added to
collections of interface subcomponents that are passed to various helper classes in the SDK.public class SourceDataStore extends oracle.odi.domain.support.AbstractRepositoryEntity implements IInterfaceSubComponent, IDataStore
Modifier and Type | Field and Description |
---|---|
static int |
ALIAS_MAX_LENGTH
Deprecated.
The maximum string length allowed for the source alias name in the interface.
|
Constructor and Description |
---|
SourceDataStore(DataSet pDataSet,
boolean pJournalized,
java.lang.String pAlias,
int pOrder)
Deprecated.
Internal use only
|
SourceDataStore(DataSet pDataSet,
boolean pJournalized,
java.lang.String pAlias,
int pOrder,
OdiDataStore pUnderlyingOdiDataStore)
Deprecated.
For internal use only.
To add a source data store to an interface, do not use this constructor. |
SourceDataStore(DataSet pDataSet,
boolean pJournalized,
java.lang.String pAlias,
int pOrder,
OdiInterface pUnderlyingOdiInterface)
Deprecated.
For internal use only.
To add a source data store to an interface, do not use this constructor. |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getAlias()
Deprecated.
Get the alias used for the data store when queries are generated using this
source.
|
ISourceColumn |
getColumn(java.lang.String pName)
Deprecated.
Get the
ISourceColumn in this source with the specified name. |
java.util.List |
getColumns()
Deprecated.
Get a list of all
ISourceColumn interface objects corresponding to the columns of this source. |
DataSet |
getDataSet()
Deprecated.
Get the
DataSet object that contains this source in the interface. |
OdiContext |
getForcedContext()
Deprecated.
Gets the forced context for the source, or
null if no forced context is set. |
java.lang.String |
getGlobalId()
Deprecated.
Global ID is unique cross repositories.
|
java.io.Serializable |
getInternalId()
Deprecated.
Gets the internal persistent repository id of this object.
|
java.util.List |
getJournalizedColumns()
Deprecated.
Get a list of the journalized columns of this source data store.
|
java.util.Collection |
getKeys()
Deprecated.
Return the set of
ISourceColumn objects corresponding to the key columns of this source. |
OdiLogicalSchema |
getLogicalSchema()
Deprecated.
Get the logical schema associated with the underlying data store for this source.
|
java.lang.String |
getName()
Deprecated.
Get the name of this source data store.
|
int |
getOrder()
Deprecated.
Gets the numeric order value that is used to calculate the order in which this data source
appears in the generated runtime query for the interface.
|
OdiPartition |
getPartition()
Deprecated.
Get the
OdiPartition associated with this source. |
IRepositoryEntity |
getSecurityContainer()
Deprecated.
Define a generic way to retrieve container for entities.
|
java.util.List |
getSourceColumns()
Deprecated.
Get a list of all
SourceColumn objects corresponding to the columns of this source. |
java.lang.Number |
getSourceDataStoreId()
Deprecated.
Gets the internal persistent repository id of this object.
|
SourceSet |
getSourceSet()
Deprecated.
Get the
SourceSet object that contains this source data store in the interface. |
java.lang.String |
getSubComponentDescription()
Deprecated.
Get the NLS-compliant description of this subcomponent of the interface, using the default locale.
|
java.lang.String |
getSubComponentDescription(java.util.Locale pLocale)
Deprecated.
Get the NLS-compliant description of this subcomponent of the interface, using the specified locale.
|
java.lang.String |
getTableName()
Deprecated.
For internal use only.
|
IDataStore |
getUnderlyingDataStore()
Deprecated.
Returns an
IDataStore corresponding to the underlying DataStore of the source table.If this SourceDataStore was created using an OdiDataStore , this method returns this OdiDataStore .If this SourceDataStore was created using an OdiInterface , this method returns the OdiInterface.TargetDataStore of this OdiInterface . |
OdiDataStore |
getUnderlyingOdiDataStore()
Deprecated.
Gets the underlying
OdiDataStore for this interface source. |
OdiDataStore |
getUnderlyingOdiDataStoreShortcut()
Deprecated.
Gets the underlying OdiDataStore shortcut for this interface source.
|
OdiInterface |
getUnderlyingOdiInterface()
Deprecated.
Gets the underlying
OdiInterface object whose target is used as a source
for the interface. |
OdiInterface |
getUnderlyingOdiInterfaceShortcut()
Deprecated.
Gets the underlying OdiInterface shortcut object whose target is used as a source
for the interface.
|
oracle.odi.domain.shortcuts.IOdiShortcutable |
getUnderlyingShortcut()
Deprecated.
Returns the underlying shortcut object.
|
boolean |
hasUnderlyingOdiDataStore()
Deprecated.
Indicates whether this source datastore is referencing an OdiDataStore as source.
|
boolean |
hasUnderlyingOdiInterface()
Deprecated.
Indicates whether this source datastore is referencing an OdiInterface as source.
|
boolean |
hasUnderlyingShortcut()
Deprecated.
Indicates whether this source datastore is referencing a shortcut as its underlying object.
|
boolean |
isJournalized()
Deprecated.
Gets the jounalized flag value for this data source.
|
boolean |
isLookup()
Deprecated.
Returns true if this source data store is used by a lookup
Join object in the interface. |
boolean |
isSelectLookup()
Deprecated.
If this data source is used in a lookup, return true if the lookup is a select lookup.
|
boolean |
isSubInterfaceAsDerived()
Deprecated.
In the case where this source is actually a temporary target of another interface
(a subinterface source), gets a flag that indicates whether to treat the subinterface as
a derived source.
|
void |
refreshColumns()
Deprecated.
For internal use only.
|
void |
setAlias(java.lang.String pAlias)
Deprecated.
Sets the alias used for the data store when queries are generated using this source.
|
void |
setContextCode(java.lang.String pContextCode)
Deprecated.
For internal use only
|
void |
setForcedContext(OdiContext pForcedContext)
Deprecated.
Sets the forced context for the source.
|
void |
setJournalized(boolean pJournalized)
Deprecated.
Set the journalized flag for this data source.
|
void |
setLogicalSchema(OdiLogicalSchema pSchema)
Deprecated.
Set the logical schema associated with the underlying data store for this source.
|
void |
setLookup(boolean pLookup)
Deprecated.
Sets this source data store as a lookup source.
|
void |
setLschemaName(java.lang.String pLschemaName)
Deprecated.
For internal use only
|
void |
setOrder(int pOrder)
Deprecated.
Sets the numeric order value that is used to calculate the order in which this data source
appears in the generated runtime query for the interface.
|
void |
setPartition(OdiPartition pPartition)
Deprecated.
Set the
OdiPartition associated with this source. |
void |
setPartitionId(java.lang.Number pPartitionId)
Deprecated.
For internal use only
|
void |
setSelectLookup(boolean pSelectLookup)
Deprecated.
Set a flag indicating that this source is part of a select lookup.
|
void |
setSourceSet(SourceSet pSourceSet)
Deprecated.
Set the
SourceSet object that contains this source data store in the interface. |
void |
setSubInterfaceAsDerived(boolean pSubInterfaceAsDerived)
Deprecated.
In the case where this source is actually a temporary target of another interface
(a subinterface source), sets a flag that indicates whether to treat the subinterface as
a derived source.
|
void |
setTableName(java.lang.String pTableName)
Deprecated.
For internal use only.
|
void |
setUnderlyingOdiDataStore(OdiDataStore pOdiDataStore)
Deprecated.
For internal use.
|
void |
setUnderlyingOdiInterface(OdiInterface pOdiInterface)
Deprecated.
For internal use.
|
void |
setUnderlyingScOdiDataStore(OdiDataStore pScOdiDataStore)
Deprecated.
For internal use.
|
void |
setUnderlyingScOdiInterface(OdiInterface pScOdiInterface)
Deprecated.
For internal use.
|
java.lang.String |
toString()
Deprecated.
|
public static final int ALIAS_MAX_LENGTH
public SourceDataStore(DataSet pDataSet, boolean pJournalized, java.lang.String pAlias, int pOrder, OdiDataStore pUnderlyingOdiDataStore)
InteractiveInterfaceHelperWithActions
helper class with the
InteractiveActionAddSourceDataStore
action class.pDataSet
- The interface DataSet
to which the data store should be added.pJournalized
- If true, then the data store being added will be registered as journalized.pAlias
- The alias used for the data store when SQL queries are generated for the interface.pOrder
- The order number used to control the order of appearance of this data store in generated SQL queries.pUnderlyingOdiDataStore
- The OdiDataStore
object to be added as a source the the interface.public SourceDataStore(DataSet pDataSet, boolean pJournalized, java.lang.String pAlias, int pOrder, OdiInterface pUnderlyingOdiInterface)
InteractiveInterfaceHelperWithActions
helper class with the
InteractiveActionAddSourceDataStore
action class.pDataSet
- The interface DataSet
to which the data store should be added.pJournalized
- If true, then the data store being added will be registered as journalized.pAlias
- The alias used for the data store when SQL queries are generated for the interface.pOrder
- The order number used to control the order of appearance of this data store in generated SQL queries.pUnderlyingOdiInterface
- The OdiInterface
object whose target will be added as a source the interface (used to create complex subqueries in the generated code).public SourceDataStore(DataSet pDataSet, boolean pJournalized, java.lang.String pAlias, int pOrder)
public java.io.Serializable getInternalId()
getInternalId
in interface IRepositoryEntity
getInternalId
in interface IInterfaceSubComponent
Serializable
number object representing the id.public java.lang.String getAlias()
setAlias(String)
public void setAlias(java.lang.String pAlias)
pAlias
- The new alias to set.getAlias()
public boolean isJournalized()
public void setJournalized(boolean pJournalized)
pJournalized
- The new setting. If true, the source will be registered as journalized.public int getOrder()
setOrder(int)
public void setOrder(int pOrder)
pOrder
- The new order number value.getOrder()
public SourceSet getSourceSet()
SourceSet
object that contains this source data store in the interface.
The source set is a grouping of sources from the same physical location or schema.setSourceSet(SourceSet)
public void setSourceSet(SourceSet pSourceSet)
SourceSet
object that contains this source data store in the interface.
The source set is a grouping of sources from the same physical location or schema.pSourceSet
- The new source set that will contain this source data store.getSourceSet()
public DataSet getDataSet()
DataSet
object that contains this source in the interface. The data set
is a set of sources that are grouped together for purposes of set operations. In many cases
there will only be one DataSet
per interface.DataSet
that contains this source.public OdiInterface getUnderlyingOdiInterface()
OdiInterface
object whose target is used as a source
for the interface. This is only applicable if this source is a subinterface source.OdiInterface
if it exists, or null
if this SourceDataStore
refers to an OdiDataStore
.public OdiDataStore getUnderlyingOdiDataStore()
OdiDataStore
for this interface source. This is only applicable
if this source is not a subinterface source.
Note that if the underlying datastore is a shortcut, this method returns the base object for this shortcut. To get the shortcut, use getUnderlyingOdiDataStoreShortcut() instead.OdiDataStore
if it exists, or null
if this SourceDataStore
refers to an OdiInterface
.public OdiInterface getUnderlyingOdiInterfaceShortcut()
OdiInterface
if it is a shortcut, or null
otherwise (it is a real OdiInterface as source or an OdiDataStore)public boolean hasUnderlyingOdiDataStore()
true
if this source datastore references an OdiDataStorepublic boolean hasUnderlyingOdiInterface()
true
if this source datastore references an OdiInterfacepublic boolean hasUnderlyingShortcut()
true
if the underlying object is a shortcut, false
otherwisepublic oracle.odi.domain.shortcuts.IOdiShortcutable getUnderlyingShortcut()
null
if the underlying object is not a shortcutpublic OdiDataStore getUnderlyingOdiDataStoreShortcut()
OdiDataStore
if it is a shortcut, or null
otherwise (it is a real OdiDataStore or an OdiInterface)public IRepositoryEntity getSecurityContainer()
IRepositoryEntity
getSecurityContainer
in interface IRepositoryEntity
public IDataStore getUnderlyingDataStore()
IDataStore
corresponding to the underlying DataStore of the source table.SourceDataStore
was created using an OdiDataStore
, this method returns this OdiDataStore
.SourceDataStore
was created using an OdiInterface
, this method returns the OdiInterface.TargetDataStore
of this OdiInterface
.public java.lang.Number getSourceDataStoreId()
public OdiContext getForcedContext()
null
if no forced context is set.
When resolving the source to a physical location or schema, the execution context specified
when starting the execution is used, unless a forced context is set for the source.setForcedContext(OdiContext)
public void setForcedContext(OdiContext pForcedContext)
pForcedContext
- The forced context to be set.getForcedContext()
public void setContextCode(java.lang.String pContextCode)
public OdiLogicalSchema getLogicalSchema()
OdiDataStore
.setLogicalSchema(OdiLogicalSchema)
public void setLogicalSchema(OdiLogicalSchema pSchema)
OdiDataStore
.pSchema
- The logical schema associated with the source.getLogicalSchema()
public void setLschemaName(java.lang.String pLschemaName)
public ISourceColumn getColumn(java.lang.String pName)
ISourceColumn
in this source with the specified name.getColumn
in interface IDataStore
pName
- The name of the column to find.null
if column isn't foundpublic java.util.List getJournalizedColumns()
public java.util.List getColumns()
ISourceColumn
interface objects corresponding to the columns of this source.getColumns
in interface IDataStore
public java.util.List getSourceColumns()
SourceColumn
objects corresponding to the columns of this source.public java.util.Collection getKeys()
ISourceColumn
objects corresponding to the key columns of this source.getKeys
in interface IDataStore
public java.lang.String getName()
getName
in interface IDataStore
public boolean isLookup()
Join
object in the interface.public void setLookup(boolean pLookup)
pLookup
- The new boolean value indicating whether this is a lookup source.public boolean isSelectLookup()
public void setSelectLookup(boolean pSelectLookup)
pSelectLookup
- The new value for the select lookup flag.public OdiPartition getPartition()
OdiPartition
associated with this source. The partition specifies a
subset of the source data that will be processed for the interface execution.setPartition(OdiPartition)
public void setPartition(OdiPartition pPartition)
OdiPartition
associated with this source. The partition specifies a
subset of the source data that will be processed for the interface execution.pPartition
- The partition to be associated with this source.getPartition()
public void setPartitionId(java.lang.Number pPartitionId)
public boolean isSubInterfaceAsDerived()
public void setSubInterfaceAsDerived(boolean pSubInterfaceAsDerived)
pSubInterfaceAsDerived
- The new derived interface flag.public java.lang.String getSubComponentDescription()
getSubComponentDescription
in interface IInterfaceSubComponent
public java.lang.String getSubComponentDescription(java.util.Locale pLocale)
getSubComponentDescription
in interface IInterfaceSubComponent
pLocale
- The locale to use when getting the description.public java.lang.String getTableName()
setTableName(String)
public void setTableName(java.lang.String pTableName)
pTableName
- The new table name for the source.getTableName()
public void refreshColumns()
public void setUnderlyingOdiInterface(OdiInterface pOdiInterface)
Sets the underlying OdiInterface
object whose target is used as a source
for the interface. This is only applicable if this source is a subinterface source.
public void setUnderlyingScOdiInterface(OdiInterface pScOdiInterface)
public void setUnderlyingOdiDataStore(OdiDataStore pOdiDataStore)
Sets the underlying OdiDataStore
object whose target is used as a source
for the interface. This is only applicable if this source is a datastore source.
public void setUnderlyingScOdiDataStore(OdiDataStore pScOdiDataStore)
public java.lang.String getGlobalId()
IRepositoryEntity
getGlobalId
in interface IRepositoryEntity
getGlobalId
in class oracle.odi.domain.support.AbstractRepositoryEntity
public java.lang.String toString()
toString
in class oracle.odi.domain.support.AbstractRepositoryEntity