oracle.odi.domain.project.interfaces
Class SourceDataStore

java.lang.Object
  oracle.odi.domain.support.BusinessObject
      oracle.odi.domain.support.AbstractRepositoryEntity
          oracle.odi.domain.project.interfaces.SourceDataStore

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, IRepositoryEntity, IInterfaceSubComponent, IDataStore<ISourceColumn,IKey<ISourceColumn>>

public class SourceDataStore
extends oracle.odi.domain.support.AbstractRepositoryEntity
implements IInterfaceSubComponent, IDataStore<ISourceColumn,IKey<ISourceColumn>>

A class that represents a 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.

Since:

11.1.1.3.0

See Also:

Serialized Form

Field Summary

static int

ALIAS_MAX_LENGTH The maximum string length allowed for the source alias name in the interface.

Constructor Summary

SourceDataStore(DataSet pDataSet, boolean pJournalized, java.lang.String pAlias, int pOrder, OdiDataStore pUnderlyingOdiDataStore)
The constructor for the object.

SourceDataStore(DataSet pDataSet, boolean pJournalized, java.lang.String pAlias, int pOrder, OdiInterface pUnderlyingOdiInterface)
The constructor for the object.

Method Summary

java.lang.String	getAlias() Get the alias used for the data store when queries are generated using this source.
ISourceColumn	getColumn(java.lang.String pName) Get the ISourceColumn in this source with the specified name.
java.util.List<ISourceColumn>	getColumns() Get a list of all ISourceColumn interface objects corresponding to the columns of this source.
DataSet	getDataSet() Get the DataSet object that contains this source in the interface.
OdiContext	getForcedContext() Gets the forced context for the source, or null if no forced context is set.
java.io.Serializable	getInternalId() Gets the internal persistent repository id of this object.
java.util.List<JournalizedSourceColumn>	getJournalizedColumns() Get a list of the journalized columns of this source data store.
java.util.Collection<IKey<ISourceColumn>>	getKeys() Return the set of ISourceColumn objects corresponding to the key columns of this source.
OdiLogicalSchema	getLogicalSchema() Get the logical schema associated with the underlying data store for this source.
java.lang.String	getName() Get the name of this source data store.
int	getOrder() 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() Get the OdiPartition associated with this source.
IRepositoryEntity	getSecurityContainer() Define a generic way to retrieve container for entities.
java.util.List<SourceColumn>	getSourceColumns() Get a list of all SourceColumn objects corresponding to the columns of this source.
java.lang.Number	getSourceDataStoreId() Gets the internal persistent repository id of this object.
SourceSet	getSourceSet() Get the SourceSet object that contains this source data store in the interface.
java.lang.String	getSubComponentDescription() Get the NLS-compliant description of this subcomponent of the interface, using the default locale.
java.lang.String	getSubComponentDescription(java.util.Locale pLocale) Get the NLS-compliant description of this subcomponent of the interface, using the specified locale.
java.lang.String	getTableName() For internal use only.
IDataStore<? extends IColumn,? extends IKey>	getUnderlyingDataStore() 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() Gets the underlying OdiDataStore for this interface source.
OdiInterface	getUnderlyingOdiInterface() Gets the underlying OdiInterface object whose target is used as a source for the interface.
boolean	isJournalized() Gets the jounalized flag value for this data source.
boolean	isLookup() Returns true if this source data store is used by a lookup Join object in the interface.
boolean	isSelectLookup() If this data source is used in a lookup, return true if the lookup is a select lookup.
boolean	isSubInterfaceAsDerived() 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() For internal use only.
void	setAlias(java.lang.String pAlias) Sets the alias used for the data store when queries are generated using this source.
void	setForcedContext(OdiContext pForcedContext) Sets the forced context for the source.
void	setJournalized(boolean pJournalized) Set the journalized flag for this data source.
void	setLogicalSchema(OdiLogicalSchema pSchema) Set the logical schema associated with the underlying data store for this source.
void	setLookup(boolean pLookup) Sets this source data store as a lookup source.
void	setOrder(int pOrder) 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) Set the OdiPartition associated with this source.
void	setSelectLookup(boolean pSelectLookup) Set a flag indicating that this source is part of a select lookup.
void	setSourceSet(SourceSet pSourceSet) Set the SourceSet object that contains this source data store in the interface.
void	setSubInterfaceAsDerived(boolean pSubInterfaceAsDerived) 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) For internal use only.

Methods inherited from class oracle.odi.domain.support.BusinessObject

clone

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ALIAS_MAX_LENGTH

public static final int ALIAS_MAX_LENGTH

The maximum string length allowed for the source alias name in the interface.

See Also:

Constant Field Values

Constructor Detail

SourceDataStore

public SourceDataStore(DataSet pDataSet,
                       boolean pJournalized,
                       java.lang.String pAlias,
                       int pOrder,
                       OdiDataStore pUnderlyingOdiDataStore)

The constructor for the object. To add a source data store to an interface, do not use this construtor. Instead use the InteractiveInterfaceHelperWithActions helper class with the InteractiveActionAddSourceDataStore action class. For internal use only.

Parameters:

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.

SourceDataStore

public SourceDataStore(DataSet pDataSet,
                       boolean pJournalized,
                       java.lang.String pAlias,
                       int pOrder,
                       OdiInterface pUnderlyingOdiInterface)

The constructor for the object. To add a source data store to an interface, do not use this construtor. Instead use the InteractiveInterfaceHelperWithActions helper class with the InteractiveActionAddSourceDataStore action class. For internal use only.

Parameters:

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).

Method Detail

getAlias

public java.lang.String getAlias()

Get the alias used for the data store when queries are generated using this source.

Returns:

The alias value.

See Also:

setAlias(String)

getColumn

public ISourceColumn getColumn(java.lang.String pName)
                        throws ColumnNotFoundException

Get the ISourceColumn in this source with the specified name.

Specified by:

getColumn in interface IDataStore<ISourceColumn,IKey<ISourceColumn>>

Parameters:

pName - The name of the column to find.

Returns:

The source column with the specified name.

Throws:

ColumnNotFoundException

getColumns

public java.util.List<ISourceColumn> getColumns()

Get a list of all ISourceColumn interface objects corresponding to the columns of this source.

Specified by:

getColumns in interface IDataStore<ISourceColumn,IKey<ISourceColumn>>

Returns:

The list of columns.

getDataSet

public DataSet getDataSet()

Get the 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.

Returns:

The DataSet that contains this source.

getForcedContext

public OdiContext getForcedContext()

Gets the forced context for the source, or 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.

Returns:

The forced context.

See Also:

setForcedContext(OdiContext)

getInternalId

public java.io.Serializable getInternalId()

Gets the internal persistent repository id of this object. For internal use only.

Specified by:

getInternalId in interface IRepositoryEntity

Specified by:

getInternalId in interface IInterfaceSubComponent

Returns:

The Serializable number object representing the id.

getJournalizedColumns

public java.util.List<JournalizedSourceColumn> getJournalizedColumns()

Get a list of the journalized columns of this source data store.

Returns:

The list of journalized columns.

getKeys

public java.util.Collection<IKey<ISourceColumn>> getKeys()

Return the set of ISourceColumn objects corresponding to the key columns of this source.

Specified by:

getKeys in interface IDataStore<ISourceColumn,IKey<ISourceColumn>>

Returns:

The list of key columns.

getLogicalSchema

public OdiLogicalSchema getLogicalSchema()

Get the logical schema associated with the underlying data store for this source. Only applicable if this source is a subinterface source, otherwise the logical schema used during code generation would be the one associated with the underlying OdiDataStore.

Returns:

The logical schema.

See Also:

setLogicalSchema(OdiLogicalSchema)

getName

public java.lang.String getName()

Get the name of this source data store.

Specified by:

getName in interface IDataStore<ISourceColumn,IKey<ISourceColumn>>

Returns:

The name.

getOrder

public int getOrder()

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.

Returns:

The order number value.

See Also:

setOrder(int)

getPartition

public OdiPartition getPartition()

Get the OdiPartition associated with this source. The partition specifies a subset of the source data that will be processed for the interface execution.

Returns:

The partition.

See Also:

setPartition(OdiPartition)

getSecurityContainer

public IRepositoryEntity getSecurityContainer()

Description copied from interface: IRepositoryEntity

Define a generic way to retrieve container for entities.

Specified by:

getSecurityContainer in interface IRepositoryEntity

Returns:

container entity

getSourceColumns

public java.util.List<SourceColumn> getSourceColumns()

Get a list of all SourceColumn objects corresponding to the columns of this source.

Returns:

The list of columns.

getSourceDataStoreId

public java.lang.Number getSourceDataStoreId()

Gets the internal persistent repository id of this object. For internal use only.

Returns:

The number object representing the id.

getSourceSet

public SourceSet getSourceSet()

Get the 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.

Returns:

The source set.

See Also:

setSourceSet(SourceSet)

getSubComponentDescription

public java.lang.String getSubComponentDescription()

Get the NLS-compliant description of this subcomponent of the interface, using the default locale.

Specified by:

getSubComponentDescription in interface IInterfaceSubComponent

Returns:

The description for this interface subcomponent.

getSubComponentDescription

public java.lang.String getSubComponentDescription(java.util.Locale pLocale)

Get the NLS-compliant description of this subcomponent of the interface, using the specified locale.

Specified by:

getSubComponentDescription in interface IInterfaceSubComponent

Parameters:

pLocale - The locale to use when getting the description.

Returns:

a human-readable String giving all necessary information to identify this component in the given Locale

getTableName

public java.lang.String getTableName()

For internal use only. Do not read this value.

Returns:

The table name.

See Also:

setTableName(String)

getUnderlyingDataStore

public IDataStore<? extends IColumn,? extends IKey> getUnderlyingDataStore()

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.

Returns:

the underlying datastore

getUnderlyingOdiDataStore

public OdiDataStore getUnderlyingOdiDataStore()

Gets the underlying OdiDataStore for this interface source. This is only applicable if this source is not a subinterface source.

Returns:

the underlying OdiDataStore if it exists, or null if this SourceDataStore refers to an OdiInterface.

getUnderlyingOdiInterface

public OdiInterface getUnderlyingOdiInterface()

Gets 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.

Returns:

the underlying OdiInterface if it exists, or null if this SourceDataStore refers to an OdiDataStore.

isJournalized

public boolean isJournalized()

Gets the jounalized flag value for this data source.

Returns:

true if the source will be registered as journalized.

isLookup

public boolean isLookup()

Returns true if this source data store is used by a lookup Join object in the interface.

Returns:

true is this is a lookup source.

isSelectLookup

public boolean isSelectLookup()

If this data source is used in a lookup, return true if the lookup is a select lookup. A select lookup implements the lookup as a scalar SQL subquery in the select list of the generated SQL query.

Returns:

True if this source is a select lookup source.

isSubInterfaceAsDerived

public boolean isSubInterfaceAsDerived()

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. A derived source means that the other interface logic will be generated as a from clause subquery in the generated SQL for this interface.

Returns:

The derived interface flag.

refreshColumns

public void refreshColumns()

For internal use only.

setAlias

public void setAlias(java.lang.String pAlias)

Sets the alias used for the data store when queries are generated using this source.

Parameters:

pAlias - The new alias to set.

See Also:

getAlias()

setForcedContext

public void setForcedContext(OdiContext pForcedContext)

Sets the forced context for the source. 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.

Parameters:

pForcedContext - The forced context to be set.

See Also:

getForcedContext()

setJournalized

public void setJournalized(boolean pJournalized)

Set the journalized flag for this data source.

Parameters:

pJournalized - The new setting. If true, the source will be registered as journalized.

setLogicalSchema

public void setLogicalSchema(OdiLogicalSchema pSchema)

Set the logical schema associated with the underlying data store for this source. Only applicable if this source is a subinterface source, otherwise the logical schema used during code generation would be the one associated with the underlying OdiDataStore.

Parameters:

pSchema - The logical schema associated with the source.

See Also:

getLogicalSchema()

setLookup

public void setLookup(boolean pLookup)

Sets this source data store as a lookup source. For internal use only.

Parameters:

pLookup - The new boolean value indicating whether this is a lookup source.

setOrder

public void setOrder(int pOrder)

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.

Parameters:

pOrder - The new order number value.

See Also:

getOrder()

setPartition

public void setPartition(OdiPartition pPartition)

Set the OdiPartition associated with this source. The partition specifies a subset of the source data that will be processed for the interface execution.

Parameters:

pPartition - The partition to be associated with this source.

See Also:

getPartition()

setSelectLookup

public void setSelectLookup(boolean pSelectLookup)

Set a flag indicating that this source is part of a select lookup. For internal use only.

Parameters:

pSelectLookup - The new value for the select lookup flag.

setSourceSet

public void setSourceSet(SourceSet pSourceSet)

Set the 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.

Parameters:

pSourceSet - The new source set that will contain this source data store.

See Also:

getSourceSet()

setSubInterfaceAsDerived

public void setSubInterfaceAsDerived(boolean pSubInterfaceAsDerived)

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. A derived source means that the other interface logic will be generated as a from clause subquery in the generated SQL for this interface.

Parameters:

pSubInterfaceAsDerived - The new derived interface flag.

setTableName

public void setTableName(java.lang.String pTableName)

For internal use only. Do not set this value.

Parameters:

pTableName - The new table name for the source.

See Also:

getTableName()