Skip navigation links

oracle.odi.domain.topology
Class OdiPhysicalSchema

java.lang.Object
oracle.odi.domain.support.BusinessObject
oracle.odi.domain.support.AbstractRepositoryEntity
oracle.odi.domain.support.AbstractOdiEntity
oracle.odi.domain.topology.OdiPhysicalSchema

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, IFlexFieldUser, IMasterOdiEntity, IExportable, IOdiEntity, IRepositoryEntity, ISmartExportable

public class OdiPhysicalSchema

extends oracle.odi.domain.support.AbstractOdiEntity

implements IMasterOdiEntity, IExportable, IFlexFieldUser, ISmartExportable

An OdiPhysicalSchema is a physical schema defined for a data server into the physical topology of ODI. An instance of OdiPhysicalSchema belongs to a single instance of OdiDataServer and has to be used to defines ODI related properties of this schema.

When created using one of this class' constructors, an instance of OdiPhysicalSchema has default values where some of them are inherited from the OdiTechnology that belong to the OdiDataServer of this OdiPhysicalSchema.

Since a default OdiPhysicalSchema is required to be defined for an instance of OdiDataServer, when creating a new OdiPhysicalSchema for an OdiDataServer the default state of an OdiPhysicalSchema will be managed accordingly (if this schema is the first schema for that data server it will be automatically defined as the default one). Application code will be able to define the default schema calling the setAsDefault() method.

By default the name of an OdiPhysicalSchema is computed according the data server and technology it belongs using the given pattern: the name is computed using the follow pattern : DataServerName.SchemaName.CatalogName.
However this will apply only if the technology supports catalogs and/or schemas. If the technology doesn't support schema and catalog then a default value for the name will be provided but it you will be able to change that name.

Since:

11.1.1.3.0

See Also:

OdiDataServer, Serialized Form

Field Summary

static int	CATALOG_NAME_MAX_LENGTH Max length of catalog name.
static int	LOCAL_OBJECT_MASK_MAX_LENGTH Max length of local object name.
static int	LOCAL_SEQUENCE_MASK_MAX_LENGTH Max length of local sequence mask.
static int	NAME_MAX_LENGTH Max length of OdiPhysicalSchema's name.
static int	PARTITION_MASK_MAX_LENGTH Max length of partition mask.
static int	REMOTE_OBJECT_MASK_MAX_LENGTH Max length of remote object name.
static int	REMOTE_SEQUENCE_MASK_MAX_LENGTH Max length of remote sequence mask.
static int	SCHEMA_NAME_MAX_LENGTH Max length of schema name.
static int	SUB_PARTITION_MASK_MAX_LENGTH Max length of sub-partition mask.
static int	WORK_CATALOG_NAME_MAX_LENGTH Max length of work catalog name.
static int	WORK_SCHEMA_NAME_MAX_LENGTH Max length of work schema name.

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

STARTING_INTERNAL_VERSION

Constructor Summary

OdiPhysicalSchema(OdiDataServer pDataServer)
Construct a new OdiPhysicalSchema and add it to the given OdiDataServer's physical schemas.

Method Summary

java.lang.String	getCatalogName() Returns the catalog name of this schema.
OdiDataServer	getDataServer() Obtains the OdiDataServer related to this OdiPhysicalSchema.
java.lang.String	getErrorTablePrefix() Obtains the error table prefix.
java.util.Collection<IFlexFieldValue>	getFlexFieldsValues() Obtains flex fields values related to this IFlexFieldUser.
java.lang.String	getIntegrationTablePrefix() Obtains the integration table prefix.
java.io.Serializable	getInternalId() Provides a common getter for the persistence layer to obtain an identity, irrespective of the actual type of identity used.
java.lang.String	getJournalTablePrefix() Obtains the journal table prefix.
java.lang.String	getJournalTriggerPrefix() Obtains the journal trigger prefix.
java.lang.String	getJournalViewPrefix() Obtains the journal view prefix.
java.lang.String	getLoadingTablePrefix() Obtains the loading table prefix.
java.lang.String	getLocalObjectMask() Returns the Local Object Mask.
java.lang.String	getLocalSequenceMask() Obtains the local sequence mask.
java.lang.String	getName() Obtains the full read-only name of this OdiPhysicalSchema that is used internally by ODI.
java.lang.String	getPartitionMask() Obtains the partition mask.
java.lang.Number	getPhysicalSchemaId() Returns the Internal object ID.
java.lang.String	getRemoteObjectMask() Returns the Remote Object Mask.
java.lang.String	getRemoteSequenceMask() Obtains the remote sequence mask.
java.lang.String	getSchemaName() Returns the name of the underlying database schema.
IRepositoryEntity	getSecurityContainer() Define a generic way to retrieve container for entities.
java.lang.String	getSubPartitionMask() Obtains the sub partition mask.
java.lang.String	getTemporaryIndexPrefix() Obtains the temporary index prefix.
java.lang.String	getWorkCatalogName() Returns the work catalog name.
java.lang.String	getWorkSchemaName() Returns the work schema name.
void	initFlexFields(IOdiFlexFieldFinder pOdiFlexFieldFinder) Initialize flex fields related to this IFlexFieldUser.
boolean	isDefaultPhysicalSchema() Tells whether this is the default schema.
boolean	isNameComputed() Returns true if schema name has to be computed, false otherwise.
void	setAsDefault() Deprecated. use OdiDataServer.setDefaultPhysicalSchema(OdiPhysicalSchema) instead
void	setCatalogName(java.lang.String pCatalogName) Sets the catalog name of this schema.
void	setErrorTablePrefix(java.lang.String pErrorTablePrefix) Defines the error table prefix.
void	setIntegrationTablePrefix(java.lang.String pIntegrationTablePrefix) Defines the integration table prefix.
void	setJournalTablePrefix(java.lang.String pJournalTablePrefix) Defines the journal table prefix.
void	setJournalTriggerPrefix(java.lang.String pJournalTriggerPrefix) Defines the journal trigger prefix.
void	setJournalViewPrefix(java.lang.String pJournalViewPrefix) Defines the journal view prefix.
void	setLoadingTablePrefix(java.lang.String pLoadingTablePrefix) Defines the loading table prefix.
void	setLocalObjectMask(java.lang.String pLocalObjectMask) Sets the local Object Mask.
void	setLocalSequenceMask(java.lang.String pLocalSequenceMask) Defines the local sequence mask.
void	setName(java.lang.String pName) Set the name of this OdiPhysicalSchema.
void	setPartitionMask(java.lang.String pPartitionMask) Define the partition mask.
void	setRemoteObjectMask(java.lang.String pRemoteObjectMask) Sets the Remote Object Mask.
void	setRemoteSequenceMask(java.lang.String pRemoteSequenceMask) Defines the remote sequence mask.
void	setSchemaName(java.lang.String pSchemaName) Sets the name of the underlying database schema.
void	setSubPartitionMask(java.lang.String pSubPartitionMask) Define the sub partition mask.
void	setTemporaryIndexPrefix(java.lang.String pTemporaryIndexPrefix) Defines the temporary index prefix.
void	setWorkCatalogName(java.lang.String pWorkCatalogName) Sets the work catalog name.
void	setWorkSchemaName(java.lang.String pWorkSchemaName) Sets the work schema name.

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

equals, getFirstDate, getFirstUser, getInternalVersion, getLastDate, getLastUser, hashCode, isInstanceLevelSecurityNeeded, 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, isInstanceLevelSecurityNeeded

Field Detail

NAME_MAX_LENGTH

public static final int NAME_MAX_LENGTH

Max length of OdiPhysicalSchema's name.

See Also:

Constant Field Values

SCHEMA_NAME_MAX_LENGTH

public static final int SCHEMA_NAME_MAX_LENGTH

Max length of schema name.

See Also:

Constant Field Values

WORK_SCHEMA_NAME_MAX_LENGTH

public static final int WORK_SCHEMA_NAME_MAX_LENGTH

Max length of work schema name.

See Also:

Constant Field Values

CATALOG_NAME_MAX_LENGTH

public static final int CATALOG_NAME_MAX_LENGTH

Max length of catalog name.

See Also:

Constant Field Values

WORK_CATALOG_NAME_MAX_LENGTH

public static final int WORK_CATALOG_NAME_MAX_LENGTH

Max length of work catalog name.

See Also:

Constant Field Values

LOCAL_OBJECT_MASK_MAX_LENGTH

public static final int LOCAL_OBJECT_MASK_MAX_LENGTH

Max length of local object name.

See Also:

Constant Field Values

REMOTE_OBJECT_MASK_MAX_LENGTH

public static final int REMOTE_OBJECT_MASK_MAX_LENGTH

Max length of remote object name.

See Also:

Constant Field Values

PARTITION_MASK_MAX_LENGTH

public static final int PARTITION_MASK_MAX_LENGTH

Max length of partition mask.

See Also:

Constant Field Values

SUB_PARTITION_MASK_MAX_LENGTH

public static final int SUB_PARTITION_MASK_MAX_LENGTH

Max length of sub-partition mask.

See Also:

Constant Field Values

LOCAL_SEQUENCE_MASK_MAX_LENGTH

public static final int LOCAL_SEQUENCE_MASK_MAX_LENGTH

Max length of local sequence mask.

See Also:

Constant Field Values

REMOTE_SEQUENCE_MASK_MAX_LENGTH

public static final int REMOTE_SEQUENCE_MASK_MAX_LENGTH

Max length of remote sequence mask.

See Also:

Constant Field Values

Constructor Detail

OdiPhysicalSchema

public OdiPhysicalSchema(OdiDataServer pDataServer)

Construct a new OdiPhysicalSchema and add it to the given OdiDataServer's physical schemas.

This constructor will initialize the remoteObjectMask and localObjectMask properties from the ones defined on the related OdiTechnology.

This constructor will also defines the name of this OdiPhysicalSchema with a default name value obtained from the given OdiDataServer.

Parameters:

pDataServer - the parent data server

Method Detail

getInternalId

public java.io.Serializable getInternalId()

Description copied from interface: IRepositoryEntity

Provides a common getter for the persistence layer to obtain an identity, irrespective of the actual type of identity used.

Typically a subclass will delegate to a public SomePrimitiveWrapper getId() method. The necessity for the getInternalId() abstract method is solely because the persistence layer needs a way of obtaining the identity irrespective of the actual identity implementation choice.

Returning null from this method will indicate the object has never been saved. This will likely be relied on by some DAO implementations.

Specified by:

getInternalId in interface IRepositoryEntity

Returns:

the persistence identity of this instance

isDefaultPhysicalSchema

public boolean isDefaultPhysicalSchema()

Tells whether this is the default schema.

Returns:

true if this is the default schema, false otherwise

setAsDefault

public void setAsDefault()

Deprecated. use OdiDataServer.setDefaultPhysicalSchema(OdiPhysicalSchema) instead

Convenient method to define this OdiPhysicalSchema as default schema for its parent OdiDataServer.

See Also:

isDefaultPhysicalSchema()

getDataServer

public OdiDataServer getDataServer()

Obtains the OdiDataServer related to this OdiPhysicalSchema.

Returns:

related OdiDataServer

getCatalogName

public java.lang.String getCatalogName()

Returns the catalog name of this schema.

Returns:

catalog name

Throws:

DomainRuntimeException - if catalog is not suppported on the underlying technology

See Also:

OdiTechnology.isCatalogSupported(), setCatalogName(String)

setCatalogName

public void setCatalogName(java.lang.String pCatalogName)

Sets the catalog name of this schema.

Parameters:

pCatalogName - catalog name

Throws:

DomainRuntimeException - if catalog is not supported on the underlying technology

DomainRuntimeException - if catalog name is longer than 128

See Also:

OdiTechnology.isCatalogSupported(), getCatalogName()

getSchemaName

public java.lang.String getSchemaName()

Returns the name of the underlying database schema.

Returns:

schema name

Throws:

DomainRuntimeException - if schema is not supported on the underlying technology

See Also:

OdiTechnology.isSchemaSupported(), setSchemaName(String)

setSchemaName

public void setSchemaName(java.lang.String pSchemaName)

Sets the name of the underlying database schema. This will also reset this OdiPhysicalSchema's name accordingly.

Parameters:

pSchemaName - schema name

Throws:

DomainRuntimeException - if schema is not supported on the underlying technology

DomainRuntimeException - if Schema name is longer than 128

See Also:

OdiTechnology.isSchemaSupported(), getSchemaName()

getWorkCatalogName

public java.lang.String getWorkCatalogName()

Returns the work catalog name. Same rule as Catalog Name.

Returns:

work catalog name

Throws:

DomainRuntimeException - if catalog is not supported on the underlying technology

See Also:

getCatalogName(), setWorkCatalogName(String)

setWorkCatalogName

public void setWorkCatalogName(java.lang.String pWorkCatalogName)

Sets the work catalog name. Same rule as Catalog Name.

Parameters:

pWorkCatalogName - work catalog name

Throws:

DomainRuntimeException - if catalog is not supported on the underlying technology

DomainRuntimeException - if catalog's name is longer than 128

See Also:

setCatalogName(String), getWorkCatalogName()

getWorkSchemaName

public java.lang.String getWorkSchemaName()

Returns the work schema name. Same rule as Schema Name.

Returns:

work schema name

Throws:

DomainRuntimeException - if schema is not supported on the underlying technology

See Also:

getSchemaName(), setWorkSchemaName(String)

setWorkSchemaName

public void setWorkSchemaName(java.lang.String pWorkSchemaName)

Sets the work schema name. Same rule as Schema Name.

Parameters:

pWorkSchemaName - work schema name

Throws:

DomainRuntimeException - if schema is not supported on the underlying technology

DomainRuntimeException - if schema's name is longer than 128

See Also:

setSchemaName(String), getWorkSchemaName()

getName

public java.lang.String getName()

Obtains the full read-only name of this OdiPhysicalSchema that is used internally by ODI.

Specified by:

getName in interface IOdiEntity

Overrides:

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

Returns:

entity name

See Also:

setName(String)

setName

public void setName(java.lang.String pName)

Set the name of this OdiPhysicalSchema.

This can only be set if the name is not computed. This means the underlying technology doesn't supports catalog or schema or both.

Parameters:

pName - the name

Throws:

DomainRuntimeException - if name is computed

DomainRuntimeException - if Name is longer than 400

See Also:

getName()

isNameComputed

public boolean isNameComputed()

Returns true if schema name has to be computed, false otherwise.

Returns:

true if schema name has to be computed, false otherwise

getPhysicalSchemaId

public java.lang.Number getPhysicalSchemaId()

Returns the Internal object ID.

Returns:

the id

getErrorTablePrefix

public java.lang.String getErrorTablePrefix()

Obtains the error table prefix.

Returns:

error table prefix

See Also:

setErrorTablePrefix(String)

setErrorTablePrefix

public void setErrorTablePrefix(java.lang.String pErrorTablePrefix)

Defines the error table prefix.

By default, this property is the same as defined in OdiTechnology this OdiPhysicalSchema belongs to.

Parameters:

pErrorTablePrefix - error table prefix

Throws:

DomainRuntimeException - if Error prefix table is null or longer than

See Also:

getErrorTablePrefix(), OdiTechnology.getErrorTablePrefix()

getTemporaryIndexPrefix

public java.lang.String getTemporaryIndexPrefix()

Obtains the temporary index prefix.

Returns:

temporary index prefix

See Also:

setTemporaryIndexPrefix(String)

setTemporaryIndexPrefix

public void setTemporaryIndexPrefix(java.lang.String pTemporaryIndexPrefix)

Defines the temporary index prefix.

By default, this property is the same as defined in OdiTechnology this OdiPhysicalSchema belongs to.

Parameters:

pTemporaryIndexPrefix - temporary index prefix

Throws:

DomainRuntimeException - if temporary index is lnull or onger than

See Also:

getTemporaryIndexPrefix(), OdiTechnology.getTemporaryIndexPrefix()

getIntegrationTablePrefix

public java.lang.String getIntegrationTablePrefix()

Obtains the integration table prefix.

Returns:

integration table prefix

See Also:

setIntegrationTablePrefix(String)

setIntegrationTablePrefix

public void setIntegrationTablePrefix(java.lang.String pIntegrationTablePrefix)

Defines the integration table prefix.

By default, this property is the same as defined in OdiTechnology this OdiPhysicalSchema belongs to.

Parameters:

pIntegrationTablePrefix - integration table prefix

Throws:

DomainRuntimeException - if integration table prefix is lnull or onger than

See Also:

getIntegrationTablePrefix(), OdiTechnology.getIntegrationTablePrefix()

getJournalTablePrefix

public java.lang.String getJournalTablePrefix()

Obtains the journal table prefix.

Returns:

journal table prefix

See Also:

setJournalTablePrefix(String)

setJournalTablePrefix

public void setJournalTablePrefix(java.lang.String pJournalTablePrefix)

Defines the journal table prefix.

By default, this property is the same as defined in OdiTechnology this OdiPhysicalSchema belongs to.

Parameters:

pJournalTablePrefix - journal table prefix

Throws:

DomainRuntimeException - if Journal table prefix is lnull or onger than

See Also:

getJournalTablePrefix(), #getJournalTablePrefix()#getJournalTablePrefix()

getJournalTriggerPrefix

public java.lang.String getJournalTriggerPrefix()

Obtains the journal trigger prefix.

Returns:

journal table prefix

See Also:

setJournalTriggerPrefix(String)

setJournalTriggerPrefix

public void setJournalTriggerPrefix(java.lang.String pJournalTriggerPrefix)

Defines the journal trigger prefix.

By default, this property is the same as defined in OdiTechnology this OdiPhysicalSchema belongs to.

Parameters:

pJournalTriggerPrefix - journal trigger prefix

Throws:

DomainRuntimeException - if Journal table prefix is lnull or onger than

See Also:

getJournalTriggerPrefix(), OdiTechnology.getJournalTriggerPrefix()

getJournalViewPrefix

public java.lang.String getJournalViewPrefix()

Obtains the journal view prefix.

Returns:

journal view prefix

See Also:

setJournalViewPrefix(String)

setJournalViewPrefix

public void setJournalViewPrefix(java.lang.String pJournalViewPrefix)

Defines the journal view prefix.

By default, this property is the same as defined in OdiTechnology this OdiPhysicalSchema belongs to.

Parameters:

pJournalViewPrefix - view prefix

Throws:

DomainRuntimeException - if Journal table prefix is lnull or onger than

See Also:

getJournalViewPrefix(), OdiTechnology.getJournalViewPrefix()

getLoadingTablePrefix

public java.lang.String getLoadingTablePrefix()

Obtains the loading table prefix.

Returns:

loading table prefix

See Also:

setLoadingTablePrefix(String)

setLoadingTablePrefix

public void setLoadingTablePrefix(java.lang.String pLoadingTablePrefix)

Defines the loading table prefix.

By default, this property is the same as defined in OdiTechnology this OdiPhysicalSchema belongs to.

Parameters:

pLoadingTablePrefix - table prefix

Throws:

DomainRuntimeException - if Loading table prefix is lnull or onger than

See Also:

getLoadingTablePrefix(), OdiTechnology.getLoadingTablePrefix()

getLocalObjectMask

public java.lang.String getLocalObjectMask()

Returns the Local Object Mask.

Returns:

a mask

See Also:

setLocalObjectMask(String)

setLocalObjectMask

public void setLocalObjectMask(java.lang.String pLocalObjectMask)

Sets the local Object Mask.

By default, this property is the same as defined in OdiTechnology this OdiPhysicalSchema belongs to.

Parameters:

pLocalObjectMask - local object mask

Throws:

DomainRuntimeException - if local object mask is null or longer than 100

See Also:

getLocalObjectMask()

getRemoteObjectMask

public java.lang.String getRemoteObjectMask()

Returns the Remote Object Mask.

Returns:

a mask

See Also:

setRemoteObjectMask(String)

setRemoteObjectMask

public void setRemoteObjectMask(java.lang.String pRemoteObjectMask)

Sets the Remote Object Mask.

By default, this property is the same as defined in OdiTechnology this OdiPhysicalSchema belongs to.

Parameters:

pRemoteObjectMask - remote object mask

Throws:

DomainRuntimeException - if remote object mask is null or longer than 100

See Also:

getRemoteObjectMask()

getPartitionMask

public java.lang.String getPartitionMask()

Obtains the partition mask.

Returns:

a mask

See Also:

setPartitionMask(String)

setPartitionMask

public void setPartitionMask(java.lang.String pPartitionMask)

Define the partition mask.

By default, this property is the same as defined in OdiTechnology this OdiPhysicalSchema belongs to.

Parameters:

pPartitionMask - the partition mask

Throws:

DomainRuntimeException - if partition mask is null or longer than 250

See Also:

getPartitionMask()

getSubPartitionMask

public java.lang.String getSubPartitionMask()

Obtains the sub partition mask.

Returns:

a mask

See Also:

setSubPartitionMask(String)

setSubPartitionMask

public void setSubPartitionMask(java.lang.String pSubPartitionMask)

Define the sub partition mask.

By default, this property is the same as defined in OdiTechnology this OdiPhysicalSchema belongs to.

Parameters:

pSubPartitionMask - the partition mask

Throws:

DomainRuntimeException - if sub partition mask is null or longer than 250

See Also:

getSubPartitionMask()

setLocalSequenceMask

public void setLocalSequenceMask(java.lang.String pLocalSequenceMask)

Defines the local sequence mask.

By default, this property is the same as defined in OdiTechnology this OdiPhysicalSchema belongs to.

Parameters:

pLocalSequenceMask - the sequence mask

Throws:

DomainRuntimeException - if sequence mask is null or longer than 100

See Also:

getLocalSequenceMask()

getLocalSequenceMask

public java.lang.String getLocalSequenceMask()

Obtains the local sequence mask.

Returns:

a mask

See Also:

setLocalSequenceMask(String)

setRemoteSequenceMask

public void setRemoteSequenceMask(java.lang.String pRemoteSequenceMask)

Defines the remote sequence mask.

By default, this property is the same as defined in OdiTechnology this OdiPhysicalSchema belongs to.

Parameters:

pRemoteSequenceMask - the sequence mask

Throws:

DomainRuntimeException - if sequence mask is null or longer than 100

See Also:

getRemoteSequenceMask()

getRemoteSequenceMask

public java.lang.String getRemoteSequenceMask()

Obtains the remote sequence mask.

Returns:

a mask

See Also:

setRemoteSequenceMask(String)

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

getFlexFieldsValues

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

Description copied from interface: IFlexFieldUser

Obtains flex fields values related to this IFlexFieldUser.

Specified by:

getFlexFieldsValues in interface IFlexFieldUser

Returns:

an unmodifiable Collection of flex field values

Since:

11.1.1.5.0

initFlexFields

public void initFlexFields(IOdiFlexFieldFinder pOdiFlexFieldFinder)

Description copied from interface: IFlexFieldUser

Initialize flex fields related to this IFlexFieldUser.

Specified by:

initFlexFields in interface IFlexFieldUser

Parameters:

pOdiFlexFieldFinder - OdiFlexField finder to be used to query flex fields

Since:

11.1.1.5.0

Skip navigation links