Oracle® Data Integrator Java API Reference
11g Release 1 (11.1.1.3.0)

E17060-01

oracle.odi.domain.topology
Class OdiLogicalSchema

java.lang.Object
  extended by oracle.odi.domain.support.BusinessObject
      extended by oracle.odi.domain.support.AbstractRepositoryEntity
          extended by oracle.odi.domain.support.AbstractOdiEntity
              extended by oracle.odi.domain.topology.OdiLogicalSchema
All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable, IMasterOdiEntity, IOdiEntity, IRepositoryEntity

public class OdiLogicalSchema
extends oracle.odi.domain.support.AbstractOdiEntity
implements IMasterOdiEntity

An ODI logical schema.

Internally used at design time to specify dataserver's schema and at runtime with the help of the runtime OdiContext to resolve physical schema where data processing has to occur.

Since:
11.1.1.3.0
See Also:
OdiContext, OdiPhysicalSchema, Serialized Form

Field Summary
 
Fields inherited from class oracle.odi.domain.support.AbstractOdiEntity
STARTING_INTERNAL_VERSION
 
Constructor Summary
OdiLogicalSchema(OdiTechnology pTechnology, java.lang.String pName)
          Construct a new OdiLogicalSchema.
 
Method Summary
 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 getLogicalSchemaId()
          Returns the Internal object ID.
 java.lang.String getName()
          Returns the Logical Schema's Name.
 OdiPhysicalSchema getPhysicalSchema(OdiContext pContext)
          Obtains the OdiPhysicalSchema associated for a given context.
 IRepositoryEntity getSecurityContainer()
          Define a generic way to retrieve container for entities.
 OdiTechnology getTechnology()
          Obtains the OdiTechnology that logical schema is related to.
 void setName(java.lang.String pName)
          Sets the Logical 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
 

Constructor Detail

OdiLogicalSchema

public OdiLogicalSchema(OdiTechnology pTechnology,
                        java.lang.String pName)
Construct a new OdiLogicalSchema.

This will adds this new logical schema to the given OdiTechnology's logical schemas.

Parameters:
pTechnology - the technology this logical schema will belong to
pName - the schema's name
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

getLogicalSchemaId

public java.lang.Number getLogicalSchemaId()
Returns the Internal object ID.

Returns:
its id

getName

public java.lang.String getName()
Returns the Logical Schema's Name.

Specified by:
getName in interface IOdiEntity
Overrides:
getName in class oracle.odi.domain.support.AbstractOdiEntity
Returns:
its name
See Also:
setName(String)

getPhysicalSchema

public OdiPhysicalSchema getPhysicalSchema(OdiContext pContext)
Obtains the OdiPhysicalSchema associated for a given context. Will be null if there is no OdiPhysicalSchema associated to the given OdiContext.

Parameters:
pContext - the context in which this logical schema is mapped
Returns:
OdiPhysicalSchema object mapped to this OdiLogicalSchema in given context. Will be null if none is mapped.

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

getTechnology

public OdiTechnology getTechnology()
Obtains the OdiTechnology that logical schema is related to.

Returns:
related technology

setName

public void setName(java.lang.String pName)
Sets the Logical Schema Name.

Parameters:
pName - the name to set
Throws:
java.lang.IllegalArgumentException - if the given name is empty
See Also:
getName()

Oracle® Data Integrator Java API Reference
11g Release 1 (11.1.1.3.0)

E17060-01

Copyright © 2010, Oracle and/or its affiliates. All rights reserved.