oracle.odi.domain.project.interfaces
Class DataSet

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

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, IRepositoryEntity, IInterfaceSubComponent

public class DataSet
extends oracle.odi.domain.support.AbstractRepositoryEntity
implements IInterfaceSubComponent

This class represents a dataset inside an OdiInterface. A DataSet is a subset of sources that can be combined with other DataSets using Set operators (such as UNION, MINUS, etc.). DataSets contain SourceDataStores, Joins, Filters and TargetMappings (which are occurrences of mappings executed on Source or Staging Area.
Note that this class is provided in read-only mode.
To make any modification to a DataSet please use instances of IInteractiveInterfaceHelper such as InteractiveInterfaceHelperWithActions.

Since:

11.1.1.3.0

See Also:

Serialized Form

Constructor Summary

DataSet(OdiInterface pInterface, java.lang.String pName)
Internal use only Builds a new DataSet in the given parent interface.

Method Summary

void	addFilter(Filter pFilter) Internal use only Adds the given filter to this dataset.
void	addJoin(Join pJoin) Internal use only Adds the given join to this dataset.
void	addMapping(TargetMapping pMapping) Internal use only Adds a new target mapping to this dataset.
void	addSourceDataStore(SourceDataStore pSourceDataStore) Internal use only Adds a given source datastore to this dataset.
void	addSourceSet(SourceSet pSourceSet) Internal use only Adds the given source set to this dataset.
java.lang.Number	getDataSetId() Returns the internal ID of this dataset.
java.util.Collection<Filter>	getFilters() Returns the list of filters contained in this dataset.
java.util.Collection<GenericClause>	getGenericClauses() Returns the list of generic clauses of this dataset, which is the list of filters and joins in this dataset.
OdiInterface	getInterface() Returns the parent interface containing this dataset.
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 the list of joins contained in this dataset.
TargetMapping	getMapping(java.lang.String pColumnName) Returns the target mapping in this dataset which corresponds to the target column of the given name.
java.util.Collection<TargetMapping>	getMappings() Returns the list of target mappings contained in this dataset.
java.lang.String	getName() Returns the name of this DataSet.
java.lang.String	getOperator() Returns the set operator used to join this dataset with the next one in the list of datasets of the parent interface.
int	getOrder() Returns the order number of this dataset.
IRepositoryEntity	getSecurityContainer() Define a generic way to retrieve container for entities.
java.util.Collection<SourceDataStore>	getSourceDataStores() Returns the list of source datastores contained in this dataset.
java.util.Collection<SourceSet>	getSourceSets() Returns the list of source sets contained in this dataset.
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() Internal use only Populates internal mapping between target column name and target mapping from persistence data structure.
void	populatePersistedMappings() Internal use only Populates persistence data structure from internal mapping between target column name and target mapping.
void	removeFilter(Filter pFilter) Internal use only Removes a filter from this dataset.
void	removeJoin(Join pJoin) Internal use only Removes a join from this dataset.
void	removeMapping(TargetMapping pTargetMapping) Internal use only Removes a target mapping from this dataset.
void	removeSourceDataStore(SourceDataStore pSourceDataStore) Internal use only Removes a source datastore from this dataset.
void	removeSourceSet(SourceSet pSourceSet) Internal use only Removes a source set from this dataset.
void	renameMapping(java.lang.String pOldName, java.lang.String pNewName) Internal use only Updates target mapping when given target column name is changed.
void	setName(java.lang.String pName) Sets a new name for this dataset.
void	setOperator(java.lang.String pOperator) Internal use only Sets the set operator used to join this dataset with the next one in the list of datasets of the parent interface.
void	setOrder(int pOrder) Internal use only Sets the order number of this dataset.

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

DataSet

public DataSet(OdiInterface pInterface,
               java.lang.String pName)

Internal use only Builds a new DataSet in the given parent interface.

Parameters:

pInterface - the interface in which this dataset is to be created

pName - the name of this new dataset.

Method Detail

addFilter

public void addFilter(Filter pFilter)

Internal use only Adds the given filter to this dataset.

Parameters:

pFilter - The filter object to be added.

See Also:

Filter

addJoin

public void addJoin(Join pJoin)

Internal use only Adds the given join to this dataset.

Parameters:

pJoin - The join object to be added.

See Also:

Join

addMapping

public void addMapping(TargetMapping pMapping)

Internal use only Adds a new target mapping to this dataset.

Parameters:

pMapping - The new target mapping to be added.

See Also:

TargetMapping

addSourceDataStore

public void addSourceDataStore(SourceDataStore pSourceDataStore)

Internal use only Adds a given source datastore to this dataset.

Parameters:

pSourceDataStore - The source datastore to be added.

addSourceSet

public void addSourceSet(SourceSet pSourceSet)

Internal use only Adds the given source set to this dataset.

Parameters:

pSourceSet - The source set to be added.

See Also:

SourceSet

getDataSetId

public java.lang.Number getDataSetId()

Returns the internal ID of this dataset.

Returns:

The internal id of this dataset.

getFilters

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

Returns the list of filters contained in this dataset.

Returns:

The list of filters contained in this dataset.

See Also:

Filter

getGenericClauses

public java.util.Collection<GenericClause> getGenericClauses()

Returns the list of generic clauses of this dataset, which is the list of filters and joins in this dataset.

Returns:

The list of generic clauses of this dataset.

See Also:

GenericClause

getInterface

public OdiInterface getInterface()

Returns the parent interface containing this dataset.

Returns:

The parent interface.

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 the list of joins contained in this dataset.

Returns:

The list of joins contained in this dataset.

See Also:

Join

getMapping

public TargetMapping getMapping(java.lang.String pColumnName)

Returns the target mapping in this dataset which corresponds to the target column of the given name. This method return null if there is no target column with the given name, or if such target column is not mapped, or if the mapping of such target column is to be executed on target.

Parameters:

pColumnName - The name of the desired target column.

Returns:

The target mapping of the desired target column.

See Also:

TargetMapping

getMappings

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

Returns the list of target mappings contained in this dataset. Note that this list does not include mappings that are executed on target.

Returns:

The list of target mappings contained in this dataset.

See Also:

TargetMapping

getName

public java.lang.String getName()

Returns the name of this DataSet.

Returns:

the name of this DataSet.

See Also:

setName(String)

getOperator

public java.lang.String getOperator()

Returns the set operator used to join this dataset with the next one in the list of datasets of the parent interface.

Returns:

The set operator used.

See Also:

setOperator(String)

getOrder

public int getOrder()

Returns the order number of this dataset. The order number is used to order dataset in the list of datasets of the parent interface.

Returns:

The order number of this dataset.

See Also:

setOrder(int)

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

getSourceDataStores

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

Returns the list of source datastores contained in this dataset.

Returns:

The list of source datastores contained in this dataset.

See Also:

SourceDataStore

getSourceSets

public java.util.Collection<SourceSet> getSourceSets()

Returns the list of source sets contained in this dataset.

Returns:

The list of sourceset contained in this dataset.

See Also:

SourceSet

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

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

populatePersistedMappings

public void populatePersistedMappings()

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

removeFilter

public void removeFilter(Filter pFilter)

Internal use only Removes a filter from this dataset.

Parameters:

pFilter - The filter object to be removed.

See Also:

Filter

removeJoin

public void removeJoin(Join pJoin)

Internal use only Removes a join from this dataset.

Parameters:

pJoin - The join object to be removed.

See Also:

Join

removeMapping

public void removeMapping(TargetMapping pTargetMapping)

Internal use only Removes a target mapping from this dataset.

Parameters:

pTargetMapping - The target mapping to be removed.

See Also:

TargetMapping

removeSourceDataStore

public void removeSourceDataStore(SourceDataStore pSourceDataStore)

Internal use only Removes a source datastore from this dataset.

Parameters:

pSourceDataStore - The source datastore to be removed.

See Also:

SourceDataStore

removeSourceSet

public void removeSourceSet(SourceSet pSourceSet)

Internal use only Removes a source set from this dataset.

Parameters:

pSourceSet - The source set to be removed.

See Also:

SourceSet

renameMapping

public void renameMapping(java.lang.String pOldName,
                          java.lang.String pNewName)

Internal use only Updates target mapping when given target column name is changed.

Parameters:

pOldName - The old name for the target column.

pNewName - The new name for the target column.

setName

public void setName(java.lang.String pName)

Sets a new name for this dataset.

Parameters:

pName - The new name for this dataset.

See Also:

getName()

setOperator

public void setOperator(java.lang.String pOperator)

Internal use only Sets the set operator used to join this dataset with the next one in the list of datasets of the parent interface.

Parameters:

pOperator - The new set operator.

See Also:

getOperator()

setOrder

public void setOrder(int pOrder)

Internal use only Sets the order number of this dataset.

Parameters:

pOrder - The new order number of this dataset.

See Also:

getOrder()