|
Oracle® Data Integrator Java API Reference 11g Release 1 (11.1.1.3.0) E17060-01 |
||||||||
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.support.AbstractOdiEntity oracle.odi.domain.topology.OdiPhysicalSchema
public class OdiPhysicalSchema
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.
OdiDataServer
,
Serialized FormField Summary | |
---|---|
static int |
CATALOG_NAME_MAX_LENGTH
Max length of catalog name. |
static java.lang.String |
DEFAULT_ERROR_TABLE_PREFIX
The default value for the errorTablePrefix. |
static java.lang.String |
DEFAULT_INTEGRATION_TABLE_PREFIX
The default value for the integrationTablePrefix. |
static java.lang.String |
DEFAULT_JOURNAL_TABLE_PREFIX
The default value for the journalTablePrefix. |
static java.lang.String |
DEFAULT_JOURNAL_TRIGGER_PREFIX
The default value for the journalTriggerPrefix. |
static java.lang.String |
DEFAULT_JOURNAL_VIEW_PREFIX
The default value for the journalViwPrefix. |
static java.lang.String |
DEFAULT_LOADING_TABLE_PREFIX
The default value for the loadingTablePrefix. |
static java.lang.String |
DEFAULT_TEMPORARY_INDEX_PREFIX
The default value for the temporaryIndexPrefix. |
static int |
ERROR_TABLE_PREFIX_MAX_LENGTH
Max length of error table prefix. |
static int |
INTEGRATION_TABLE_PREFIX_MAX_LENGTH
Max length of integration table prefix. |
static int |
JOURNAL_TABLE_PREFIX_MAX_LENGTH
Max length of journal table prefix. |
static int |
JOURNAL_TRIGGER_PREFIX_MAX_LENGTH
Max length of journal trigger prefix. |
static int |
JOURNAL_VIEW_PREFIX_MAX_LENGTH
Max length of journal view prefix. |
static int |
LOADING_TABLE_PREFIX_MAX_LENGTH
Max length of loading table prefix. |
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 |
TEMPORARY_INDEX_PREFIX_MAX_LENGTH
Max length of temporary index prefix. |
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.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. |
boolean |
isDefaultPhysicalSchema()
Tells whether this is the default schema. |
boolean |
isNameComputed()
Returns true if schema name has to be computed,
false otherwise. |
void |
setAsDefault()
Convenient method to define this OdiPhysicalSchema as default schema for its
parent OdiDataServer . |
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 |
---|
public static final int CATALOG_NAME_MAX_LENGTH
public static final java.lang.String DEFAULT_ERROR_TABLE_PREFIX
public static final java.lang.String DEFAULT_INTEGRATION_TABLE_PREFIX
public static final java.lang.String DEFAULT_JOURNAL_TABLE_PREFIX
public static final java.lang.String DEFAULT_JOURNAL_TRIGGER_PREFIX
public static final java.lang.String DEFAULT_JOURNAL_VIEW_PREFIX
public static final java.lang.String DEFAULT_LOADING_TABLE_PREFIX
public static final java.lang.String DEFAULT_TEMPORARY_INDEX_PREFIX
public static final int ERROR_TABLE_PREFIX_MAX_LENGTH
public static final int INTEGRATION_TABLE_PREFIX_MAX_LENGTH
public static final int JOURNAL_TABLE_PREFIX_MAX_LENGTH
public static final int JOURNAL_TRIGGER_PREFIX_MAX_LENGTH
public static final int JOURNAL_VIEW_PREFIX_MAX_LENGTH
public static final int LOADING_TABLE_PREFIX_MAX_LENGTH
public static final int LOCAL_OBJECT_MASK_MAX_LENGTH
public static final int LOCAL_SEQUENCE_MASK_MAX_LENGTH
public static final int NAME_MAX_LENGTH
OdiPhysicalSchema
's name.
public static final int PARTITION_MASK_MAX_LENGTH
public static final int REMOTE_OBJECT_MASK_MAX_LENGTH
public static final int REMOTE_SEQUENCE_MASK_MAX_LENGTH
public static final int SCHEMA_NAME_MAX_LENGTH
public static final int SUB_PARTITION_MASK_MAX_LENGTH
public static final int TEMPORARY_INDEX_PREFIX_MAX_LENGTH
public static final int WORK_CATALOG_NAME_MAX_LENGTH
public static final int WORK_SCHEMA_NAME_MAX_LENGTH
Constructor Detail |
---|
public OdiPhysicalSchema(OdiDataServer pDataServer)
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
.
pDataServer
- the parent data serverMethod Detail |
---|
public java.lang.String getCatalogName()
java.lang.IllegalStateException
- if catalog is not suppported on the underlying technologyOdiTechnology.isCatalogSupported()
,
setCatalogName(String)
public OdiDataServer getDataServer()
OdiDataServer
related to this OdiPhysicalSchema
.
OdiDataServer
public java.lang.String getErrorTablePrefix()
setErrorTablePrefix(String)
public java.lang.String getIntegrationTablePrefix()
setIntegrationTablePrefix(String)
public java.io.Serializable getInternalId()
IRepositoryEntity
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.
getInternalId
in interface IRepositoryEntity
public java.lang.String getJournalTablePrefix()
setJournalTablePrefix(String)
public java.lang.String getJournalTriggerPrefix()
setJournalTriggerPrefix(String)
public java.lang.String getJournalViewPrefix()
setJournalViewPrefix(String)
public java.lang.String getLoadingTablePrefix()
setLoadingTablePrefix(String)
public java.lang.String getLocalObjectMask()
setLocalObjectMask(String)
public java.lang.String getLocalSequenceMask()
setLocalSequenceMask(String)
public java.lang.String getName()
OdiPhysicalSchema
that is used
internally by ODI.
getName
in interface IOdiEntity
getName
in class oracle.odi.domain.support.AbstractOdiEntity
setName(String)
public java.lang.String getPartitionMask()
setPartitionMask(String)
public java.lang.Number getPhysicalSchemaId()
public java.lang.String getRemoteObjectMask()
setRemoteObjectMask(String)
public java.lang.String getRemoteSequenceMask()
setRemoteSequenceMask(String)
public java.lang.String getSchemaName()
java.lang.IllegalStateException
- if schema is not supported on the underlying technologyOdiTechnology.isSchemaSupported()
,
setSchemaName(String)
public IRepositoryEntity getSecurityContainer()
IRepositoryEntity
getSecurityContainer
in interface IRepositoryEntity
public java.lang.String getSubPartitionMask()
setSubPartitionMask(String)
public java.lang.String getTemporaryIndexPrefix()
setTemporaryIndexPrefix(String)
public java.lang.String getWorkCatalogName()
java.lang.IllegalStateException
- if catalog is not supported on the underlying technologygetCatalogName()
,
setWorkCatalogName(String)
public java.lang.String getWorkSchemaName()
java.lang.IllegalStateException
- if schema is not supported on the underlying technologygetSchemaName()
,
setWorkSchemaName(String)
public boolean isDefaultPhysicalSchema()
true
if this is the default schema, false
otherwisepublic boolean isNameComputed()
true
if schema name has to be computed,
false
otherwise.
true
if schema name has to be computed, false
otherwisepublic void setAsDefault()
OdiPhysicalSchema
as default schema for its
parent OdiDataServer
.
isDefaultPhysicalSchema()
public void setCatalogName(java.lang.String pCatalogName)
pCatalogName
- catalog name
java.lang.IllegalStateException
- if catalog is not supported on the underlying technology
java.lang.IllegalArgumentException
- if catalog name is longer than 128OdiTechnology.isCatalogSupported()
,
getCatalogName()
public void setErrorTablePrefix(java.lang.String pErrorTablePrefix)
By default, that property is initialized with the DEFAULT_ERROR_TABLE_PREFIX
constant field value.
pErrorTablePrefix
- error table prefix
java.lang.IllegalArgumentException
- if Error prefix table is longer than ERROR_TABLE_PREFIX_MAX_LENGTHgetErrorTablePrefix()
public void setIntegrationTablePrefix(java.lang.String pIntegrationTablePrefix)
By default, that property is initialized with the DEFAULT_INTEGRATION_TABLE_PREFIX
constant field value.
pIntegrationTablePrefix
- integration table prefix
java.lang.IllegalArgumentException
- if integration table prefix is longer than
35getIntegrationTablePrefix()
public void setJournalTablePrefix(java.lang.String pJournalTablePrefix)
By default, that property is initialized with the DEFAULT_JOURNAL_TABLE_PREFIX
constant field value.
pJournalTablePrefix
- journal table prefix
java.lang.IllegalArgumentException
- if Journal table prefix is longer than JOURNAL_TABLE_PREFIX_MAX_LENGTHgetJournalTablePrefix()
public void setJournalTriggerPrefix(java.lang.String pJournalTriggerPrefix)
By default, that property is initialized with the DEFAULT_JOURNAL_TRIGGER_PREFIX
constant field value.
pJournalTriggerPrefix
- journal trigger prefix
java.lang.IllegalArgumentException
- if Journal table prefix is longer than JOURNAL_TRIGGER_PREFIX_MAX_LENGTHgetJournalTriggerPrefix()
public void setJournalViewPrefix(java.lang.String pJournalViewPrefix)
By default, that property is initialized with the DEFAULT_JOURNAL_VIEW_PREFIX
constant field value.
pJournalViewPrefix
- view prefix
java.lang.IllegalArgumentException
- if Journal table prefix is longer than JOURNAL_VIEW_PREFIX_MAX_LENGTHgetJournalViewPrefix()
public void setLoadingTablePrefix(java.lang.String pLoadingTablePrefix)
By default, that property is initialized with the DEFAULT_LOADING_TABLE_PREFIX
constant field value.
pLoadingTablePrefix
- table prefix
java.lang.IllegalArgumentException
- if Loading table prefix is longer than LOADING_TABLE_PREFIX_MAX_LENGTHgetLoadingTablePrefix()
public void setLocalObjectMask(java.lang.String pLocalObjectMask)
By default is inherited from getDataServer().getTechnology().getLocalObjectMask()
.
pLocalObjectMask
- local object mask
java.lang.IllegalArgumentException
- if local object mast is longer than LOCAL_OBJECT_MASK_MAX_LENGTHgetLocalObjectMask()
public void setLocalSequenceMask(java.lang.String pLocalSequenceMask)
By default, it is the same as defined in OdiTechnology this schema belongs.
pLocalSequenceMask
- the sequence mask
java.lang.IllegalArgumentException
- if sequence mask is longer than LOCAL_SEQUENCE_MASK_MAX_LENGTHgetLocalSequenceMask()
public void setName(java.lang.String pName)
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.
pName
- the name
java.lang.IllegalStateException
- if name is computed
java.lang.IllegalArgumentException
- if Name is longer than 400getName()
public void setPartitionMask(java.lang.String pPartitionMask)
By default, it is the same as defined in OdiTechnology this schema belongs.
pPartitionMask
- the partition mask
java.lang.IllegalArgumentException
- if partition mask is longer than PARTITION_MASK_MAX_LENGTHgetPartitionMask()
public void setRemoteObjectMask(java.lang.String pRemoteObjectMask)
By default is inherited from getDataServer().getTechnology().getRemoteObjectMask()
.
pRemoteObjectMask
- remote object mask
java.lang.IllegalArgumentException
- if remote object mask is longer than REMOTE_OBJECT_MASK_MAX_LENGTHgetRemoteObjectMask()
public void setRemoteSequenceMask(java.lang.String pRemoteSequenceMask)
By default, it is the same as defined in OdiTechnology this schema belongs.
pRemoteSequenceMask
- the sequence mask
java.lang.IllegalArgumentException
- if sequence mask is longer than REMOTE_SEQUENCE_MASK_MAX_LENGTHgetRemoteSequenceMask()
public void setSchemaName(java.lang.String pSchemaName)
OdiPhysicalSchema
's
name accordingly.
pSchemaName
- schema name
java.lang.IllegalStateException
- if schema is not supported on the underlying technology
java.lang.IllegalArgumentException
- if Schema name is longer than 128OdiTechnology.isSchemaSupported()
,
getSchemaName()
public void setSubPartitionMask(java.lang.String pSubPartitionMask)
By default, it is the same as defined in OdiTechnology this schema belongs.
pSubPartitionMask
- the partition mask
java.lang.IllegalArgumentException
- if sub partition mask is longer than SUB_PARTITION_MASK_MAX_LENGTHgetSubPartitionMask()
public void setTemporaryIndexPrefix(java.lang.String pTemporaryIndexPrefix)
By default, that property is initialized with the DEFAULT_TEMPORARY_INDEX_PREFIX
constant field value.
pTemporaryIndexPrefix
- temporary index prefix
java.lang.IllegalArgumentException
- if temporary index is longer than 35getTemporaryIndexPrefix()
public void setWorkCatalogName(java.lang.String pWorkCatalogName)
pWorkCatalogName
- work catalog name
java.lang.IllegalStateException
- if catalog is not supported on the underlying technology
java.lang.IllegalArgumentException
- if catalog's name is longer than 128setCatalogName(String)
,
getWorkCatalogName()
public void setWorkSchemaName(java.lang.String pWorkSchemaName)
pWorkSchemaName
- work schema name
java.lang.IllegalStateException
- if schema is not supported on the underlying technology
java.lang.IllegalArgumentException
- if schema's name is longer than 128setSchemaName(String)
,
getWorkSchemaName()
|
Oracle® Data Integrator Java API Reference 11g Release 1 (11.1.1.3.0) E17060-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |