public class ReferenceColumn
extends oracle.odi.domain.support.AbstractRepositoryEntity
OdiReference
.
For user or database references, a list of the correspondence between the foreign key table columns (child table)
and the primary key table (parent or referenced table) must be defined.
The reference column maintains this correspondence.
Modifier and Type | Class and Description |
---|---|
static class |
ReferenceColumn.ReferenceColumnId
Internal: .
|
Constructor and Description |
---|
ReferenceColumn(OdiReference pReference,
OdiColumn pForeignKeyColumn,
OdiColumn pPrimaryKeyColumn)
Creates an
ReferenceColumn for the given Foreign Key and Primary Key
columns and add it to the given OdiReference . |
Modifier and Type | Method and Description |
---|---|
OdiColumn |
getForeignKeyColumn()
Obtains the foreign key column of this
ReferenceColumn instance. |
java.io.Serializable |
getInternalId()
Provides a common getter for the persistence layer to obtain an identity,
irrespective of the actual type of identity used.
|
OdiColumn |
getPrimaryKeyColumn()
Obtains the primary key column of this
ReferenceColumn instance. |
OdiReference |
getReference()
Obtain the
OdiReference this ReferenceColumn belongs to. |
IRepositoryEntity |
getSecurityContainer()
Define a generic way to retrieve container for entities.
|
public ReferenceColumn(OdiReference pReference, OdiColumn pForeignKeyColumn, OdiColumn pPrimaryKeyColumn)
ReferenceColumn
for the given Foreign Key and Primary Key
columns and add it to the given OdiReference
.
In order to be able to create an ReferenceColumn
, you must ensure that
everything is consistent (i.e. the reference's primary datastore has to be defined, the foreign and
primary columns must be consistent with the reference foreign and primary datastore).
Otherwise, an Exception will be thrown.
pReference
- the parent OdiReference objectpForeignKeyColumn
- the FK columnpPrimaryKeyColumn
- the PK columnDomainRuntimeException
- if the given reference has an undefined primary datastoreDomainRuntimeException
- if the given reference's type is OdiReference.ReferenceType.COMPLEX_REFERENCE
public OdiColumn getPrimaryKeyColumn()
ReferenceColumn
instance.public OdiColumn getForeignKeyColumn()
ReferenceColumn
instance.public IRepositoryEntity getSecurityContainer()
IRepositoryEntity
public OdiReference getReference()
OdiReference
this ReferenceColumn
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.