Skip navigation links

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

E17060-03


oracle.odi.domain.topology
Class OdiDataServer

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.AbstractOdiDataServer
                  extended by oracle.odi.domain.topology.OdiDataServer

All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable, IFlexFieldUser, IMasterOdiEntity, IExportable, IOdiEntity, IRepositoryEntity, ISmartExportable

public class OdiDataServer
extends AbstractOdiDataServer
implements IMasterOdiEntity, IExportable, IFlexFieldUser, ISmartExportable

An OdiDataServer is a data server that is defined for a technology into the physical topology of ODI. An instance of OdiDataServer belong to a single instance of OdiTechnology and should be used to manage the collection of OdiPhysicalSchema that belong to an instance of OdiDataServer.

The OdiDataServer class contains informations to connect to the described data server and how to manage that connection with properties like "fetchArraySize" and "batchUpdateSize".

Since:
11.1.1.3.0
See Also:
OdiTechnology, Serialized Form

Nested Class Summary

 

Nested classes/interfaces inherited from class oracle.odi.domain.topology.AbstractOdiDataServer
AbstractOdiDataServer.Axis2DeploymentSettings, AbstractOdiDataServer.DirectoryDeploymentSettings, AbstractOdiDataServer.FtpDeploymentSettings, AbstractOdiDataServer.IConnectionSettings, AbstractOdiDataServer.JdbcSettings, AbstractOdiDataServer.JndiSettings, AbstractOdiDataServer.WsContainerSettings

 

Field Summary

 

Fields inherited from class oracle.odi.domain.support.AbstractOdiEntity
STARTING_INTERNAL_VERSION

 

Constructor Summary
OdiDataServer(OdiTechnology pTechnology, java.lang.String pName)
          Construct a new OdiDataServer.

 

Method Summary
 int getBatchUpdateSize()
          Returns the batch update size that should be used when querying this data server.
 AbstractOdiDataServer.IConnectionSettings getConnectionSettings()
          Returns the AbstractOdiDataServer.IConnectionSettings defined for this data server.
 OdiPhysicalSchema getDefaultPhysicalSchema()
          Looks up the default physical schema for this OdiDataServer from its associated physical schemas.
 int getFetchArraySize()
          Returns the fetch array size that should be used when querying this data server.
 java.util.Collection<IFlexFieldValue> getFlexFieldsValues()
          Obtains flex fields values related to this IFlexFieldUser.
 java.lang.String getName()
          Return the name of this OdiDataServer.
 java.util.Collection<OdiPhysicalSchema> getPhysicalSchemas()
          Obtains an unmodifable collection of OdiPhysicalSchemas that belongs to this OdiDataServer.
 java.lang.String getServerInstanceName()
          Return the server instance name that can be used for some technology (i.e.
 OdiTechnology getTechnology()
          Returns the technology to which this data server is linked.
 void initFlexFields(IOdiFlexFieldFinder pOdiFlexFieldFinder)
          Initialize flex fields related to this IFlexFieldUser.
 void removePhysicalSchema(OdiPhysicalSchema pPhysicalSchema)
          Remove the given OdiPhysicalSchema from the collection of OdiPhysicalSchemas.
 void setBatchUpdateSize(int pBatchUpdateSize)
          Sets the batch update size that should be used when querying this data server.
 void setConnectionSettings(AbstractOdiDataServer.IConnectionSettings pSettings)
          Defines the connection settings for this AbstractOdiDataServer.
 void setDefaultPhysicalSchema(OdiPhysicalSchema pPSchema)
          Defines the specified OdiPhysicalSchema as the new default physical schema.
 void setFetchArraySize(int pFetchArraySize)
          Sets the fetch array size that should be used when querying this data server.
 void setName(java.lang.String pName)
          Define the name of this OdiDataServer.
 void setServerInstanceName(java.lang.String pServerInstanceName)
          Defines the server instance name to be used for this OdiDataServer.

 

Methods inherited from class oracle.odi.domain.topology.AbstractOdiDataServer
getDataServerId, getInternalId, getPassword, getSecurityContainer, getUsername, setPassword, setUsername

 

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

 

Methods inherited from interface oracle.odi.domain.IRepositoryEntity
getInternalId, getSecurityContainer

 

Constructor Detail

OdiDataServer

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

This will adds this new data server to the given OdiTechnology's data servers.

Parameters:
pTechnology - the technology the OdiDataServer belongs to
pName - the data server's name

Method Detail

getBatchUpdateSize

public int getBatchUpdateSize()
Returns the batch update size that should be used when querying this data server.
Returns:
batch size
See Also:
setBatchUpdateSize(int)

setBatchUpdateSize

public void setBatchUpdateSize(int pBatchUpdateSize)
Sets the batch update size that should be used when querying this data server.

Default is 30.

Parameters:
pBatchUpdateSize - batch size to set
See Also:
getBatchUpdateSize()

getFetchArraySize

public int getFetchArraySize()
Returns the fetch array size that should be used when querying this data server.
Returns:
fetch size
See Also:
setFetchArraySize(int)

setFetchArraySize

public void setFetchArraySize(int pFetchArraySize)
Sets the fetch array size that should be used when querying this data server.

Default is 30.

Parameters:
pFetchArraySize - fetch size to set
See Also:
getFetchArraySize()

getServerInstanceName

public java.lang.String getServerInstanceName()
Return the server instance name that can be used for some technology (i.e. oracle DB/LINK), or null if none.
Returns:
server name
See Also:
OdiTechnology.isInstanceServerSupported(), setServerInstanceName(String)

setServerInstanceName

public void setServerInstanceName(java.lang.String pServerInstanceName)
Defines the server instance name to be used for this OdiDataServer.

If the technology of that data server doesn't support it, this property won't be used.

Parameters:
pServerInstanceName - the server instance name
See Also:
OdiTechnology.isInstanceServerSupported(), getServerInstanceName()

getDefaultPhysicalSchema

public OdiPhysicalSchema getDefaultPhysicalSchema()
Looks up the default physical schema for this OdiDataServer from its associated physical schemas.
Returns:
the default physical schema for that data server
See Also:
OdiPhysicalSchema.isDefaultPhysicalSchema()

getPhysicalSchemas

public java.util.Collection<OdiPhysicalSchema> getPhysicalSchemas()
Obtains an unmodifable collection of OdiPhysicalSchemas that belongs to this OdiDataServer.
Returns:
a collection of OdiPhysicalSchemas

removePhysicalSchema

public void removePhysicalSchema(OdiPhysicalSchema pPhysicalSchema)
Remove the given OdiPhysicalSchema from the collection of OdiPhysicalSchemas. This will also reset the OdiDataServer of the given OdiPhysicalSchema to null.

If the removed OdiPhysicalSchema is the default one then this method will assign the default OdiPhysicalSchema status to the first one found from the physical schemas of this data server.

Parameters:
pPhysicalSchema - physical schema to remove
Throws:
DomainRuntimeException - if pPhysicalSchema is null or does not belong to this OdiDataServer

setDefaultPhysicalSchema

public void setDefaultPhysicalSchema(OdiPhysicalSchema pPSchema)
Defines the specified OdiPhysicalSchema as the new default physical schema.

Since only one default schema is allowed per OdiDataServer, any previous default schema will no longer be defined as default schema.

Parameters:
pPSchema - the new default schema

getName

public java.lang.String getName()
Return the name of this OdiDataServer.
Specified by:
getName in interface IOdiEntity
Overrides:
getName in class oracle.odi.domain.support.AbstractOdiEntity
Returns:
data server name
See Also:
setName(String)

setName

public void setName(java.lang.String pName)
Define the name of this OdiDataServer.
Parameters:
pName - the name to set
Throws:
DomainRuntimeException - if the name is null or empty
See Also:
getName()

getTechnology

public OdiTechnology getTechnology()
Returns the technology to which this data server is linked.
Returns:
the technology

setConnectionSettings

public void setConnectionSettings(AbstractOdiDataServer.IConnectionSettings pSettings)
Description copied from class: AbstractOdiDataServer
Defines the connection settings for this AbstractOdiDataServer.
Specified by:
setConnectionSettings in class AbstractOdiDataServer
Parameters:
pSettings - the connection settings of this data server
See Also:
getConnectionSettings()

getConnectionSettings

public AbstractOdiDataServer.IConnectionSettings getConnectionSettings()
Description copied from class: AbstractOdiDataServer
Returns the AbstractOdiDataServer.IConnectionSettings defined for this data server.
Specified by:
getConnectionSettings in class AbstractOdiDataServer
Returns:
connection settings
See Also:
AbstractOdiDataServer.setConnectionSettings(IConnectionSettings)

getFlexFieldsValues

public java.util.Collection<IFlexFieldValue> getFlexFieldsValues()
Description copied from interface: IFlexFieldUser
Obtains flex fields values related to this IFlexFieldUser.
Specified by:
getFlexFieldsValues in interface IFlexFieldUser
Returns:
an unmodifiable Collection of flex field values
Since:
11.1.1.5.0

initFlexFields

public void initFlexFields(IOdiFlexFieldFinder pOdiFlexFieldFinder)
Description copied from interface: IFlexFieldUser
Initialize flex fields related to this IFlexFieldUser.
Specified by:
initFlexFields in interface IFlexFieldUser
Parameters:
pOdiFlexFieldFinder - OdiFlexField finder to be used to query flex fields
Since:
11.1.1.5.0

Skip navigation links

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

E17060-03


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