|
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.model.OdiColumn
public class OdiColumn
An OdiColumn represents the data structure of a column part of an
OdiDataStore
.
The OdiColumn also defines this column will be used by different Oracle Data Integrator features.
Nested Class Summary | |
---|---|
static class |
OdiColumn.FileDescriptor
Defines OdiColumn properties that are specific to OdiColumns on
FILE technologies. |
static class |
OdiColumn.ScdType
Defines the possible Slowly Changing Dimension behaviors related to OdiColumn . |
Field Summary | |
---|---|
static int |
DEFAULT_VALUE_MAX_LENGTH
Maximum length supported for the "defaultValue" property. |
static int |
NAME_MAX_LENGTH
Maximum length supported for the "name" property. |
Fields inherited from class oracle.odi.domain.support.AbstractOdiEntity |
---|
STARTING_INTERNAL_VERSION |
Constructor Summary | |
---|---|
OdiColumn(OdiDataStore pDatastore,
java.lang.String pName)
Creates a column with the given name, bound to datastore pDatastore. |
Method Summary | |
---|---|
java.lang.Number |
getColumnId()
Returns the internal identifier of this OdiColumn instance. |
OdiDataStore |
getDataStore()
Returns the OdiDataStore that owns this column. |
OdiDataType |
getDataType()
Obtains the OdiDataType defined as data type for this
OdiColumn , or null if undefined. |
java.lang.String |
getDefaultValue()
Returns the default value for this OdiColumn instance. |
java.lang.String |
getDescription()
Returns the description of this OdiColumn instance. |
OdiColumn.FileDescriptor |
getFileDescriptor()
Returns the OdiColumn.FileDescriptor for this OdiColumn instance, or
null if none. |
java.util.Collection<IFlexFieldValue> |
getFlexFieldsValues()
Obtains flex fields values related to this IFlexFieldUser . |
java.lang.String |
getHeading()
Returns the short description of this OdiColumn instance. |
java.io.Serializable |
getInternalId()
Returns the internal identifier of this OdiColumn . |
java.lang.Integer |
getLength()
Get the length or precision of this column. |
java.lang.String |
getName()
Returns the name of this OdiColumn instance. |
int |
getPosition()
Get the column ordinal position. |
java.lang.Integer |
getScale()
Get the scale for numeric types. |
OdiColumn.ScdType |
getScdType()
Returns the OdiColumn.ScdType of this OdiColumn instance. |
IRepositoryEntity |
getSecurityContainer()
Define a generic way to retrieve container for entities. |
OdiDataStore |
getTable()
Obtains the parent OdiDataStore but match the IDataStore interface |
void |
initFlexFields(IOdiFlexFieldFinder pOdiFlexFieldFinder)
Initialize flex fields related to this IFlexFieldUser . |
boolean |
isDataServiceAllowInsert()
Will data services be allowed to perform insert on this column. |
boolean |
isDataServiceAllowSelect()
Will data services be allowed to perform select on this column. |
boolean |
isDataServiceAllowUpdate()
Will data services be allowed to perform update on this column. |
boolean |
isFlowCheckEnabled()
Return whether the flow check is enabled for this OdiColumn
instance or not. |
boolean |
isMandatory()
Return whether this column is mandatory (aka nullable) or not. |
boolean |
isStaticCheckEnabled()
Return whether the static check is enabled for this OdiColumn
instance or not. |
boolean |
isWritable()
Return whether this OdiColumn instance is writable, or not. |
void |
setDataServiceAllowInsert(boolean pDataServiceAllowInsert)
Set to true if you want to allow data services to perform insert on this column. |
void |
setDataServiceAllowSelect(boolean pDataServiceAllowSelect)
Set to true if you want to allow data services to perform select on this column. |
void |
setDataServiceAllowUpdate(boolean pDataServiceAllowUpdate)
Set to true if you want to allow data services to perform update on this column. |
void |
setDataType(OdiDataType pDataType)
Defines the OdiDataType as data type for this OdiColumn . |
void |
setDataTypeCode(java.lang.String pDataTypeCode)
Defines the DataType code for this OdiColumn. |
void |
setDefaultValue(java.lang.String pDefaultValue)
Sets the default value of this OdiColumn instance. |
void |
setDescription(java.lang.String pDescription)
Sets the description of this OdiColumn instance. |
void |
setFileDescriptor(OdiColumn.FileDescriptor pFileDescriptor)
Sets the file description (i.e. |
void |
setFlowCheckEnabled(boolean pFlowCheckEnabled)
Defines whether the flow check is enabled for this OdiColumn
instance or not. |
void |
setHeading(java.lang.String pHeading)
Defines the short description of this OdiColumn instance. |
void |
setLength(java.lang.Integer pLength)
Set the length or precision of this column. |
void |
setMandatory(boolean pMandatory)
Defines whether this OdiColumn instance if mandatory or not. |
void |
setScale(java.lang.Integer pScale)
Set the scale for numeric types. |
void |
setScdType(OdiColumn.ScdType pScdType)
Defines the OdiColumn.ScdType of this OdiColumn instance. |
void |
setStaticCheckEnabled(boolean pStaticCheckEnabled)
Defines whether the static check is enabled for this OdiColumn
instance. |
void |
setWritable(boolean pWritable)
Defines whether this OdiColumn instance is writable or not. |
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 DEFAULT_VALUE_MAX_LENGTH
setDefaultValue(String)
,
Constant Field Valuespublic static final int NAME_MAX_LENGTH
setName(String)
,
Constant Field ValuesConstructor Detail |
---|
public OdiColumn(OdiDataStore pDatastore, java.lang.String pName)
pDatastore
- the datastore this column belongs topName
- the column's name
java.lang.IllegalArgumentException
- if the given datastore is null or if the name is null, empty or longer than 128Method Detail |
---|
public java.lang.Number getColumnId()
OdiColumn
instance.
public OdiDataStore getDataStore()
OdiDataStore
that owns this column.
OdiDataStore
.public OdiDataType getDataType()
OdiDataType
defined as data type for this
OdiColumn
, or null
if undefined.
getDataType
in interface IColumn<OdiDataStore>
OdiDataType
of this column.setDataType(OdiDataType)
public java.lang.String getDefaultValue()
OdiColumn
instance.
setDefaultValue(String)
public java.lang.String getDescription()
OdiColumn
instance.
setDescription(String)
public OdiColumn.FileDescriptor getFileDescriptor()
OdiColumn.FileDescriptor
for this OdiColumn
instance, or
null if none.
If this OdiColumn
model is not of technology File, it will be null.
setFileDescriptor(oracle.odi.domain.model.OdiColumn.FileDescriptor)
,
setFileDescriptor(FileDescriptor)
public java.util.Collection<IFlexFieldValue> getFlexFieldsValues()
IFlexFieldUser
IFlexFieldUser
.
getFlexFieldsValues
in interface IFlexFieldUser
public java.lang.String getHeading()
OdiColumn
instance.
setHeading(String)
public java.io.Serializable getInternalId()
OdiColumn
.
getInternalId
in interface IRepositoryEntity
getColumnId()
public java.lang.Integer getLength()
null
if not
defined.
getLength
in interface IColumn<OdiDataStore>
java.lang.IllegalStateException
- if the DataType is not setOdiDataType.isLengthAllowed()
,
setLength(Integer)
public java.lang.String getName()
OdiColumn
instance.
getName
in interface IOdiEntity
getName
in interface IColumn<OdiDataStore>
getName
in class oracle.odi.domain.support.AbstractOdiEntity
setName(String)
public int getPosition()
setPosition(int)
public java.lang.Integer getScale()
null
if not defined.
getScale
in interface IColumn<OdiDataStore>
java.lang.IllegalStateException
- if the DataType is not setOdiDataType.isScaleAllowed()
,
setScale(Integer)
public OdiColumn.ScdType getScdType()
OdiColumn.ScdType
of this OdiColumn
instance.
OdiColumn.ScdType
for this column.setScdType(oracle.odi.domain.model.OdiColumn.ScdType)
,
setScdType(ScdType)
public IRepositoryEntity getSecurityContainer()
IRepositoryEntity
getSecurityContainer
in interface IRepositoryEntity
public OdiDataStore getTable()
IDataStore
interface
getTable
in interface IColumn<OdiDataStore>
public void initFlexFields(IOdiFlexFieldFinder pOdiFlexFieldFinder)
IFlexFieldUser
IFlexFieldUser
.
initFlexFields
in interface IFlexFieldUser
pOdiFlexFieldFinder
- OdiFlexField
finder to be used to query flex fieldspublic boolean isDataServiceAllowInsert()
One important use of this property is to lock a column against being written to via Data Serv. Note that by default these are set to true.
true
if data services should allow insert on this
column, false
otherwisepublic boolean isDataServiceAllowSelect()
One important use of this property is to lock a column against being written to via Data Serv. Note that by default these are set to true.
true
if data services should allow select on this
column, false
otherwisepublic boolean isDataServiceAllowUpdate()
One important use of this property is to lock a column against being written to via Data Serv. Note that by default these are set to true.
true
if data services should allow update on this
column, false
otherwisepublic boolean isFlowCheckEnabled()
OdiColumn
instance or not.
true
if flow check is enabled, false
otherwisesetFlowCheckEnabled(boolean)
public boolean isMandatory()
true
if this column is mandatory, false
otherwisesetMandatory(boolean)
public boolean isStaticCheckEnabled()
OdiColumn
instance or not.
true
if static check is enabled, false
otherwisesetStaticCheckEnabled(boolean)
public boolean isWritable()
OdiColumn
instance is writable, or not.
true
if this column is writable, false
otherwisesetWritable(boolean)
public void setDataServiceAllowInsert(boolean pDataServiceAllowInsert)
One important use of this property is to lock a column against being written to via Data Serv. Note that by default these are set to true.
pDataServiceAllowInsert
- true
if data services should
allow insert on this column, false
otherwisepublic void setDataServiceAllowSelect(boolean pDataServiceAllowSelect)
One important use of this property is to lock a column against being written to via Data Serv. Note that by default these are set to true.
pDataServiceAllowSelect
- true
if data services should
allow select on this column, false
otherwisepublic void setDataServiceAllowUpdate(boolean pDataServiceAllowUpdate)
One important use of this property is to lock a column against being written to via Data Serv. Note that by default these are set to true.
pDataServiceAllowUpdate
- true
if data services should
allow update on this column, false
otherwisepublic void setDataType(OdiDataType pDataType)
OdiDataType
as data type for this OdiColumn
.
This is similar to call setDataTypeCode(pDataType.getCode()).
setDataType
in interface IColumn<OdiDataStore>
pDataType
- the data type of the column
java.lang.IllegalArgumentException
- if the given data type is null or
if the given data type doesn't belong to the technology of that columnOdiDataType
,
setDataTypeCode(String)
,
getDataType()
public void setDataTypeCode(java.lang.String pDataTypeCode)
pDataTypeCode
- the datatype code.setDataTypeCode(String)
public void setDefaultValue(java.lang.String pDefaultValue)
OdiColumn
instance.
pDefaultValue
- the default value as string
java.lang.IllegalArgumentException
- if default value is longer than
100getDefaultValue()
public void setDescription(java.lang.String pDescription)
OdiColumn
instance.
pDescription
- the descriptiongetDescription()
public void setFileDescriptor(OdiColumn.FileDescriptor pFileDescriptor)
OdiColumn
instance.
pFileDescriptor
- the file descriptor
java.lang.IllegalArgumentException
- if the parameter value is not consistent
with the parent OdiDataStore
File descriptor.getFileDescriptor()
public void setFlowCheckEnabled(boolean pFlowCheckEnabled)
OdiColumn
instance or not.
By default, any column has flow check enabled.
pFlowCheckEnabled
- true
to enable flow check,
false
otherwiseisFlowCheckEnabled()
public void setHeading(java.lang.String pHeading)
OdiColumn
instance.
pHeading
- the short description.getHeading()
public void setLength(java.lang.Integer pLength)
OdiDataType.isLengthAllowed()
.
By default, length of an OdiColumn is defined to 50
.
Note that null
is supported and defining a null
length will make DDL statements creating this column with no defined
length.
setLength
in interface IColumn<OdiDataStore>
pLength
- the length or precision
java.lang.IllegalStateException
- if the DataType is not setOdiDataType.isLengthAllowed()
,
getLength()
public void setMandatory(boolean pMandatory)
OdiColumn
instance if mandatory or not.
By default a column is not mandatory.
pMandatory
- true
if this column is mandatory,
false
otherwiseisMandatory()
public void setScale(java.lang.Integer pScale)
OdiDataType.isScaleAllowed()
.
Note that null
is supported and defining a null
scale will make DDL statements creating this column with no defined scale.
setScale
in interface IColumn<OdiDataStore>
pScale
- the new scale
java.lang.IllegalStateException
- if the DataType is not setOdiDataType.isScaleAllowed()
,
getScale()
public void setScdType(OdiColumn.ScdType pScdType)
OdiColumn.ScdType
of this OdiColumn
instance.
pScdType
- the SCD typegetScdType()
public void setStaticCheckEnabled(boolean pStaticCheckEnabled)
OdiColumn
instance.
By default, any column has static check enabled.
pStaticCheckEnabled
- the static check is enabled flag.isStaticCheckEnabled()
public void setWritable(boolean pWritable)
OdiColumn
instance is writable or not.
By default, any column is writable.
pWritable
- true
to make this column writable,
false
otherwiseisWritable()
|
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 |