|
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.project.OdiVariable
public class OdiVariable
Represents design time metadata about a variable.
OdiVariable class is the only member of OdiVariable aggregate, thus it is the
root entity and implements IOdiEntity
interface. An OdiVariable has an ID
that can be obtained from getVariableId() method call. This ID is assigned
when an OdiVariable is stored in design time repository. This ID represents
the identity of an OdiVariable. Equals / hashCode method are implemented
according this identity.
There is two distinct scopes of OdiVariable: Global and Project.
Life cycle of an OdiVariable begins at design time when it is created from one of its constructors, or when imported from external XML file. It is then typically stored inside ODI design time repository. The users can modify it in order to make it fit their needs. Life cycle ends when a user remove the OdiVariable instance from design time repository, or if enclosing OdiProject is removed (Project Scope).
Nested Class Summary | |
---|---|
static class |
OdiVariable.Action
Defines the type of persistence to be applied to an OdiVariable's value at runtime. |
static class |
OdiVariable.DataType
Defines the data type of an OdiVariable. |
Field Summary | |
---|---|
static int |
NAME_MAX_LENGTH
OdiVariable's name maximum length. |
Fields inherited from class oracle.odi.domain.support.AbstractOdiEntity |
---|
STARTING_INTERNAL_VERSION |
Constructor Summary | |
---|---|
OdiVariable(OdiProject pProject,
java.lang.String pName)
Construct a new OdiVariable with the given name owned by the given OdiProject . |
|
OdiVariable(java.lang.String pName)
Construct a new global (i.e. |
Method Summary | |
---|---|
OdiVariable.Action |
getAction()
Returns the values storage strategy for this OdiVariable instance. |
OdiVariable.DataType |
getDataType()
Returns the OdiVariable.DataType defined on this OdiVariable instance. |
java.lang.Object |
getDefaultValue()
Returns the current value of this OdiVariable instance. |
java.lang.String |
getDescription()
Returns the description of this OdiVariable 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. |
OdiLogicalSchema |
getLogicalSchema()
Returns the OdiLogicalSchema used for the refresh of this OdiVariable instance values. |
java.lang.String |
getName()
Returns the name of this OdiVariable instance. |
OdiProject |
getProject()
Returns the OdiProject that owns this OdiVariable instance. |
Expression |
getRefreshQuery()
Returns the SQL expression used to refresh this OdiVariable instance value. |
IRepositoryEntity |
getSecurityContainer()
Define a generic way to retrieve container for entities. |
java.lang.Number |
getVariableId()
Returns this OdiVariable instance identifier. |
boolean |
isGlobal()
Returns whether this OdiVariable is global, or not (i.e. |
boolean |
isInstanceLevelSecurityNeeded()
Internal: this method is for internal purpose and must not be considered as part of the public API. |
void |
setAction(OdiVariable.Action pAction)
Defines the value storage strategy for this OdiVariable instance. |
void |
setDataType(OdiVariable.DataType pDatatype)
Defines the data type of this OdiVariable instance. |
void |
setDefaultValue(java.lang.Object pValue)
Defines the default value of this OdiVariable instance. |
void |
setDescription(java.lang.String pDescription)
Defines a description for this OdiVariable instance. |
void |
setLogicalSchema(OdiLogicalSchema pOdiLogicalSchema)
Defines the logical schema used to refresh this variable's value. |
void |
setRefreshQuery(Expression pSqlExpression)
Sets the SQL expression used to refresh this OdiVariable instance value against
an OdiLogicalSchema defined using the setLogicalSchema(OdiLogicalSchema)
method. |
Methods inherited from class oracle.odi.domain.support.AbstractOdiEntity |
---|
equals, getFirstDate, getFirstUser, getInternalVersion, getLastDate, getLastUser, hashCode, 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 |
Field Detail |
---|
public static final int NAME_MAX_LENGTH
Constructor Detail |
---|
public OdiVariable(OdiProject pProject, java.lang.String pName)
OdiVariable
with the given name owned by the given OdiProject
.
pProject
- the owning projectpName
- the name of the variable
java.lang.IllegalArgumentException
- if the name is null, empty or longer than NAME_MAX_LENGTHNAME_MAX_LENGTH
public OdiVariable(java.lang.String pName)
OdiVariable
with
the given name.
pName
- the name of the variable
java.lang.IllegalArgumentException
- if the name is null, empty or longer than 400NAME_MAX_LENGTH
Method Detail |
---|
public OdiVariable.Action getAction()
OdiVariable
instance.
It can't be null.
OdiVariable.Action
instancesetAction(Action)
public OdiVariable.DataType getDataType()
OdiVariable.DataType
defined on this OdiVariable
instance.
setDataType(DataType)
public java.lang.Object getDefaultValue()
OdiVariable
instance.
The actual class of returned object depends on this variable's value type.
setDefaultValue(Object)
,
getDataType()
public java.lang.String getDescription()
OdiVariable
instance.
setDescription(String)
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.
getInternalId
in interface IRepositoryEntity
public OdiLogicalSchema getLogicalSchema()
OdiLogicalSchema
used for the refresh of this OdiVariable
instance values.
null
if none.setLogicalSchema(OdiLogicalSchema)
public java.lang.String getName()
OdiVariable
instance.
getName
in interface IOdiEntity
getName
in class oracle.odi.domain.support.AbstractOdiEntity
setName(String)
public OdiProject getProject()
OdiProject
that owns this OdiVariable
instance.
null
if none.isGlobal()
public Expression getRefreshQuery()
OdiVariable
instance value.
null
getLogicalSchema()
,
setLogicalSchema(OdiLogicalSchema)
,
setRefreshQuery(Expression)
public IRepositoryEntity getSecurityContainer()
IRepositoryEntity
getSecurityContainer
in interface IRepositoryEntity
public java.lang.Number getVariableId()
OdiVariable
instance identifier.
public boolean isGlobal()
true
if this variable is global, false
otherwisepublic boolean isInstanceLevelSecurityNeeded()
IOdiEntity
Defines a method to capture the info on which object needs instance level privilege.
isInstanceLevelSecurityNeeded
in interface IOdiEntity
isInstanceLevelSecurityNeeded
in class oracle.odi.domain.support.AbstractOdiEntity
true
if instance level security needed,
false
otherwisepublic void setAction(OdiVariable.Action pAction)
OdiVariable
instance.
By default, the action is defined with the enum value OdiVariable.Action.HISTORIZE
.
pAction
- the action of this variablegetAction()
public void setDataType(OdiVariable.DataType pDatatype)
OdiVariable
instance. Default value is OdiVariable.DataType.SHORT_TEXT
.
pDatatype
- the data type
java.lang.IllegalArgumentException
- if the parameter is null;getDataType()
public void setDefaultValue(java.lang.Object pValue)
OdiVariable
instance. The specified value's type must
be in accordance with the OdiVariable.DataType
enum value.
pValue
- the value to set.
java.lang.IllegalArgumentException
- if the given value is not consistent with this variable's data typegetDataType()
,
getDefaultValue()
public void setDescription(java.lang.String pDescription)
OdiVariable
instance.
pDescription
- the descriptiongetDescription()
public void setLogicalSchema(OdiLogicalSchema pOdiLogicalSchema)
pOdiLogicalSchema
- the logical schemasetRefreshQuery(Expression)
,
getRefreshQuery()
,
getLogicalSchema()
public void setRefreshQuery(Expression pSqlExpression)
OdiVariable
instance value against
an OdiLogicalSchema
defined using the setLogicalSchema(OdiLogicalSchema)
method.
pSqlExpression
- the refresh querysetLogicalSchema(OdiLogicalSchema)
,
getLogicalSchema()
,
getRefreshQuery()
|
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 |