Skip navigation links

oracle.odi.domain.model
Class OdiDataStore

java.lang.Object
oracle.odi.domain.support.BusinessObject
oracle.odi.domain.support.AbstractRepositoryEntity
oracle.odi.domain.support.AbstractOdiEntity
oracle.odi.domain.model.OdiDataStore

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, IFlexFieldUser, IExportable, IOdiEntity, IRepositoryEntity, IWorkDevelopmentOdiEntity, IDataStore<OdiColumn,OdiKey>, IOdiShortcutable<OdiDataStore>, ISmartExportable

public class OdiDataStore

extends oracle.odi.domain.support.AbstractOdiEntity

implements IOdiShortcutable<OdiDataStore>, IDataStore<OdiColumn,OdiKey>, IFlexFieldUser, IWorkDevelopmentOdiEntity, IExportable, ISmartExportable

An OdiDataStore represents a two-dimensional tabular data structure, generally a database table structure.

Depending on the OdiTechnology associated with the OdiModel to which this datastore belongs this datastore can represents a database table, the structure of a file, the structure of a JMS message etc... Constraints can also be defined on the datastores using the OdiKey, OdiCondition. Functional links between datastore can also be defined using OdiReference.

If a datastore is constructed with a reference object, the datastore will represented a shortcut to the reference object. When a datastore is used as a shortcut, most properties are accessed through the base object. The IOdiShortcutable interface implemented by OdiDatastore provides access and control over the shortcut aspects of this object.

The OdiDataStore also defines how this datastore will be used by different Oracle Data Integrator features.

Since:

11.1.1.3.0

See Also:

OdiKey, OdiCondition, OdiReference, OdiFilter, Serialized Form

Nested Class Summary

static class	OdiDataStore.CdcDescriptor A Change Data Capture descriptor.
static class	OdiDataStore.DataStoreType Defines the type of a datastore.
static class	OdiDataStore.FileDescriptor A FileDescriptor holds the OdiDataStore configuration specific to datastore defined on a FILE OdiTechnology.
static class	OdiDataStore.OlapType Defines the OLAP type of a datastore.
static class	OdiDataStore.PartitioningPolicy Defines the partitioning policy on the datastore.

Field Summary

static int	ALIAS_DEFAULT_LENGTH Length of the alias automatically computed from the datastore name when the OdiDataStore is created.
static int	ALIAS_MAX_LENGTH Maximum length supported for the "defaultAlias" property.
static int	NAME_MAX_LENGTH Maximum length supported for the "name" property.
static int	RESOURCE_NAME_MAX_LENGTH Maximum length supported for the "resourceName" property.

Fields inherited from class oracle.odi.domain.support.AbstractOdiEntity

STARTING_INTERNAL_VERSION

Constructor Summary

OdiDataStore(AbstractOdiSubModel pSubModel, java.lang.String pName)
Construct a new OdiDataStore.

OdiDataStore(AbstractOdiSubModel pSubModel, java.lang.String pName, OdiDataStore pReferenceDataStore)
Construct a new datastore.

OdiDataStore(OdiModel pModel, java.lang.String pName)
Construct a new OdiDataStore.

OdiDataStore(OdiModel pModel, java.lang.String pName, OdiDataStore pReferenceDataStore)
Construct a new datastore.

Method Summary

OdiDataStore.CdcDescriptor	getCdcDescriptor() Returns the OdiDataStore.CdcDescriptor for this datastore.
OdiColumn	getColumn(java.lang.String pName) Returns the column named after the given name.
OdiColumn	getColumnOrNull(java.lang.String pName) Returns the column named after the given name.
java.util.List<OdiColumn>	getColumns() Returns an unmodifiable collection of OdiColumns.
java.util.Collection<OdiCondition>	getConditions() Returns an unmodifiable collection of OdiConditions that belongs to this datastore.
java.lang.String	getDataServiceName() Returns the name of the data service generated or to be generated for this datastore.
java.lang.String	getDataServicePublishedEntityName() Returns the name that is used to generate all operations names for the data service.
java.lang.Number	getDataStoreId() Returns the internal identifier of this OdiDataStore instance.
OdiDataStore.DataStoreType	getDataStoreType() Returns the OdiDataStore.DataStoreType of this OdiDataStore instance.
java.lang.String	getDefaultAlias() Returns the default alias for this OdiDataStore instance.
java.lang.String	getDescription() Returns the description for this OdiDataStore instance.
OdiDataStore.FileDescriptor	getFileDescriptor() Get the OdiDataStore.FileDescriptor of this OdiDataStore instance (i.e.
java.util.Collection<OdiFilter>	getFilters() Returns an unmodifiable collection of OdiFilters that belongs to this datastore.
java.util.Collection<IFlexFieldValue>	getFlexFieldsValues() See interface for specifics
java.io.Serializable	getInternalId() Returns the internal identifier for this datastore.
java.util.Collection<OdiKey>	getKeys() Returns the unmodifiable collection of OdiKeys.
OdiDataStore.PartitioningPolicy	getMainPartitionPolicy() Returns the OdiDataStore.PartitioningPolicy policy used for the main partitions of this datastore.
java.util.Collection<OdiMainPartition>	getMainPartitions() Returns an unmodifiable collection of the OdiMainPartitions that belogns to this datastore.
OdiModel	getModel() Convenient method to obtain the OdiModel this OdiDataStore is referring from the AbstractOdiSubModel to which this datastore belongs.
java.lang.String	getName() Returns the name of this datastore.
OdiDataStore.OlapType	getOlapType() Returns the OdiDataStore.OlapType of this OdiDataStore instance.
java.util.Collection<OdiReference>	getOutboundReferences() Returns an unmodifiable Collection of outbound references for this OdiDataStore.
OdiKey	getPrimaryKey() Returns the current primary key of the datastore.
OdiDataStore	getRealObject() Return the real object associated with this object.
IReleaseTag	getReleaseTag() Return the release tag for this object.
java.lang.String	getResourceName() Returns the resource name of this OdiDataStore instance.
java.lang.Integer	getRowCount() Returns the number of row of this OdiDataStore instance.
IRepositoryEntity	getSecurityContainer() Define a generic way to retrieve container for entities.
OdiDataStore	getShortcutBaseObject() Return the base object of this shortcutable.
OdiDataStore	getShortcutOrigObject() If this is a shortcut, return the original base object
OdiDataStore	getShortcutReferenceObject() If this is a shortcut, return the reference object.
AbstractOdiSubModel	getSubModel() Returns the AbstractOdiSubModel that owns this datastore.
OdiDataStore.PartitioningPolicy	getSubPartitionPolicy() Returns the OdiDataStore.PartitioningPolicy policy used for the sub partitions of this datastore.
void	initFlexFields(IOdiFlexFieldFinder pOdiFlexFieldFinder) See interface for specifics.
boolean	isDeployAsDataService() Will this datastore to be deployed as a data service.
boolean	isDisplayRequired() Returns whether this OdiDataStore is required to be displayed, or not.
boolean	isInstanceLevelSecurityNeeded() Internal: this method is for internal purpose and must not be considered as part of the public API.
boolean	isShortcut() Returns true if this object is a shortcut.
void	moveColumn(OdiColumn pColumn, int pNewPosition) Change the position of the column in this datastore.
void	removeColumn(OdiColumn pColumn) Remove the given OdiColumn from the collection of OdiColumns.
void	removeCondition(OdiCondition pCondition) Remove the given OdiCondition from the collection of OdiConditions that belongs to this OdiDataStore.
void	removeFilter(OdiFilter pFilter) Remove the given OdiFilter from the collection of OdiFilters that belong to this datastore.
void	removeKey(OdiKey pKey) Remove the given OdiKey from the collection of OdiKeys.
void	removeMainPartition(OdiMainPartition pMainPartition) Remove the given OdiMainPartition from the collection of OdiMainPartitions that belogns to this datastore.
void	removeOutboundReference(OdiReference pReference) Remove the given OdiReference from the collection of outbound OdiReferences that belong to this datastore.
void	setCdcDescriptor(OdiDataStore.CdcDescriptor pCdcDescriptor) Sets a OdiDataStore.CdcDescriptor (i.e.
void	setDataServiceName(java.lang.String pDataServiceName) Set the name of the data service generated for this datastore.
void	setDataServicePublishedEntityName(java.lang.String pDataServicePublishedEntityName) Defines the name that is used to generate all operations names for the data service.
void	setDataStoreType(OdiDataStore.DataStoreType pDatastoreType) Sets the OdiDataStore.DataStoreType for this OdiDataStore instance.
void	setDefaultAlias(java.lang.String pDefaultAlias) Sets the default alias for this OdiDataStore.
void	setDeployAsDataService(boolean pDeployAsDataService) Defines whether this datastore should be deployed as a data service.
void	setDescription(java.lang.String pDescription) Defines the description for this OdiDataStore instance.
void	setDisplayRequired(boolean pRequired) Defines whether this OdiDataStore is required to be displayed, or not.
void	setFileDescriptor(OdiDataStore.FileDescriptor pFileDescriptor) Set the OdiDataStore.FileDescriptor of this OdiDataStore instance (i.e.
void	setMainPartitionPolicy(OdiDataStore.PartitioningPolicy pMainPartitionPolicy) Defines the OdiDataStore.PartitioningPolicy used for main partitions.
void	setName(java.lang.String pName)
void	setOlapType(OdiDataStore.OlapType pOlapType) Sets the OdiDataStore.OlapType for this OdiDataStore instance.
void	setResourceName(java.lang.String pResourceName) Sets the resource name of this OdiDataStore instance.
boolean	setShortcutBaseObject(OdiDataStore pBaseObject) Internal Use Only.
boolean	setShortcutReferenceObject(OdiDataStore pReferenceObject) Internal Use Only.
void	setSubPartitionPolicy(OdiDataStore.PartitioningPolicy pSubPartitionPolicy) Defines the OdiDataStore.PartitioningPolicy used for main partitions.

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

equals, getFirstDate, getFirstUser, getInternalVersion, getLastDate, getLastUser, hashCode, isNew, toString

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

clone

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface oracle.odi.domain.IOdiEntity

getFirstDate, getFirstUser, getLastDate, getLastUser

Field Detail

ALIAS_MAX_LENGTH

public static final int ALIAS_MAX_LENGTH

Maximum length supported for the "defaultAlias" property.

See Also:

setDefaultAlias(String), Constant Field Values

ALIAS_DEFAULT_LENGTH

public static final int ALIAS_DEFAULT_LENGTH

Length of the alias automatically computed from the datastore name when the OdiDataStore is created.

See Also:

setDefaultAlias(String), Constant Field Values

RESOURCE_NAME_MAX_LENGTH

public static final int RESOURCE_NAME_MAX_LENGTH

Maximum length supported for the "resourceName" property.

See Also:

setResourceName(String), Constant Field Values

NAME_MAX_LENGTH

public static final int NAME_MAX_LENGTH

Maximum length supported for the "name" property.

See Also:

OdiDataStore(AbstractOdiSubModel, String), OdiDataStore(OdiModel, String), Constant Field Values

Constructor Detail

OdiDataStore

public OdiDataStore(AbstractOdiSubModel pSubModel,
                    java.lang.String pName)

Construct a new OdiDataStore.

This constructor sets the parent sub-model of the datastore and its name.

The default alias will be set using the 3 first characters of the name to upper case.

Parameters:

pSubModel - the parent sub-model

pName - the name of the datastore

Throws:

DomainRuntimeException - if the submodel is null or if the name is null, empty or longer that 128

OdiDataStore

public OdiDataStore(AbstractOdiSubModel pSubModel,
                    java.lang.String pName,
                    OdiDataStore pReferenceDataStore)

Construct a new datastore. If preferenceDataStore is not null, this will be a shortcut datastore.

This constructor sets the parent sub-model of the datastore shortcut, the datastore that this datastore shortcut refers to, and its name.

The default alias will be set using the 3 first characters of the name to upper case.

Parameters:

pSubModel - the parent sub-model

pName - the name of the datastore

pReferenceDataStore - The reference datastore for this datastore shortcut.

Throws:

DomainRuntimeException - if the submodel is null or if the name is null, empty or longer that

OdiDataStore

public OdiDataStore(OdiModel pModel,
                    java.lang.String pName,
                    OdiDataStore pReferenceDataStore)

Construct a new datastore. If preferenceDataStore is not null, this will be a shortcut datastore.

This constructor sets the parent model of the datastore and its name. The the datastore that this datastore shortcut refers to, and its name.

The default alias will be set using the 3 first characters of the name to upper case.

Parameters:

pModel - the parent model

pName - the name of the datastore

pReferenceDataStore - The reference datastore for this datastore shortcut.

Throws:

DomainRuntimeException - if the submodel is null or if the name is null, empty or longer that 128

OdiDataStore

public OdiDataStore(OdiModel pModel,
                    java.lang.String pName)

Construct a new OdiDataStore.

This constructor sets the parent model of the datastore and its name. The parent sub-model will be set to the model global sub model.

The default alias will be set using the @value #ALIAS_DEFAULT_LENGTH} first characters of the name to upper case.

Parameters:

pModel - the parent model

pName - the name of the datastore

Throws:

DomainRuntimeException - if the model is null or if the name is null, empty or longer that 128

Method Detail

isInstanceLevelSecurityNeeded

public boolean isInstanceLevelSecurityNeeded()

Description copied from interface: IOdiEntity

Internal: this method is for internal purpose and must not be considered as part of the public API.

Defines a method to capture the info on which object needs instance level privilege.

Specified by:

isInstanceLevelSecurityNeeded in interface IOdiEntity

Overrides:

isInstanceLevelSecurityNeeded in class oracle.odi.domain.support.AbstractOdiEntity

Returns:

true if instance level security needed, false otherwise

getColumnOrNull

public OdiColumn getColumnOrNull(java.lang.String pName)

Returns the column named after the given name.

Specified by:

getColumnOrNull in interface IDataStore<OdiColumn,OdiKey>

Parameters:

pName - the name of the column to find.

Returns:

the column named pName or null if no column was found with the given name in this datastore.

Throws:

DomainRuntimeException - if this is a shortcut. Use getRealObject to access.

See Also:

getColumns(), removeColumn(OdiColumn)

getColumn

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

Returns the column named after the given name.

Specified by:

getColumn in interface IDataStore<OdiColumn,OdiKey>

Parameters:

pName - the name of the column to find.

Returns:

the column named pName

Throws:

ColumnNotFoundException - if no column was found with the given name in this dat astore.

DomainRuntimeException - if this is a shortcut. Use getRealObject to access.

See Also:

getColumns(), removeColumn(OdiColumn)

getColumns

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

Returns an unmodifiable collection of OdiColumns.

Use removeOdiColumn(OdiColumn) to remove elements from this collection.

Specified by:

getColumns in interface IDataStore<OdiColumn,OdiKey>

Returns:

the collection of columns.

Throws:

DomainRuntimeException - if this is a shortcut. Use getRealObject to access.

See Also:

removeColumn(OdiColumn), getColumnOrNull(String)

removeColumn

public void removeColumn(OdiColumn pColumn)

Remove the given OdiColumn from the collection of OdiColumns.

Parameters:

pColumn - the column to remove

Throws:

DomainRuntimeException - if pColumn is null or does not belong to this OdiDataStore

DomainRuntimeException - if this is a shortcut. Use getRealObject to access.

moveColumn

public void moveColumn(OdiColumn pColumn,
                       int pNewPosition)

Change the position of the column in this datastore.

Note that the position of all the column between the current position and the new position will be changed

Parameters:

pColumn - the column to move.

pNewPosition - the position to which this column will be moved.

Throws:

DomainRuntimeException - if the column is null or not associated to this OdiDataStore instance, or if the new position is not valid.

DomainRuntimeException - if this is a shortcut. Use getRealObject to access.

getCdcDescriptor

public OdiDataStore.CdcDescriptor getCdcDescriptor()

Returns the OdiDataStore.CdcDescriptor for this datastore.

Returns:

the CdcDescriptor for this datastore

Throws:

DomainRuntimeException - if this is a shortcut. Use getRealObject to access.

See Also:

OdiDataStore.CdcDescriptor, setCdcDescriptor(CdcDescriptor)

setCdcDescriptor

public void setCdcDescriptor(OdiDataStore.CdcDescriptor pCdcDescriptor)

Sets a OdiDataStore.CdcDescriptor (i.e. journalization information) for this OdiDataStore instance.

Parameters:

pCdcDescriptor - the CdcDescriptor. When use setCdcDesciptor to change the Data Capture policy of an OdiDataStore, it is suggested to set the data store order to 0.

See Also:

OdiDataStore.CdcDescriptor, getCdcDescriptor()

getDataStoreId

public java.lang.Number getDataStoreId()

Returns the internal identifier of this OdiDataStore instance.

Returns:

the datastore internal id.

getDataStoreType

public OdiDataStore.DataStoreType getDataStoreType()

Returns the OdiDataStore.DataStoreType of this OdiDataStore instance.

Returns:

the datastore type

See Also:

setDataStoreType(DataStoreType)

getShortcutBaseObject

public OdiDataStore getShortcutBaseObject()

Description copied from interface: IOdiShortcutable

Return the base object of this shortcutable.

This will return null if the object never has been a shortcut. If this object is a materialized shortcut, the base object will be the base object at the time that this was shortcuted.

Specified by:

getShortcutBaseObject in interface IOdiShortcutable<OdiDataStore>

Returns:

T base object of this shortcut.

setShortcutBaseObject

public boolean setShortcutBaseObject(OdiDataStore pBaseObject)

Description copied from interface: IOdiShortcutable

Internal Use Only. Set the base object of this shortcutable.

If the base object is changed, we should correct all consumers of this object.
This method may be called from a precedent shortcut object in the shortcut chain and the precedent shortcut obejct is removed or materialized.

Specified by:

setShortcutBaseObject in interface IOdiShortcutable<OdiDataStore>

Parameters:

pBaseObject - new base object.

Returns:

true if this object was actually modified, else return false.

getShortcutReferenceObject

public OdiDataStore getShortcutReferenceObject()

Description copied from interface: IOdiShortcutable

If this is a shortcut, return the reference object.

The reference object may also be a shortcut.

Specified by:

getShortcutReferenceObject in interface IOdiShortcutable<OdiDataStore>

Returns:

T reference object of this shortcut.

setShortcutReferenceObject

public boolean setShortcutReferenceObject(OdiDataStore pReferenceObject)

Description copied from interface: IOdiShortcutable

Internal Use Only. Set reference of this shortcut.

If pShortcutable is null, set pReference to null. This is no longer a shortcut.
If pShortcutable is not null, set the reference object to pShortcutable, set the base object to pShortcutable.getBaseObject.
This method may be called from a precedent shortcut object in the shortcut chain and the precedent shortcut obejct is removed or materialized.

Specified by:

setShortcutReferenceObject in interface IOdiShortcutable<OdiDataStore>

Parameters:

pReferenceObject - new shortcutable object. Can be be null

Returns:

true if this object was actually modified. Else return false;

getShortcutOrigObject

public OdiDataStore getShortcutOrigObject()

Description copied from interface: IOdiShortcutable

If this is a shortcut, return the original base object

The reference object may also be a shortcut.

Specified by:

getShortcutOrigObject in interface IOdiShortcutable<OdiDataStore>

Returns:

T reference object of this shortcut.

isShortcut

public boolean isShortcut()

Description copied from interface: IOdiShortcutable

Returns true if this object is a shortcut.

Specified by:

isShortcut in interface IOdiShortcutable<OdiDataStore>

Returns:

true if this object is a shortcut. Else return false.

getReleaseTag

public IReleaseTag getReleaseTag()

Description copied from interface: IOdiShortcutable

Return the release tag for this object.

release tag is actually maintained on the container object. This provides consistent access to the tag.

Specified by:

getReleaseTag in interface IOdiShortcutable<OdiDataStore>

Returns:

Release tag of container object.

getRealObject

public OdiDataStore getRealObject()

Description copied from interface: IOdiShortcutable

Return the real object associated with this object.

This is a convenience function to obtain the real object of a shortcutable object. If this object is a shortcut, return the base obejct. If this object is not a shortcut, return this object.

Specified by:

getRealObject in interface IOdiShortcutable<OdiDataStore>

Returns:

Real object. The real object could be either this object or the base object.

setDataStoreType

public void setDataStoreType(OdiDataStore.DataStoreType pDatastoreType)

Sets the OdiDataStore.DataStoreType for this OdiDataStore instance.

By default, an OdiDataStore is defined with OdiDataStore.DataStoreType.TABLE.

Parameters:

pDatastoreType - the type of datastore

Throws:

DomainRuntimeException - if the parameter is null.

DomainRuntimeException - if this is a shortcut. Use getRealObject to access.

See Also:

OdiDataStore.DataStoreType, getDataStoreType()

getDefaultAlias

public java.lang.String getDefaultAlias()

Returns the default alias for this OdiDataStore instance.

Returns:

the alias.

Throws:

DomainRuntimeException - if this is a shortcut. Use getRealObject to access.

See Also:

setDefaultAlias(String)

setDefaultAlias

public void setDefaultAlias(java.lang.String pDefaultAlias)

Sets the default alias for this OdiDataStore. By default, this value is defined with this datastore's upper case name substring of length ALIAS_DEFAULT_LENGTH.

Parameters:

pDefaultAlias - the alias

Throws:

DomainRuntimeException - if the alias is null, empty or longer than ALIAS_MAX_LENGTH

DomainRuntimeException - if this is a shortcut. Use getRealObject to access.

See Also:

ALIAS_MAX_LENGTH, getDefaultAlias()

getDescription

public java.lang.String getDescription()

Returns the description for this OdiDataStore instance.

Returns:

the description.

See Also:

setDescription(String)

setDescription

public void setDescription(java.lang.String pDescription)

Defines the description for this OdiDataStore instance.

Parameters:

pDescription - the description

See Also:

getDescription()

getFileDescriptor

public OdiDataStore.FileDescriptor getFileDescriptor()

Get the OdiDataStore.FileDescriptor of this OdiDataStore instance (i.e. information relative to file technology). If this OdiDataStore instance is not of technology file, will be null.

Returns:

the file descriptor

Throws:

DomainRuntimeException - if this is a shortcut. Use getRealObject to access.

See Also:

setFileDescriptor(FileDescriptor)

setFileDescriptor

public void setFileDescriptor(OdiDataStore.FileDescriptor pFileDescriptor)

Set the OdiDataStore.FileDescriptor of this OdiDataStore instance (i.e. information relative to file technology).

This is not relevant for datastore that are not defined on a File OdiTechnology.

Parameters:

pFileDescriptor - file descriptor

Throws:

DomainRuntimeException - if this is a shortcut. Use getRealObject to access.

See Also:

getFileDescriptor()

getOlapType

public OdiDataStore.OlapType getOlapType()

Returns the OdiDataStore.OlapType of this OdiDataStore instance.

null value means that it has not been specified

Returns:

the OlapType of this datastore.

Throws:

DomainRuntimeException - if this is a shortcut. Use getRealObject to access.

See Also:

setOlapType(OlapType)

setOlapType

public void setOlapType(OdiDataStore.OlapType pOlapType)

Sets the OdiDataStore.OlapType for this OdiDataStore instance. null value is accepted and means that it has not been specified.

Parameters:

pOlapType - OLAP type

Throws:

DomainRuntimeException - if this is a shortcut. Use getRealObject to access.

See Also:

getOlapType()

getResourceName

public java.lang.String getResourceName()

Returns the resource name of this OdiDataStore instance.

Returns:

the resource name.

Throws:

DomainRuntimeException - if this is a shortcut. Use getRealObject to access.

See Also:

setResourceName(String)

setResourceName

public void setResourceName(java.lang.String pResourceName)

Sets the resource name of this OdiDataStore instance.

The name of the object in the form recognized by the data server that stores it. This may be a table name or a file name.

Parameters:

pResourceName - the resource name.

Throws:

DomainRuntimeException - if the resource name is null, empty or longer than 400

DomainRuntimeException - if this is a shortcut. Use getRealObject to access.

See Also:

getResourceName()

getModel

public OdiModel getModel()

Convenient method to obtain the OdiModel this OdiDataStore is referring from the AbstractOdiSubModel to which this datastore belongs. Same as invoking getSubModel().getModel().

Returns:

the model to which this datastore belongs.

getName

public java.lang.String getName()

Returns the name of this datastore.

Specified by:

getName in interface IOdiEntity

Specified by:

getName in interface IDataStore<OdiColumn,OdiKey>

Overrides:

getName in class oracle.odi.domain.support.AbstractOdiEntity

Returns:

the name.

See Also:

setName(String)

getRowCount

public java.lang.Integer getRowCount()

Returns the number of row of this OdiDataStore instance.

null value means it has'nt been computed yet.

Returns:

the number of row.

Throws:

DomainRuntimeException - if this is a shortcut. Use getRealObject to access.

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

getSubModel

public AbstractOdiSubModel getSubModel()

Returns the AbstractOdiSubModel that owns this datastore.

Returns:

the parent submodel.

See Also:

AbstractOdiSubModel

getInternalId

public java.io.Serializable getInternalId()

Returns the internal identifier for this datastore.

Specified by:

getInternalId in interface IRepositoryEntity

Returns:

the internal identifier.

See Also:

getDataStoreId()

getPrimaryKey

public OdiKey getPrimaryKey()

Returns the current primary key of the datastore.

Returns:

null if no primary key defined yet, the OdiKey otherwise

Throws:

DomainRuntimeException - if this is a shortcut. Use getRealObject to access.

See Also:

OdiKey, getKeys()

getKeys

public java.util.Collection<OdiKey> getKeys()

Returns the unmodifiable collection of OdiKeys.

Use removeKey(OdiKey) to remove elements from this collection.

Specified by:

getKeys in interface IDataStore<OdiColumn,OdiKey>

Returns:

the collection of keys.

Throws:

DomainRuntimeException - if this is a shortcut. Use getRealObject to access.

See Also:

removeKey(OdiKey)

removeKey

public void removeKey(OdiKey pKey)

Remove the given OdiKey from the collection of OdiKeys.

Parameters:

pKey - the key to remove.

Throws:

DomainRuntimeException - if pKey is null or does not belong to this datastore.

DomainRuntimeException - if this is a shortcut. Use getRealObject to access.

See Also:

getKeys()

getConditions

public java.util.Collection<OdiCondition> getConditions()

Returns an unmodifiable collection of OdiConditions that belongs to this datastore.

Use removeCondition(OdiCondition) to remove conditions from this collection.

Returns:

the collection of conditions.

Throws:

DomainRuntimeException - if this is a shortcut. Use getRealObject to access.

See Also:

removeCondition(OdiCondition)

removeCondition

public void removeCondition(OdiCondition pCondition)

Remove the given OdiCondition from the collection of OdiConditions that belongs to this OdiDataStore.

Parameters:

pCondition - the condition to remove.

Throws:

DomainRuntimeException - if pCondition is null or does not belong to this datastore

DomainRuntimeException - if this is a shortcut. Use getRealObject to access.

See Also:

getConditions()

getFilters

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

Returns an unmodifiable collection of OdiFilters that belongs to this datastore.

Use removeFilter(OdiFilter) to remove filter from this collection.

Returns:

the collection of filters.

Throws:

DomainRuntimeException - if this is a shortcut. Use getRealObject to access.

See Also:

removeFilter(OdiFilter)

removeFilter

public void removeFilter(OdiFilter pFilter)

Remove the given OdiFilter from the collection of OdiFilters that belong to this datastore.

Parameters:

pFilter - the filter to remove.

Throws:

DomainRuntimeException - if pFilter is null or does not belong to this OdiDataStore

DomainRuntimeException - if this is a shortcut. Use getRealObject to access.

See Also:

getFilters()

getOutboundReferences

public java.util.Collection<OdiReference> getOutboundReferences()

Returns an unmodifiable Collection of outbound references for this OdiDataStore.

Outbound references are references that use this datastore as foreign datastore. Use removeOutboundReference(OdiReference) to remove an outbound reference from this collection.

Returns:

the collection of outbound references.

Throws:

DomainRuntimeException - if this is a shortcut. Use getRealObject to access.

See Also:

removeOutboundReference(OdiReference)

removeOutboundReference

public void removeOutboundReference(OdiReference pReference)

Remove the given OdiReference from the collection of outbound OdiReferences that belong to this datastore.

Parameters:

pReference - the reference to remove

Throws:

DomainRuntimeException - if the given reference is null or if the given reference is not an outbound reference of this datastore

DomainRuntimeException - if this is a shortcut. Use getRealObject to access.

See Also:

getOutboundReferences()

setName

public void setName(java.lang.String pName)

Parameters:

pName -

Throws:

DomainRuntimeException - if the name is null, empty or longer that NAME_MAX_LENGTH

See Also:

NAME_MAX_LENGTH

getFlexFieldsValues

public java.util.Collection<IFlexFieldValue> getFlexFieldsValues()

See interface for specifics

Specified by:

getFlexFieldsValues in interface IFlexFieldUser

Returns:

an unmodifiable Collection of flex field values

Throws:

DomainRuntimeException - if this is a shortcut. Use getRealObject to access.

initFlexFields

public void initFlexFields(IOdiFlexFieldFinder pOdiFlexFieldFinder)

See interface for specifics.

Specified by:

initFlexFields in interface IFlexFieldUser

Parameters:

pOdiFlexFieldFinder - OdiFlexField finder to be used to query flex fields

Throws:

DomainRuntimeException - if this is a shortcut. Use getRealObject to access.

getMainPartitionPolicy

public OdiDataStore.PartitioningPolicy getMainPartitionPolicy()

Returns the OdiDataStore.PartitioningPolicy policy used for the main partitions of this datastore.

Returns:

the main partitions policy.

Throws:

DomainRuntimeException - if this is a shortcut. Use getRealObject to access.

See Also:

setMainPartitionPolicy(PartitioningPolicy), getMainPartitions()

setMainPartitionPolicy

public void setMainPartitionPolicy(OdiDataStore.PartitioningPolicy pMainPartitionPolicy)

Defines the OdiDataStore.PartitioningPolicy used for main partitions.

Parameters:

pMainPartitionPolicy - the partition policy.

Throws:

DomainRuntimeException - if this is a shortcut. Use getRealObject to access.

See Also:

getMainPartitionPolicy(), getMainPartitions()

getSubPartitionPolicy

public OdiDataStore.PartitioningPolicy getSubPartitionPolicy()

Returns the OdiDataStore.PartitioningPolicy policy used for the sub partitions of this datastore.

Returns:

the sub partitions policy.

Throws:

DomainRuntimeException - if this is a shortcut. Use getRealObject to access.

See Also:

OdiMainPartition.getSubPartitions(), OdiSubPartition, setSubPartitionPolicy(PartitioningPolicy)

setSubPartitionPolicy

public void setSubPartitionPolicy(OdiDataStore.PartitioningPolicy pSubPartitionPolicy)

Defines the OdiDataStore.PartitioningPolicy used for main partitions.

Parameters:

pSubPartitionPolicy - the partition policy.

Throws:

DomainRuntimeException - if this is a shortcut. Use getRealObject to access.

See Also:

OdiMainPartition.getSubPartitions(), OdiSubPartition, getSubPartitionPolicy()

removeMainPartition

public void removeMainPartition(OdiMainPartition pMainPartition)

Remove the given OdiMainPartition from the collection of OdiMainPartitions that belogns to this datastore.

Parameters:

pMainPartition - the partition to remove

Throws:

DomainRuntimeException - if pMainPartition is null or does not belong to this OdiDataStore

DomainRuntimeException - if this is a shortcut. Use getRealObject to access.

getMainPartitions

public java.util.Collection<OdiMainPartition> getMainPartitions()

Returns an unmodifiable collection of the OdiMainPartitions that belogns to this datastore.

Use removeMainPartition(OdiMainPartition) to remove elements from this collection.

Returns:

the collection of partitions.

Throws:

DomainRuntimeException - if this is a shortcut. Use getRealObject to access.

See Also:

removeMainPartition(OdiMainPartition)

setDisplayRequired

public void setDisplayRequired(boolean pRequired)

Defines whether this OdiDataStore is required to be displayed, or not.

Parameters:

pRequired - true to require this data store to be displayed, false otherwise.

isDisplayRequired

public boolean isDisplayRequired()

Returns whether this OdiDataStore is required to be displayed, or not.

Returns:

true if this data store should be displayed, false otherwise

setDeployAsDataService

public void setDeployAsDataService(boolean pDeployAsDataService)

Defines whether this datastore should be deployed as a data service.

When this is set to true and the dataServiceName and dataServicePublishedEntityName properties are undefined defaults value for this propertis will be computed.

For a table name of DEPT

• dataServiceName property will be set to Dept
• dataServicePublishedEntityName property will be set to WSDept

Parameters:

pDeployAsDataService - true if this data service should be deployed, false otherwise

Throws:

DomainRuntimeException - if this is a shortcut. Use getRealObject to access.

See Also:

setDataServiceName(String), setDataServicePublishedEntityName(String)

isDeployAsDataService

public boolean isDeployAsDataService()

Will this datastore to be deployed as a data service.

Returns:

true if this data service will be deployed, false otherwise

Throws:

DomainRuntimeException - if this is a shortcut. Use getRealObject to access.

setDataServiceName

public void setDataServiceName(java.lang.String pDataServiceName)

Set the name of the data service generated for this datastore.

Parameters:

pDataServiceName - name of the data service generated for this datastore. (May be null)

Throws:

DomainRuntimeException - if this is a shortcut. Use getRealObject to access.

See Also:

getDataServiceName()

getDataServiceName

public java.lang.String getDataServiceName()

Returns the name of the data service generated or to be generated for this datastore.

Returns:

he name of the data service. (May be null)

Throws:

DomainRuntimeException - if this is a shortcut. Use getRealObject to access.

See Also:

setDataServiceName(String)

setDataServicePublishedEntityName

public void setDataServicePublishedEntityName(java.lang.String pDataServicePublishedEntityName)

Defines the name that is used to generate all operations names for the data service.

For example, if you specify customer as the published entity, the generated operations will be named addcustomer, getcustomer, etc

Parameters:

pDataServicePublishedEntityName - the name that is used to generate all operations names. (May be null)

Throws:

DomainRuntimeException - if this is a shortcut. Use getRealObject to access.

See Also:

getDataServicePublishedEntityName()

getDataServicePublishedEntityName

public java.lang.String getDataServicePublishedEntityName()

Returns the name that is used to generate all operations names for the data service.

For example, if you specify customer as the published entity, the generated operations will be named addcustomer, getcustomer, etc

Returns:

the name that is used to generate all operations names for the data service (may be null)

See Also:

setDataServicePublishedEntityName(String)

Skip navigation links