|
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.topology.OdiTechnology
public class OdiTechnology
A technology that is defined within the physical topology provided by ODI.
An OdiTechnology
mainly correspond to an SQL technology and so
provides numerous methods to define SQL specificities of the underlying SQL
technology. These specificities will be queried by ODI during code generation
for instance.
An OdiTechnology
also manage a collection of OdiDataServer
instances that belong to that technology instance.
Note : Logical only technologies are not supported.
Nested Class Summary | |
---|---|
static class |
OdiTechnology.ExecutionChannel
Type safe enum representing the execution channel applying to an OdiTechnology . |
static class |
OdiTechnology.PartitionCapability
Typesafe enum that allow to define Partition capability for an OdiTechnology. |
static class |
OdiTechnology.SqlJoinCapability
Type safe enum representing the Join capability for a technology supporting the SQL dialect. |
Field Summary | |
---|---|
static int |
INTERNAL_NAME_MAX_LENGTH
Maximum length for the code, or internal name, of an OdiTechnology . |
static int |
NAME_MAX_LENGTH
Maximum length for the name of an OdiTechnology . |
Fields inherited from class oracle.odi.domain.support.AbstractOdiEntity |
---|
STARTING_INTERNAL_VERSION |
Method Summary | |
---|---|
java.lang.String |
getCatalogTerminology()
Returns the terminology used for catalog. |
java.lang.String |
getColumnAliasSeparator()
Returns the string used for separating an SQL expression from its alias for this OdiTechnology . |
java.lang.String |
getCurrentDateSQL()
Obtains the SQL statement to get current system data for this OdiTechnology . |
java.util.Collection<OdiDataServer> |
getDataServers()
Obtains an unmodifiable collection of OdiDataServer s. |
OdiDataType |
getDataType(java.lang.String pDataTypeCode)
Returns the OdiDataType associated to this OdiTechnology
instance which has the given code parameter as data type code. |
java.util.Collection<OdiDataType> |
getDataTypes()
Returns an unmodifiable collection of this OdiTechnology 's data types. |
java.lang.String |
getDateDataTypeMask()
Returns the date data type mask for this OdiTechnology . |
java.lang.String |
getDdlNullKeyword()
Returns the 'null' keyword for this OdiTechnology . |
OdiTechnology.ExecutionChannel |
getExecutionChannel()
Returns the execution channel used by this OdiTechnology . |
OdiIndexType |
getIndexType(java.lang.String pIndexTypeCode)
Returns the OdiIndexType associated to this OdiTechnology
instance which has the given code parameter as index type code. |
java.util.Collection<OdiIndexType> |
getIndexTypes()
Obtains an unmodifiable collection of OdiIndexType s that belongs to this
OdiTechnology . |
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.String |
getInternalName()
Obtains the internal name (aka code) of this OdiTechnology instance. |
java.lang.String |
getJoinCrossKeyword()
Obtains cross join keyword for this OdiTechnology . |
java.lang.String |
getJoinFullKeyword()
Obtains full join keyword for this OdiTechnology . |
java.lang.String |
getJoinInnerKeyword()
Obtains the inner join keyword for this OdiTechnology . |
java.lang.String |
getJoinLeftOuterKeyword()
Obtains left outer join keyword for this OdiTechnology . |
java.lang.String |
getJoinNaturalKeyword()
Obtains natural join keyword for this OdiTechnology . |
java.lang.String |
getJoinOuterKeyword()
Obtains outer join keyword for this OdiTechnology . |
java.lang.String |
getJoinRightOuterKeyword()
Obtains right outer join keyword for this OdiTechnology . |
java.lang.String |
getLocalObjectMask()
Returns the local object mask string for this OdiTechnology . |
java.lang.String |
getLocalSequenceMask()
Obtains the local sequence usage mask. |
java.util.Collection<OdiLogicalSchema> |
getLogicalSchemas()
Obtains an unmodifiable collection of OdiLogicalSchema s. |
java.lang.String |
getLongVarBinaryDataTypeMask()
Returns the LongVarBinary data type mask for this OdiTechnology . |
int |
getMaxColumnNameLength()
Returns the maximum column name length for this OdiTechnology . |
int |
getMaxTableNameLength()
Returns the maximum table name length for this OdiTechnology . |
java.lang.String |
getName()
Obtains the name of this OdiTechnology . |
java.lang.String |
getNumericDataTypeMask()
Returns the numeric data type mask for this OdiTechnology . |
OdiTechnology.PartitionCapability |
getPartitionCapability()
Obtains the partition capability of this technology. |
java.lang.String |
getPartitionMask()
Obtains the partition mask. |
java.lang.String |
getRemoteObjectMask()
Returns the remote object mask string for this OdiTechnology . |
java.lang.String |
getRemoteSequenceMask()
Obtains the remote sequence usage mask. |
java.lang.String |
getSchemaNameTerminology()
Returns the terminology used for schema. |
IRepositoryEntity |
getSecurityContainer()
Define a generic way to retrieve container for entities. |
java.lang.String |
getServerDateFunction()
Returns the server date function for this OdiTechnology . |
java.lang.String |
getServerNameTerminology()
Returns the terminology used for data server. |
java.util.List<java.lang.String> |
getSetOperatorList()
Obtains the Set operators supported by this OdiTechnology . |
OdiTechnology.SqlJoinCapability |
getSqlJoinCapability()
Returns the SQL join capability for this OdiTechnology . |
java.lang.String |
getStringDataTypeMask()
Returns the String (or Varchar) data type mask for this OdiTechnology . |
java.lang.String |
getSubPartitionMask()
Obtains the sub-partition mask. |
java.lang.String |
getTableAliasSeparator()
Returns the string used for separating a table name from its alias in a from clause for this OdiTechnology . |
java.lang.Number |
getTechnologyId()
Obtains the identifier for this OdiTechnology . |
boolean |
isCatalogSupported()
Returns whether this OdiTechnology supports catalogs. |
boolean |
isCrossCapable()
Tells whether this OdiTechnology supports cross joins. |
boolean |
isDerivedTablesSupported()
Returns whether this OdiTechnology supports derived tables, or not. |
boolean |
isFileTechnology()
Returns whether the technology is of type File. |
boolean |
isFullJoinCapable()
Tells whether this OdiTechnology supports full joins. |
boolean |
isInnerJoinCapable()
Tells whether this OdiTechnology supports inner joins. |
boolean |
isInstanceServerSupported()
Returns whether this OdiTechnology supports data server
instance name. |
boolean |
isJoinBracketsSupported()
Returns whether join clauses support brackets, or not. |
boolean |
isJoinInFromClause()
Returns whether a join clause is located in FROM clause, or in WHERE clause. |
boolean |
isLeftOuterJoinCapable()
Tells whether this OdiTechnology supports left outer joins. |
boolean |
isLookupSelectSupported()
Returns whether this OdiTechnology supports lookup selects, or not. |
boolean |
isLookupSupported()
Returns whether this OdiTechnology supports lookups, or not. |
boolean |
isNativeSequencesSupported()
Returns whether this OdiTechnology supports native sequences, or not. |
boolean |
isNaturalJoinCapable()
Tells whether this OdiTechnology supports natural joins. |
boolean |
isOuterJoinCapable()
Tells whether this OdiTechnology supports outer joins. |
boolean |
isRightOuterJoinCapable()
Tells whether this OdiTechnology supports right outer joins. |
boolean |
isSchemaSupported()
Returns whether this OdiTechnology uses schemas. |
boolean |
isSetOperatorSupported()
Returns whether this OdiTechnology supports Set operators, or not. |
boolean |
isSqlSelectCapable()
Returns whether this OdiTechnology is capable of executing SQL
SELECT statements. |
boolean |
isSqlWhereCapable()
Returns whether this OdiTechnology is able to execute SQL WHERE
clauses. |
void |
removeDataServer(OdiDataServer pDataServer)
Remove the given OdiDataServer from the collection of OdiDataServer s. |
void |
removeLogicalSchema(OdiLogicalSchema pLogicalSchema)
Remove the given OdiLogicalSchema from the collection of OdiLogicalSchema s. |
void |
setDerivedTablesSupported(boolean pDerivedTablesSupported)
Defines whether derived tables are supported by this OdiTechnology , or not. |
void |
setInstanceServerSupported(boolean pInstanceServerSupported)
Defines whether this OdiTechnology supports instance server, or not. |
void |
setJoinBracketsSupported(boolean pBracketsSupported)
Defines whether this technology join clauses support brackets, or not. |
void |
setJoinCrossKeyword(java.lang.String pJoinCrossKeyword)
Defines the cross join keyword for this OdiTechnology . |
void |
setJoinFullKeyword(java.lang.String pJoinFullKeyword)
Defines the full join keyword for this OdiTechnology . |
void |
setJoinInFromClause(boolean pInFromClause)
Defines whether this technology join clauses are located in the FROM clause, or not. |
void |
setJoinInnerKeyword(java.lang.String pJoinInnerKeyword)
Defines the inner join keyword for this OdiTechnology . |
void |
setJoinLeftOuterKeyword(java.lang.String pJoinLeftOuterKeyword)
Defines the left outer join keyword for this OdiTechnology . |
void |
setJoinNaturalKeyword(java.lang.String pJoinNaturalKeyword)
Defines the natural join keyword for this OdiTechnology . |
void |
setJoinOuterKeyword(java.lang.String pJoinOuterKeyword)
Defines the outer join keyword for this OdiTechnology . |
void |
setJoinRightOuterKeyword(java.lang.String pJoinRightOuterKeyword)
Defines the right outer join keyword for this OdiTechnology . |
void |
setLookupSelectSupported(boolean pLookupSelectSupported)
Defines whether this OdiTechnology supports lookup selects, or not. |
void |
setServerNameTerminology(java.lang.String pServerNameTerminology)
Sets the terminology used for data server. |
void |
setSetOperatorList(java.util.List<java.lang.String> pOperatorLst)
Defines the Set operators defined by this OdiTechnology . |
void |
setSetOperatorSupported(boolean pSetOperatorSupported)
Defines whether Set operators are supported by this OdiTechnology , or not. |
void |
setSqlJoinCapability(OdiTechnology.SqlJoinCapability pSqlJoinCapability)
Defines the SQL join capability for this OdiTechnology . |
boolean |
supportsImport(java.lang.Class<IOdiEntity> pChildClass)
Only OdiDataServer s can be imported under an OdiTechnology . |
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 INTERNAL_NAME_MAX_LENGTH
OdiTechnology
.
public static final int NAME_MAX_LENGTH
OdiTechnology
.
Method Detail |
---|
public java.lang.String getCatalogTerminology()
public java.lang.String getColumnAliasSeparator()
OdiTechnology
.
public java.lang.String getCurrentDateSQL()
OdiTechnology
.
public java.util.Collection<OdiDataServer> getDataServers()
Obtains an unmodifiable collection of OdiDataServer
s.
Use removeDataServer() to remove elements.
OdiDataServer
s that belongs to this technologypublic OdiDataType getDataType(java.lang.String pDataTypeCode)
OdiDataType
associated to this OdiTechnology
instance which has the given code parameter as data type code.
pDataTypeCode
- the data type code
OdiDataType
, or null
if not foundpublic java.util.Collection<OdiDataType> getDataTypes()
OdiTechnology
's data types.
OdiDataType
s that belongs to this technologypublic java.lang.String getDateDataTypeMask()
OdiTechnology
.
public java.lang.String getDdlNullKeyword()
OdiTechnology
.
public OdiTechnology.ExecutionChannel getExecutionChannel()
OdiTechnology
.
OdiTechnology.ExecutionChannel
public OdiIndexType getIndexType(java.lang.String pIndexTypeCode)
OdiIndexType
associated to this OdiTechnology
instance which has the given code parameter as index type code.
pIndexTypeCode
- the index type code
OdiIndexType
, or null
if not found.public java.util.Collection<OdiIndexType> getIndexTypes()
OdiIndexType
s that belongs to this
OdiTechnology
.
OdiIndexType
spublic 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.String getInternalName()
OdiTechnology
instance.
This internal name is internally used by ODI in order to reference technologies from a work repository.
public java.lang.String getJoinCrossKeyword()
OdiTechnology
.
setJoinCrossKeyword(String)
public java.lang.String getJoinFullKeyword()
OdiTechnology
.
setJoinFullKeyword(String)
public java.lang.String getJoinInnerKeyword()
OdiTechnology
.
setJoinInnerKeyword(String)
public java.lang.String getJoinLeftOuterKeyword()
OdiTechnology
.
setJoinLeftOuterKeyword(String)
public java.lang.String getJoinNaturalKeyword()
OdiTechnology
.
setJoinNaturalKeyword(String)
public java.lang.String getJoinOuterKeyword()
OdiTechnology
.
setJoinOuterKeyword(String)
public java.lang.String getJoinRightOuterKeyword()
OdiTechnology
.
setJoinRightOuterKeyword(String)
public java.lang.String getLocalObjectMask()
OdiTechnology
.
public java.lang.String getLocalSequenceMask()
public java.util.Collection<OdiLogicalSchema> getLogicalSchemas()
Obtains an unmodifiable collection of OdiLogicalSchema
s.
Use removeLogicalSchema() to remove elements.
OdiLogicalSchema
that belongs to this technologypublic java.lang.String getLongVarBinaryDataTypeMask()
OdiTechnology
.
public int getMaxColumnNameLength()
OdiTechnology
.
public int getMaxTableNameLength()
OdiTechnology
.
public java.lang.String getName()
OdiTechnology
.
getName
in interface IOdiEntity
getName
in class oracle.odi.domain.support.AbstractOdiEntity
public java.lang.String getNumericDataTypeMask()
OdiTechnology
.
public OdiTechnology.PartitionCapability getPartitionCapability()
OdiTechnology.PartitionCapability
public java.lang.String getPartitionMask()
public java.lang.String getRemoteObjectMask()
OdiTechnology
.
public java.lang.String getRemoteSequenceMask()
public java.lang.String getSchemaNameTerminology()
public IRepositoryEntity getSecurityContainer()
IRepositoryEntity
getSecurityContainer
in interface IRepositoryEntity
public java.lang.String getServerDateFunction()
OdiTechnology
.
public java.lang.String getServerNameTerminology()
setServerNameTerminology(String)
public java.util.List<java.lang.String> getSetOperatorList()
OdiTechnology
.
setSetOperatorList(List)
public OdiTechnology.SqlJoinCapability getSqlJoinCapability()
OdiTechnology
.
OdiTechnology.SqlJoinCapability
setSqlJoinCapability(SqlJoinCapability)
public java.lang.String getStringDataTypeMask()
OdiTechnology
.
public java.lang.String getSubPartitionMask()
public java.lang.String getTableAliasSeparator()
OdiTechnology
.
public java.lang.Number getTechnologyId()
OdiTechnology
.
public boolean isCatalogSupported()
OdiTechnology
supports catalogs.
true
if catalogs are supported, false
otherwisepublic boolean isCrossCapable()
OdiTechnology
supports cross joins.
true
if supported, false
otherwisepublic boolean isDerivedTablesSupported()
OdiTechnology
supports derived tables, or not.
true
if supported, false
otherwisepublic boolean isFileTechnology()
true
if this is a file technology,
false
otherwisepublic boolean isFullJoinCapable()
OdiTechnology
supports full joins.
true
if supported, false
otherwisepublic boolean isInnerJoinCapable()
OdiTechnology
supports inner joins.
true
if supported, false
otherwisepublic boolean isInstanceServerSupported()
OdiTechnology
supports data server
instance name.
true
if instance server are supported,
false
otherwisepublic boolean isJoinBracketsSupported()
Note: this property is only relevant for ISO join syntax.
true
if supported, false
if not supportedpublic boolean isJoinInFromClause()
Note: this property is only relevant for ISO join syntax.
true
if located in FROM clause, false
if located in WHERE clause.public boolean isLeftOuterJoinCapable()
OdiTechnology
supports left outer joins.
true
if supported, false
otherwisepublic boolean isLookupSelectSupported()
OdiTechnology
supports lookup selects, or not.
true
if supported, false
otherwisepublic boolean isLookupSupported()
OdiTechnology
supports lookups, or not.
true
if supported, false
otherwise.public boolean isNativeSequencesSupported()
OdiTechnology
supports native sequences, or not.
true
if native sequences are supported, false
otherwisepublic boolean isNaturalJoinCapable()
OdiTechnology
supports natural joins.
true
if supported, false
otherwisepublic boolean isOuterJoinCapable()
OdiTechnology
supports outer joins.
true
if supported, false
otherwisepublic boolean isRightOuterJoinCapable()
OdiTechnology
supports right outer joins.
true
if supported, false
otherwisepublic boolean isSchemaSupported()
OdiTechnology
uses schemas.
true
if it uses schemas, false
otherwisepublic boolean isSetOperatorSupported()
OdiTechnology
supports Set operators, or not.
true
if supported, false
otherwisepublic boolean isSqlSelectCapable()
OdiTechnology
is capable of executing SQL
SELECT statements.
true
if capable, false
otherwisepublic boolean isSqlWhereCapable()
OdiTechnology
is able to execute SQL WHERE
clauses.
true
if capable, false
otherwisepublic void removeDataServer(OdiDataServer pDataServer)
Remove the given OdiDataServer
from the collection of OdiDataServer
s.
This will also reset the OdiTechnology of the given OdiDataServer
to null
.
pDataServer
- data server to remove
java.lang.IllegalArgumentException
- if pDataServer is null or does not belong to this OdiTechnologypublic void removeLogicalSchema(OdiLogicalSchema pLogicalSchema)
Remove the given OdiLogicalSchema
from the collection of OdiLogicalSchema
s.
This will also reset the OdiTechnology of the given OdiLogicalSchema
to null
.
pLogicalSchema
- logical schema to remove
java.lang.IllegalArgumentException
- if pLogicalSchema is null
or does not belong
to this OdiTechnologypublic void setDerivedTablesSupported(boolean pDerivedTablesSupported)
OdiTechnology
, or not.
pDerivedTablesSupported
- true
if supported, false
otherwisepublic void setInstanceServerSupported(boolean pInstanceServerSupported)
OdiTechnology
supports instance server, or not.
pInstanceServerSupported
- true
if supported, false
otherwisepublic void setJoinBracketsSupported(boolean pBracketsSupported)
By default brackets are not supported.
Note: this property is only relevant for ISO join syntax.
pBracketsSupported
- true
if brackets are supported, false
otherwisepublic void setJoinCrossKeyword(java.lang.String pJoinCrossKeyword)
OdiTechnology
.
pJoinCrossKeyword
- a string representing the cross join keywordgetJoinCrossKeyword()
public void setJoinFullKeyword(java.lang.String pJoinFullKeyword)
OdiTechnology
.
pJoinFullKeyword
- a string representing the full join keywordgetJoinFullKeyword()
public void setJoinInFromClause(boolean pInFromClause)
By Default this property is true
, meaning a join clause is
located in the FROM clause by default.
Note: this property is only relevant for ISO join syntax.
pInFromClause
- true
if join clause is in FROM clause,
false
if it is located in the WHERE clausepublic void setJoinInnerKeyword(java.lang.String pJoinInnerKeyword)
OdiTechnology
.
pJoinInnerKeyword
- a string representing the inner join keywordgetJoinInnerKeyword()
public void setJoinLeftOuterKeyword(java.lang.String pJoinLeftOuterKeyword)
OdiTechnology
.
pJoinLeftOuterKeyword
- a string representing the left outer join keywordgetJoinLeftOuterKeyword()
public void setJoinNaturalKeyword(java.lang.String pJoinNaturalKeyword)
OdiTechnology
.
pJoinNaturalKeyword
- a string representing the natural join keywordgetJoinNaturalKeyword()
public void setJoinOuterKeyword(java.lang.String pJoinOuterKeyword)
OdiTechnology
.
pJoinOuterKeyword
- a string representing the outer join keywordgetJoinOuterKeyword()
public void setJoinRightOuterKeyword(java.lang.String pJoinRightOuterKeyword)
OdiTechnology
.
pJoinRightOuterKeyword
- a string representing the right outer join keywordgetJoinRightOuterKeyword()
public void setLookupSelectSupported(boolean pLookupSelectSupported)
OdiTechnology
supports lookup selects, or not.
pLookupSelectSupported
- true
if supported, false
otherwisepublic void setServerNameTerminology(java.lang.String pServerNameTerminology)
pServerNameTerminology
- terminology stringgetServerNameTerminology()
public void setSetOperatorList(java.util.List<java.lang.String> pOperatorLst)
OdiTechnology
.
pOperatorLst
- Set operators as a list of operator stringsgetSetOperatorList()
public void setSetOperatorSupported(boolean pSetOperatorSupported)
OdiTechnology
, or not.
pSetOperatorSupported
- true
if supported, false
otherwisepublic void setSqlJoinCapability(OdiTechnology.SqlJoinCapability pSqlJoinCapability)
OdiTechnology
.
pSqlJoinCapability
- the join capabilitygetSqlJoinCapability()
public boolean supportsImport(java.lang.Class<IOdiEntity> pChildClass)
OdiDataServer
s can be imported under an OdiTechnology
.
supportsImport
in interface IImportRoot
pChildClass
- class of the object to import
true
if the given class is OdiDataServer
, false
otherwiseIImportRoot.supportsImport(Class)
|
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 |