public class OdiColumn extends oracle.odi.domain.support.AbstractOdiEntity implements IColumn, IWorkDevelopmentOdiEntity, IFlexFieldUser, IColumn
OdiDataStore
.
The OdiColumn also defines this column will be used by different Oracle Data Integrator features.
Modifier and Type | Class and Description |
---|---|
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 . |
Modifier and Type | Field and Description |
---|---|
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.
|
Constructor and Description |
---|
OdiColumn(OdiDataStore pDatastore,
java.lang.String pName)
Creates a column with the given name, bound to datastore pDatastore.
|
Modifier and Type | Method and Description |
---|---|
java.lang.Number |
getColumnId()
Returns the internal identifier of this
OdiColumn instance. |
OdiDataStore |
getDataStore()
Returns the
OdiDataStore that owns this column. |
OdiDataType |
getDataType()
|
java.lang.String |
getDdlDataType()
Get the full DDL data type string for creating the column using SQL DDL.
|
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. |
OdiColumn.FileDescriptor |
getFileFieldDescriptor()
Gets a file field descriptor instance if this column represents a file field, else null.
|
java.util.Collection |
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 |
getRawLength()
Internal use only
|
java.lang.Integer |
getRawScale()
Internal use only
|
java.lang.Integer |
getScale()
Get the scale of this column.
|
OdiColumn.ScdType |
getScdType()
Returns the
OdiColumn.ScdType of this OdiColumn instance. |
IRepositoryEntity |
getSecurityContainer()
Define a generic way to retrieve container for entities.
|
OdiColumn |
getSourceColumn()
Obtains the source column of this
OdiColumn . |
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 |
isVirtual()
Returns true if this is a virtual column.
|
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 |
setName(java.lang.String pName)
For internal use only! Sets the name of this
OdiColumn . |
void |
setPosition(int pPosition)
For internal use only! Set the column ordinal position.
|
void |
setRawLength(java.lang.Integer pLength)
Internal use only
|
void |
setRawScale(java.lang.Integer pScale)
Internal use only
|
void |
setScale(java.lang.Integer pScale)
Set the scale of this column.
|
void |
setScdType(OdiColumn.ScdType pScdType)
Defines the
OdiColumn.ScdType of this OdiColumn instance. |
void |
setSourceColumn(OdiColumn pSourceColumn)
Sets the source column for this
OdiColumn if created using common format designer. |
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. |
java.lang.String |
toString() |
equals, getFirstDate, getFirstUser, getInternalVersion, getLastDate, getLastUser, hashCode, isInstanceLevelSecurityNeeded, isNew
getGlobalId, getNumericId, hasCustomizedPersistenceMethodFor, invokeCustomizedPersistenceMethodFor
getFirstDate, getFirstUser, getLastDate, getLastUser, isInstanceLevelSecurityNeeded
getGlobalId
getGlobalId, getNumericId
public static final int NAME_MAX_LENGTH
setName(String)
,
Constant Field Valuespublic static final int DEFAULT_VALUE_MAX_LENGTH
setDefaultValue(String)
,
Constant Field Valuespublic OdiColumn(OdiDataStore pDatastore, java.lang.String pName)
pDatastore
- the datastore this column belongs topName
- the column's nameDomainRuntimeException
- if the given datastore is null or if the name is null, empty or longer than 128public java.lang.String getDefaultValue()
OdiColumn
instance.setDefaultValue(String)
public void setDefaultValue(java.lang.String pDefaultValue)
OdiColumn
instance.pDefaultValue
- the default value as stringDomainRuntimeException
- if default value is longer than
100getDefaultValue()
public java.lang.Integer getLength()
null
if not defined.
If OdiDataType.isLengthAllowed() is false, always returns null.getLength
in interface IColumn
java.lang.IllegalStateException
- if the DataType is not set.OdiDataType.isLengthAllowed()
,
setLength(Integer)
public void setLength(java.lang.Integer pLength)
pLength
- the length or precision of this columnjava.lang.IllegalStateException
- if the DataType is not set
By default, length of an OdiColumn is defined to 50
.
Note that null
is supported and setting a null
length will make DDL statements create this column with no defined
length.
,
getLength()
public java.lang.Integer getScale()
null
if not defined.
If OdiDataType.isScaleAllowed() is false, always returns null.getScale
in interface IColumn
java.lang.IllegalStateException
- if the DataType is not set.OdiDataType.isScaleAllowed()
,
setScale(Integer)
public void setScale(java.lang.Integer pScale)
pScale
- the scale of this columnjava.lang.IllegalStateException
- if the DataType is not set
Note that null
is supported and setting a null
scale will make DDL statements create this column with no defined
scale.
,
getScale()
public java.lang.Integer getRawLength()
getRawLength
in interface IColumn
public void setRawLength(java.lang.Integer pLength)
public java.lang.Integer getRawScale()
getRawScale
in interface IColumn
public void setRawScale(java.lang.Integer pScale)
public java.lang.String getDescription()
OdiColumn
instance.setDescription(String)
public void setDescription(java.lang.String pDescription)
OdiColumn
instance.pDescription
- the descriptiongetDescription()
public java.lang.String getHeading()
OdiColumn
instance.getHeading
in interface IColumn
setHeading(String)
public void setHeading(java.lang.String pHeading)
OdiColumn
instance.pHeading
- the short description.getHeading()
public java.io.Serializable getInternalId()
OdiColumn
.getInternalId
in interface IRepositoryEntity
getColumnId()
public java.lang.Number getColumnId()
OdiColumn
instance.public void setName(java.lang.String pName)
OdiColumn
.pName
- the column nameDomainRuntimeException
- if the name is null, empty or longer than
128getName()
public java.lang.String getName()
OdiColumn
instance.getName
in interface IModelObject
getName
in interface IOdiEntity
getName
in class oracle.odi.domain.support.AbstractOdiEntity
setName(String)
public IRepositoryEntity getSecurityContainer()
IRepositoryEntity
getSecurityContainer
in interface IRepositoryEntity
public OdiDataStore getDataStore()
OdiDataStore
that owns this column.OdiDataStore
.public OdiDataType getDataType()
getDataType
in interface IColumn
OdiDataType
of this column.setDataType(OdiDataType)
public void setDataType(OdiDataType pDataType)
OdiDataType
as data type for this OdiColumn
.
This is similar to call setDataTypeCode(pDataType.getCode()).pDataType
- the data type of the columnDomainRuntimeException
- 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 int getPosition()
getPosition
in interface IColumn
setPosition(int)
public void setPosition(int pPosition)
pPosition
- the position to setgetPosition()
public boolean isFlowCheckEnabled()
OdiColumn
instance or not.isFlowCheckEnabled
in interface IColumn
true
if flow check is enabled, false
otherwisesetFlowCheckEnabled(boolean)
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 boolean isStaticCheckEnabled()
OdiColumn
instance or not.isStaticCheckEnabled
in interface IColumn
true
if static check is enabled, false
otherwisesetStaticCheckEnabled(boolean)
public void setStaticCheckEnabled(boolean pStaticCheckEnabled)
OdiColumn
instance.
By default, any column has static check enabled.
pStaticCheckEnabled
- the static check is enabled flag.isStaticCheckEnabled()
public boolean isWritable()
OdiColumn
instance is writable, or not.true
if this column is writable, false
otherwisesetWritable(boolean)
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()
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 void setScdType(OdiColumn.ScdType pScdType)
OdiColumn.ScdType
of this OdiColumn
instance.pScdType
- the SCD typegetScdType()
public boolean isMandatory()
isMandatory
in interface IColumn
true
if this column is mandatory, false
otherwisesetMandatory(boolean)
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 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 void setFileDescriptor(OdiColumn.FileDescriptor pFileDescriptor)
OdiColumn
instance.pFileDescriptor
- the file descriptorDomainRuntimeException
- if the parameter value is not consistent
with the parent OdiDataStore
File descriptor.getFileDescriptor()
public OdiDataStore getTable()
IDataStore
interfacepublic java.util.Collection getFlexFieldsValues()
IFlexFieldUser
IFlexFieldUser
.
In most implementations method IFlexFieldUser.initFlexFields(IOdiFlexFieldFinder)
should be
called before calling this method.getFlexFieldsValues
in interface IFlexFieldUser
public void initFlexFields(IOdiFlexFieldFinder pOdiFlexFieldFinder)
IFlexFieldUser
IFlexFieldUser
.initFlexFields
in interface IFlexFieldUser
pOdiFlexFieldFinder
- OdiFlexField
finder to be used to query flex fieldspublic 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 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 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 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 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 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 void setSourceColumn(OdiColumn pSourceColumn)
OdiColumn
if created using common format designer.pSourceColumn
- the source columnpublic OdiColumn getSourceColumn()
OdiColumn
.getSourceColumn
in interface IColumn
public java.lang.String getDdlDataType()
IColumn
getDdlDataType
in interface IColumn
public boolean isVirtual()
IColumn
public OdiColumn.FileDescriptor getFileFieldDescriptor()
IColumn
getFileFieldDescriptor
in interface IColumn
public java.lang.String toString()
toString
in class oracle.odi.domain.support.AbstractOdiEntity