|
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.model.OdiKey
public class OdiKey
A key for an OdiDataStore
.
The type of key (i.e. Primary Key, Alternative Key or Index) can be controlled using the
type safe enum OdiKey.KeyType
and the method setKeyType(oracle.odi.domain.model.OdiKey.KeyType)
.
Nested Class Summary | |
---|---|
static class |
OdiKey.KeyType
Defines the type of an OdiKey instance. |
Field Summary | |
---|---|
static int |
NAME_MAX_LENGTH
Maximum length supported for the "name" property. |
Fields inherited from class oracle.odi.domain.support.AbstractOdiEntity |
---|
STARTING_INTERNAL_VERSION |
Constructor Summary | |
---|---|
OdiKey(OdiDataStore pDataStore,
java.lang.String pName)
Construct a new OdiKey. |
Method Summary | |
---|---|
void |
addColumn(OdiColumn pColumn)
Adds the given column to this OdiKey instance. |
java.util.List<OdiColumn> |
getColumns()
Returns an unmodifiable list of the columns that are part of this key. |
OdiDataStore |
getDataStore()
Returns the OdiDataStore this OdiKey belongs to. |
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.Number |
getKeyId()
Returns the internal identifier of this OdiKey instance. |
OdiKey.KeyType |
getKeyType()
Returns the OdiKey.KeyType of this OdiKey instance. |
java.lang.String |
getName()
Returns the name of this OdiKey instance. |
IRepositoryEntity |
getSecurityContainer()
Define a generic way to retrieve container for entities. |
boolean |
isActive()
Returns whether this key is active (enabled) or not in the database. |
boolean |
isFlowCheckEnabled()
Returns whether the flow check is enabled for this key, or not. |
boolean |
isInDatabase()
Returns whether this key is implemented in database or not. |
boolean |
isStaticCheckEnabled()
Returns whether the static check is enabled for this key, or not. |
void |
removeColumn(OdiColumn pColumn)
Remove the the given column from this key. |
void |
setActive(boolean pActive)
Defines whether this key is active (enabled) or inactive (disabled) in the database. |
void |
setFlowCheckEnabled(boolean pFlowCheckEnabled)
Defines whether the flow check is enabled for this key, or not. |
void |
setInDatabase(boolean pInDatabase)
Defines whether this key is implemented in database or not. |
void |
setKeyType(OdiKey.KeyType pKeyType)
Sets the OdiKey.KeyType for this OdiKey . |
void |
setStaticCheckEnabled(boolean pStaticCheckEnabled)
Defines whether the static check is enabled for this key, or not. |
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 NAME_MAX_LENGTH
OdiKey(OdiDataStore, String)
,
Constant Field ValuesConstructor Detail |
---|
public OdiKey(OdiDataStore pDataStore, java.lang.String pName)
This constructor sets the parent OdiDataStore
and the name of this OdiKey
instance.
pDataStore
- the datastore this key belongs to.pName
- the name of this key
java.lang.IllegalArgumentException
- if the datastore is null or if the name is null, empty or longer than 128Method Detail |
---|
public void addColumn(OdiColumn pColumn)
OdiKey
instance.
This makes the given column participating in this key object at last position index.
pColumn
- the column to add
java.lang.IllegalArgumentException
- if pColumn is null or does not belong to the OdiDataStore
to which this key belongs.getColumns()
,
removeColumn(OdiColumn)
public java.util.List<OdiColumn> getColumns()
The returned list is ordered by columns' position in this key object.
getColumns
in interface IKey<OdiColumn>
addColumn(OdiColumn)
,
removeColumn(OdiColumn)
public OdiDataStore getDataStore()
OdiDataStore
this OdiKey
belongs to.
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.Number getKeyId()
OdiKey
instance.
public OdiKey.KeyType getKeyType()
OdiKey.KeyType
of this OdiKey
instance.
setKeyType(KeyType)
public java.lang.String getName()
OdiKey
instance.
getName
in interface IOdiEntity
getName
in interface IKey<OdiColumn>
getName
in class oracle.odi.domain.support.AbstractOdiEntity
public IRepositoryEntity getSecurityContainer()
IRepositoryEntity
getSecurityContainer
in interface IRepositoryEntity
public boolean isActive()
true
if the key is active, false
otherwisesetActive(boolean)
public boolean isFlowCheckEnabled()
true
if enabled, false
otherwisesetFlowCheckEnabled(boolean)
public boolean isInDatabase()
true
if this key is defined as implemented database, false
otherwise.setInDatabase(boolean)
public boolean isStaticCheckEnabled()
true
if enabled, false
otherwisesetStaticCheckEnabled(boolean)
public void removeColumn(OdiColumn pColumn)
This makes the given column to do not participate to this key object anymore. Positions of each columns in this key will be rearranged accordingly.
pColumn
- the column to remove from this key
java.lang.IllegalArgumentException
- if the column is null
or is not part of this keygetColumns()
,
addColumn(OdiColumn)
public void setActive(boolean pActive)
By default, this property is set to true
.
pActive
- true
to make this key enabled, false
to make it disabledisActive()
public void setFlowCheckEnabled(boolean pFlowCheckEnabled)
By default, this property is set to true
.
pFlowCheckEnabled
- true
if enabled, false
otherwiseisFlowCheckEnabled()
public void setInDatabase(boolean pInDatabase)
By default, this property is set to false
.
pInDatabase
- true
if this key is implemented in database, false
otherwiseisInDatabase()
public void setKeyType(OdiKey.KeyType pKeyType) throws java.lang.IllegalArgumentException
OdiKey.KeyType
for this OdiKey
.
By default, the type of an OdiKey is set to OdiKey.KeyType.ALTERNATE_KEY
.
pKeyType
- the type of the key
java.lang.IllegalArgumentException
- if the given parameter is null or
if trying to set to PRIMARY_KEY and datastore already has a PKgetKeyType()
public void setStaticCheckEnabled(boolean pStaticCheckEnabled)
By default, this property is set to true
.
pStaticCheckEnabled
- true
if enabled, false
otherwiseisStaticCheckEnabled()
|
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 |