|
Oracle® Data Integrator Java API Reference 11g Release 1 (11.1.1.6.0) E17060-03 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
oracle.odi.domain.support.BusinessObject
oracle.odi.domain.support.AbstractRepositoryEntity
oracle.odi.domain.project.interfaces.DataSet
public class DataSet
This class represents a dataset inside an OdiInterface
. A DataSet
is a subset of sources that can be combined with other DataSet
s using Set operators (such as UNION, MINUS, etc.). DataSet
s contain SourceDataStore
s, Join
s, Filter
s and TargetMapping
s (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
.
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. |
boolean |
internalPersistenceEquals(DataSet d2) Returns true if this instance is equal to i2 in terms of persisted fields only |
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 |
resetOperator() Internal use only Sets the operator to null . |
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 |
---|
public DataSet(OdiInterface pInterface, java.lang.String pName)
pInterface
- the interface in which this dataset is to be createdpName
- the name of this new dataset.Method Detail |
---|
public java.lang.String getName()
setName(String)
public java.io.Serializable getInternalId()
IInterfaceSubComponent
null
from this method will indicate the object has never been persisted in the repository.getInternalId
in interface IRepositoryEntity
getInternalId
in interface IInterfaceSubComponent
public java.lang.String getOperator()
setOperator(String)
public void setOperator(java.lang.String pOperator)
pOperator
- The new set operator.getOperator()
public void resetOperator()
null
. WARNING: call only on the first dataset!public int getOrder()
setOrder(int)
public void setOrder(int pOrder)
pOrder
- The new order number of this dataset.getOrder()
public java.lang.Number getDataSetId()
public void setName(java.lang.String pName)
pName
- The new name for this dataset.getName()
public IRepositoryEntity getSecurityContainer()
IRepositoryEntity
getSecurityContainer
in interface IRepositoryEntity
public OdiInterface getInterface()
public java.util.Collection<TargetMapping> getMappings()
TargetMapping
public TargetMapping getMapping(java.lang.String pColumnName)
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.pColumnName
- The name of the desired target column.TargetMapping
public java.util.Collection<Filter> getFilters()
Filter
public java.util.Collection<Join> getJoins()
Join
public java.util.Collection<SourceDataStore> getSourceDataStores()
SourceDataStore
public void addSourceDataStore(SourceDataStore pSourceDataStore)
pSourceDataStore
- The source datastore to be added.public java.util.Collection<SourceSet> getSourceSets()
SourceSet
public void addSourceSet(SourceSet pSourceSet)
pSourceSet
- The source set to be added.SourceSet
public void addJoin(Join pJoin)
pJoin
- The join object to be added.Join
public void addFilter(Filter pFilter)
pFilter
- The filter object to be added.Filter
public void addMapping(TargetMapping pMapping)
pMapping
- The new target mapping to be added.TargetMapping
public void removeSourceDataStore(SourceDataStore pSourceDataStore)
pSourceDataStore
- The source datastore to be removed.SourceDataStore
public void removeSourceSet(SourceSet pSourceSet)
pSourceSet
- The source set to be removed.SourceSet
public void removeJoin(Join pJoin)
pJoin
- The join object to be removed.Join
public void removeFilter(Filter pFilter)
pFilter
- The filter object to be removed.Filter
public void removeMapping(TargetMapping pTargetMapping)
pTargetMapping
- The target mapping to be removed.TargetMapping
public void renameMapping(java.lang.String pOldName, java.lang.String pNewName)
pOldName
- The old name for the target column.pNewName
- The new name for the target column.public java.util.Collection<GenericClause> getGenericClauses()
GenericClause
public void initializeMappingsFromPersisted()
public void populatePersistedMappings()
public java.lang.String getSubComponentDescription()
IInterfaceSubComponent
getSubComponentDescription
in interface IInterfaceSubComponent
public java.lang.String getSubComponentDescription(java.util.Locale pLocale)
IInterfaceSubComponent
getSubComponentDescription
in interface IInterfaceSubComponent
pLocale
- the Locale
for which the description should be returnedpublic boolean internalPersistenceEquals(DataSet d2)
OdiInterface.IPersistenceComparable
true
if this instance is equal to i2 in terms of persisted fields onlyinternalPersistenceEquals
in interface OdiInterface.IPersistenceComparable<DataSet>
true
if this equals to i2
|
Oracle® Data Integrator Java API Reference 11g Release 1 (11.1.1.6.0) E17060-03 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |