oracle.odi.domain.adapter.relational

Interface IDataStoreRelationship

public interface IDataStoreRelationship

An interface which represents a relationship between two data storage objects (e.g. tables) in an external model, typically a foreign key type relationship.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	IDataStoreRelationship.RelationshipType Defines the possible types of relationship.

Method Summary

Modifier and Type	Method and Description
java.util.Collection	getColumnRelationships() Returns an unmodifiable, sorted collection of column relationships of this IDataStoreRelationship instance.
java.lang.String	getComplexSqlExpression() Returns the complex SQL expression of this IDataStoreRelationship instance, or null if none.
IDataStore	getForeignDataStore() Returns the foreign datastore of this IDataStoreRelationship instance (the datastore that contains the FK).
java.lang.String	getGlobalId() Gets the global id for this IDataStoreRelationship instance.
java.lang.String	getName() Returns the name of this IDataStoreRelationship instance.
java.lang.Object	getNativeModelObject() Obtains the reference Object of this IDataStoreRelationship.
IDataStore	getPrimaryDataStore() Returns the primary datastore of this IDataStoreRelationship (the datastore that contains the PK).
java.lang.String	getPrimaryDataStoreAlias() Returns the primary datastore alias for this IDataStoreRelationship instance.
java.lang.String	getPrimaryDataStoreCatalogName() Gets the primary data store catalog name for this IDataStoreRelationship instance.
java.lang.String	getPrimaryDataStoreName() Gets the primary data store name for this IDataStoreRelationship instance.
java.lang.String	getPrimaryDataStoreSchemaName() Gets the primary data store schema name for this IDataStoreRelationship instance.
IDataStoreRelationship.RelationshipType	getType() Returns the relationship type of this IDataStoreRelationship instance.
boolean	isActive() Returns whether this IDataStoreRelationship instance is active or not.
boolean	isFlowCheckEnabled() Returns whether this IDataStoreRelationship instance is flow check enabled or not.
boolean	isStaticCheckEnabled() Returns whether this IDataStoreRelationship instance is static check enabled or not.

Method Detail

getComplexSqlExpression

java.lang.String getComplexSqlExpression()

Returns the complex SQL expression of this IDataStoreRelationship instance, or null if none.

Returns:

the complex SQL expression

Throws:

java.lang.IllegalStateException - if the type of reference is not IDataStoreRelationship.RelationshipType.COMPLEX_REFERENCE

getName

java.lang.String getName()

Returns the name of this IDataStoreRelationship instance.

Returns:

name

getType

IDataStoreRelationship.RelationshipType getType()

Returns the relationship type of this IDataStoreRelationship instance.

Returns:

IDataStoreRelationship.RelationshipType

getForeignDataStore

IDataStore getForeignDataStore()
                        throws AdapterException

Returns the foreign datastore of this IDataStoreRelationship instance (the datastore that contains the FK).

Returns:

an IDataStore object representing the foreign data store value

Throws:

AdapterException

getPrimaryDataStore

IDataStore getPrimaryDataStore()
                        throws AdapterException

Returns the primary datastore of this IDataStoreRelationship (the datastore that contains the PK).

Returns:

an IDataStore object representing the primary data store value

Throws:

AdapterException

getPrimaryDataStoreAlias

java.lang.String getPrimaryDataStoreAlias()

Returns the primary datastore alias for this IDataStoreRelationship instance.

Invoking this method will throw an IllegalStatException if the relationship type is not IDataStoreRelationship.RelationshipType.COMPLEX_REFERENCE.

Returns:

a String representing the primary data store alias value

Throws:

java.lang.IllegalStateException - if this reference's type is not IDataStoreRelationship.RelationshipType.COMPLEX_REFERENCE

isActive

boolean isActive()

Returns whether this IDataStoreRelationship instance is active or not.

Returns:

true if this IDataStoreRelationship is active, false otherwise

isFlowCheckEnabled

boolean isFlowCheckEnabled()

Returns whether this IDataStoreRelationship instance is flow check enabled or not.

Returns:

true if this IDataStoreRelationship is flow check enabled, false otherwise

isStaticCheckEnabled

boolean isStaticCheckEnabled()

Returns whether this IDataStoreRelationship instance is static check enabled or not.

Returns:

true if this IDataStoreRelationship is static check enabled, false otherwise

getColumnRelationships

java.util.Collection getColumnRelationships()
                                     throws AdapterException

Returns an unmodifiable, sorted collection of column relationships of this IDataStoreRelationship instance.

Returns:

a Collection object representing the column relationships

Throws:

AdapterException

getPrimaryDataStoreName

java.lang.String getPrimaryDataStoreName()

Gets the primary data store name for this IDataStoreRelationship instance.

Returns:

PK data store name

getPrimaryDataStoreCatalogName

java.lang.String getPrimaryDataStoreCatalogName()

Gets the primary data store catalog name for this IDataStoreRelationship instance.

Returns:

PK catalog name

getPrimaryDataStoreSchemaName

java.lang.String getPrimaryDataStoreSchemaName()

Gets the primary data store schema name for this IDataStoreRelationship instance.

Returns:

PK schema name

getGlobalId

java.lang.String getGlobalId()

Gets the global id for this IDataStoreRelationship instance.

Returns:

global id

getNativeModelObject

java.lang.Object getNativeModelObject()
                               throws AdapterException

Obtains the reference Object of this IDataStoreRelationship.

Returns:

an object reference representing the datastore relationship

Throws:

AdapterException