oracle.odi.domain.project.interfaces
Class SourceSet

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

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, IRepositoryEntity, oracle.odi.domain.procusage.IProcedureUser, IInterfaceSubComponent

public class SourceSet
extends oracle.odi.domain.support.AbstractRepositoryEntity
implements oracle.odi.domain.procusage.IProcedureUser, IInterfaceSubComponent

A source set groups all joins and mappings that will be executed on the same physical schema.

Since:

11.1.1.3.0

See Also:

Serialized Form

Constructor Summary

SourceSet(java.lang.String pName, DataSet pDataSet)
Creates a source set with a name, attached to a dataset which must not be null.

Method Summary

void	addClause(Join pJoin) Adds a Join to this source set.
void	addFilter(Filter pFilter) Adds a Filter to this source set.
void	addMapping(TargetMapping pMapping) Adds a TargetMapping to this source set.
void	addSourceDataStore(SourceDataStore pSourceDataStore) Adds a SourceDataStore to this source set.
DataSet	getDataSet() Returns the data set for which this source set is attached to.
java.util.Collection<Filter>	getFilters() Returns a collection of Filter in this source set.
java.lang.Number	getInstanceId()
java.io.Serializable	getInternalId() The internal ID of this sub component. Returning null from this method will indicate the object has never been persisted in the repository.
java.util.Collection<Join>	getJoins() Returns a collection of Join in this source set.
OdiLKM	getLKM() Returns the Load Knowledge module associated to this SourceSet instance.
java.util.List<IOptionValue>	getLKMOptions() Returns the source set's Load Knowledge Module's options.
OdiLogicalSchema	getLogicalSchema() Returns the logical schema of the source set, or null if the source set has no source data stores.
java.util.Collection<TargetMapping>	getMappings() Returns a collection of TargetMapping in this source set.
java.lang.String	getName() Returns the name of this source set.
IRepositoryEntity	getSecurityContainer() Returns the data set for which this source set is attached to.
java.util.Collection<SourceDataStore>	getSourceDataStores() Returns a collection of SourceDataStore in this source set.
java.lang.Number	getSourceSetId() Returns the internal id of this source set.
java.lang.String	getSubComponentDescription() Returns the sub component's description in a human-readable way.
java.lang.String	getSubComponentDescription(java.util.Locale pLocale) Returns the sub component's description in a human-readable way for the given Locale.
void	initializeMappingsFromPersisted() Populates internal mapping between target column name and target mapping from persistence data structure.
void	populatePersistedMappings() Populates persistence data structure from internal mapping between target column name and target mapping.
void	removeFilter(Filter pFilter) Removes a Filter from this source set.
void	removeFilters() Removes all Filters from this source set.
void	removeJoin(Join pJoin) Removes a Join from this source set.
void	removeJoins() Removes all Joins from this source set.
void	removeMapping(TargetMapping pMapping) Removes a TargetMapping from this source set.
void	removeMappings() Removes all TargetMappings from this source set.
void	removeSourceDataStore(SourceDataStore pSourceDataStore) Removes a SourceDataStore from this source set.
void	removeSourceDataStores() Removes all SourceDataStores from this source set.
void	setLKM(OdiLKM pLKM) Sets the Load Knowledge Module associated to this SourceSet instance.
void	setName(java.lang.String pName) Sets the name of the source set.

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

Constructor Detail

SourceSet

public SourceSet(java.lang.String pName,
                 DataSet pDataSet)

Creates a source set with a name, attached to a dataset which must not be null.

Parameters:

pName - the source set name, should be less than 100 characters

pDataSet - the data set in this source set

Method Detail

addClause

public void addClause(Join pJoin)

Adds a Join to this source set.

Parameters:

pJoin - the Join object to be added

addFilter

public void addFilter(Filter pFilter)

Adds a Filter to this source set.

Parameters:

pFilter - the Filter object to be added

addMapping

public void addMapping(TargetMapping pMapping)

Adds a TargetMapping to this source set.

Parameters:

pMapping - the TargetMapping object to be added

addSourceDataStore

public void addSourceDataStore(SourceDataStore pSourceDataStore)

Adds a SourceDataStore to this source set.

Parameters:

pSourceDataStore - the source data store object to be added

getDataSet

public DataSet getDataSet()

Returns the data set for which this source set is attached to.

Returns:

the dataset to wich this source set is attached

getFilters

public java.util.Collection<Filter> getFilters()

Returns a collection of Filter in this source set.

Returns:

a collection of Filter

getInstanceId

public java.lang.Number getInstanceId()

Specified by:

getInstanceId in interface oracle.odi.domain.procusage.IProcedureUser

getInternalId

public java.io.Serializable getInternalId()

Description copied from interface: IInterfaceSubComponent

The internal ID of this sub component.
Returning null from this method will indicate the object has never been persisted in the repository.

Specified by:

getInternalId in interface IRepositoryEntity

Specified by:

getInternalId in interface IInterfaceSubComponent

Returns:

the persistence identity of this instance

getJoins

public java.util.Collection<Join> getJoins()

Returns a collection of Join in this source set.

Returns:

a collection of Join

getLKM

public OdiLKM getLKM()

Returns the Load Knowledge module associated to this SourceSet instance.

Returns:

the Load Knowledge Module

See Also:

OdiLKM, setLKM(OdiLKM)

getLKMOptions

public java.util.List<IOptionValue> getLKMOptions()

Returns the source set's Load Knowledge Module's options.

Returns:

a list of the Load Knowledge Module's options

See Also:

OdiLKM, author jean-yves.toumit@oracle.com

getLogicalSchema

public OdiLogicalSchema getLogicalSchema()

Returns the logical schema of the source set, or null if the source set has no source data stores.

Returns:

the logical schema object

getMappings

public java.util.Collection<TargetMapping> getMappings()

Returns a collection of TargetMapping in this source set.

Returns:

a collection of TargetMapping

getName

public java.lang.String getName()

Returns the name of this source set.

Returns:

this source set's name

See Also:

setName(java.lang.String)

getSecurityContainer

public IRepositoryEntity getSecurityContainer()

Returns the data set for which this source set is attached to.

Specified by:

getSecurityContainer in interface IRepositoryEntity

Returns:

the data set

getSourceDataStores

public java.util.Collection<SourceDataStore> getSourceDataStores()

Returns a collection of SourceDataStore in this source set.

Returns:

a collection of SourceDataStore

getSourceSetId

public java.lang.Number getSourceSetId()

Returns the internal id of this source set.

Returns:

this source set's unique Id

getSubComponentDescription

public java.lang.String getSubComponentDescription()

Description copied from interface: IInterfaceSubComponent

Returns the sub component's description in a human-readable way.

Specified by:

getSubComponentDescription in interface IInterfaceSubComponent

Returns:

a human-readable String giving all necessary information to identify this component

getSubComponentDescription

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

Description copied from interface: IInterfaceSubComponent

Returns the sub component's description in a human-readable way for the given Locale.

Specified by:

getSubComponentDescription in interface IInterfaceSubComponent

Parameters:

pLocale - the Locale for which the description should be returned

Returns:

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

initializeMappingsFromPersisted

public void initializeMappingsFromPersisted()

Populates internal mapping between target column name and target mapping from persistence data structure.

populatePersistedMappings

public void populatePersistedMappings()

Populates persistence data structure from internal mapping between target column name and target mapping.

removeFilter

public void removeFilter(Filter pFilter)

Removes a Filter from this source set.

Parameters:

pFilter - the Filter to be removed

removeFilters

public void removeFilters()

Removes all Filters from this source set.

removeJoin

public void removeJoin(Join pJoin)

Removes a Join from this source set.

Parameters:

pJoin - the Join to be removed

removeJoins

public void removeJoins()

Removes all Joins from this source set.

removeMapping

public void removeMapping(TargetMapping pMapping)

Removes a TargetMapping from this source set.

Parameters:

pMapping - the TargetMapping to be removed

removeMappings

public void removeMappings()

Removes all TargetMappings from this source set.

removeSourceDataStore

public void removeSourceDataStore(SourceDataStore pSourceDataStore)

Removes a SourceDataStore from this source set.

Parameters:

pSourceDataStore - the source data store object to be removed

removeSourceDataStores

public void removeSourceDataStores()

Removes all SourceDataStores from this source set.

setLKM

public void setLKM(OdiLKM pLKM)

Sets the Load Knowledge Module associated to this SourceSet instance.

Parameters:

pLKM - the Load Knowledge Module

See Also:

OdiLKM, getLKM()

setName

public void setName(java.lang.String pName)

Sets the name of the source set.

Parameters:

pName - the source set's name, must not be null or over 100 characters

See Also:

getName()