Skip navigation links

oracle.odi.domain.model
Class OdiColumn

java.lang.Object
oracle.odi.domain.support.BusinessObject
oracle.odi.domain.support.AbstractRepositoryEntity
oracle.odi.domain.support.AbstractOdiEntity
oracle.odi.domain.model.OdiColumn

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, IFlexFieldUser, IOdiEntity, IRepositoryEntity, IWorkDevelopmentOdiEntity, IColumn<OdiDataStore>

public class OdiColumn

extends oracle.odi.domain.support.AbstractOdiEntity

implements IColumn<OdiDataStore>, IWorkDevelopmentOdiEntity, IFlexFieldUser

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.

Since:

11.1.1.3.0

See Also:

Serialized Form

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

NAME_MAX_LENGTH

public static final int NAME_MAX_LENGTH

Maximum length supported for the "name" property.

See Also:

setName(String), Constant Field Values

DEFAULT_VALUE_MAX_LENGTH

public static final int DEFAULT_VALUE_MAX_LENGTH

Maximum length supported for the "defaultValue" property.

See Also:

setDefaultValue(String), Constant Field Values

Constructor Detail

OdiColumn

public OdiColumn(OdiDataStore pDatastore,
                 java.lang.String pName)

Creates a column with the given name, bound to datastore pDatastore.

Parameters:

pDatastore - the datastore this column belongs to

pName - the column's name

Throws:

DomainRuntimeException - if the given datastore is null or if the name is null, empty or longer than 128

Method Detail

getDefaultValue

public java.lang.String getDefaultValue()

Returns the default value for this OdiColumn instance.

Returns:

the default value.

See Also:

setDefaultValue(String)

setDefaultValue

public void setDefaultValue(java.lang.String pDefaultValue)

Sets the default value of this OdiColumn instance.

Parameters:

pDefaultValue - the default value as string

Throws:

DomainRuntimeException - if default value is longer than 100

See Also:

getDefaultValue()

getLength

public java.lang.Integer getLength()

Get the length or precision of this column. Maybe null if not defined.

Specified by:

getLength in interface IColumn<OdiDataStore>

Returns:

the length or precision.

Throws:

java.lang.IllegalStateException - if the DataType is not set

See Also:

OdiDataType.isLengthAllowed(), setLength(Integer)

setLength

public void setLength(java.lang.Integer pLength)

Set the length or precision of this column. Before setting the length, caller can determine length is valid for this dat type 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.

Specified by:

setLength in interface IColumn<OdiDataStore>

Parameters:

pLength - the length or precision

Throws:

java.lang.IllegalStateException - if the DataType is not set

See Also:

OdiDataType.isLengthAllowed(), getLength()

getScale

public java.lang.Integer getScale()

Get the scale for numeric types. Maybe null if not defined.

Specified by:

getScale in interface IColumn<OdiDataStore>

Returns:

the scale.

Throws:

java.lang.IllegalStateException - if the DataType is not set

See Also:

OdiDataType.isScaleAllowed(), setScale(Integer)

setScale

public void setScale(java.lang.Integer pScale)

Set the scale for numeric types. Before setting the scale, caller can determine if scale is valid for this data type OdiDataType.isScaleAllowed().

Note that null is supported and defining a null scale will make DDL statements creating this column with no defined scale.

Specified by:

setScale in interface IColumn<OdiDataStore>

Parameters:

pScale - the new scale

Throws:

java.lang.IllegalStateException - if the DataType is not set

See Also:

OdiDataType.isScaleAllowed(), getScale()

getDescription

public java.lang.String getDescription()

Returns the description of this OdiColumn instance.

Returns:

the description.

See Also:

setDescription(String)

setDescription

public void setDescription(java.lang.String pDescription)

Sets the description of this OdiColumn instance.

Parameters:

pDescription - the description

See Also:

getDescription()

getHeading

public java.lang.String getHeading()

Returns the short description of this OdiColumn instance.

Returns:

the short description.

See Also:

setHeading(String)

setHeading

public void setHeading(java.lang.String pHeading)

Defines the short description of this OdiColumn instance.

Parameters:

pHeading - the short description.

See Also:

getHeading()

getInternalId

public java.io.Serializable getInternalId()

Returns the internal identifier of this OdiColumn.

Specified by:

getInternalId in interface IRepositoryEntity

Returns:

the internal ID.

See Also:

getColumnId()

getColumnId

public java.lang.Number getColumnId()

Returns the internal identifier of this OdiColumn instance.

Returns:

the column ID.

getName

public java.lang.String getName()

Returns the name of this OdiColumn instance.

Specified by:

getName in interface IOdiEntity

Specified by:

getName in interface IColumn<OdiDataStore>

Overrides:

getName in class oracle.odi.domain.support.AbstractOdiEntity

Returns:

the name of the OdiColumn

See Also:

setName(String)

getSecurityContainer

public IRepositoryEntity getSecurityContainer()

Description copied from interface: IRepositoryEntity

Define a generic way to retrieve container for entities.

Specified by:

getSecurityContainer in interface IRepositoryEntity

Returns:

container entity

getDataStore

public OdiDataStore getDataStore()

Returns the OdiDataStore that owns this column.

Returns:

the parent OdiDataStore.

getDataType

public OdiDataType getDataType()

Obtains the OdiDataType defined as data type for this OdiColumn, or null if undefined.

Specified by:

getDataType in interface IColumn<OdiDataStore>

Returns:

the OdiDataType of this column.

See Also:

setDataType(OdiDataType)

setDataType

public void setDataType(OdiDataType pDataType)

Defines the OdiDataType as data type for this OdiColumn. This is similar to call setDataTypeCode(pDataType.getCode()).

Specified by:

setDataType in interface IColumn<OdiDataStore>

Parameters:

pDataType - the data type of the column

Throws:

DomainRuntimeException - if the given data type is null or if the given data type doesn't belong to the technology of that column

See Also:

OdiDataType, setDataTypeCode(String), getDataType()

setDataTypeCode

public void setDataTypeCode(java.lang.String pDataTypeCode)

Defines the DataType code for this OdiColumn.

Parameters:

pDataTypeCode - the datatype code.

See Also:

setDataTypeCode(String)

getPosition

public int getPosition()

Get the column ordinal position.

Returns:

the position.

See Also:

setPosition(int)

isFlowCheckEnabled

public boolean isFlowCheckEnabled()

Return whether the flow check is enabled for this OdiColumn instance or not.

Returns:

true if flow check is enabled, false otherwise

See Also:

setFlowCheckEnabled(boolean)

setFlowCheckEnabled

public void setFlowCheckEnabled(boolean pFlowCheckEnabled)

Defines whether the flow check is enabled for this OdiColumn instance or not.

By default, any column has flow check enabled.

Parameters:

pFlowCheckEnabled - true to enable flow check, false otherwise

See Also:

isFlowCheckEnabled()

isStaticCheckEnabled

public boolean isStaticCheckEnabled()

Return whether the static check is enabled for this OdiColumn instance or not.

Returns:

true if static check is enabled, false otherwise

See Also:

setStaticCheckEnabled(boolean)

setStaticCheckEnabled

public void setStaticCheckEnabled(boolean pStaticCheckEnabled)

Defines whether the static check is enabled for this OdiColumn instance.

By default, any column has static check enabled.

Parameters:

pStaticCheckEnabled - the static check is enabled flag.

See Also:

isStaticCheckEnabled()

isWritable

public boolean isWritable()

Return whether this OdiColumn instance is writable, or not.

Returns:

true if this column is writable, false otherwise

See Also:

setWritable(boolean)

setWritable

public void setWritable(boolean pWritable)

Defines whether this OdiColumn instance is writable or not.

By default, any column is writable.

Parameters:

pWritable - true to make this column writable, false otherwise

See Also:

isWritable()

getScdType

public OdiColumn.ScdType getScdType()

Returns the OdiColumn.ScdType of this OdiColumn instance.

Returns:

the OdiColumn.ScdType for this column.

See Also:

setScdType(oracle.odi.domain.model.OdiColumn.ScdType), setScdType(ScdType)

setScdType

public void setScdType(OdiColumn.ScdType pScdType)

Defines the OdiColumn.ScdType of this OdiColumn instance.

Parameters:

pScdType - the SCD type

See Also:

getScdType()

isMandatory

public boolean isMandatory()

Return whether this column is mandatory (aka nullable) or not.

Returns:

true if this column is mandatory, false otherwise

See Also:

setMandatory(boolean)

setMandatory

public void setMandatory(boolean pMandatory)

Defines whether this OdiColumn instance if mandatory or not.

By default a column is not mandatory.

Parameters:

pMandatory - true if this column is mandatory, false otherwise

See Also:

isMandatory()

getFileDescriptor

public OdiColumn.FileDescriptor getFileDescriptor()

Returns the OdiColumn.FileDescriptor for this OdiColumn instance, or null if none.

If this OdiColumn model is not of technology File, it will be null.

Returns:

the FileDescriptor for this column

See Also:

setFileDescriptor(oracle.odi.domain.model.OdiColumn.FileDescriptor), setFileDescriptor(FileDescriptor)

setFileDescriptor

public void setFileDescriptor(OdiColumn.FileDescriptor pFileDescriptor)

Sets the file description (i.e. information related to files) for this OdiColumn instance.

Parameters:

pFileDescriptor - the file descriptor

Throws:

DomainRuntimeException - if the parameter value is not consistent with the parent OdiDataStore File descriptor.

See Also:

getFileDescriptor()

getTable

public OdiDataStore getTable()

Obtains the parent OdiDataStore but match the IDataStore interface

Specified by:

getTable in interface IColumn<OdiDataStore>

Returns:

the parent OdiDataStore.

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

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

setDataServiceAllowInsert

public void setDataServiceAllowInsert(boolean pDataServiceAllowInsert)

Set to true if you want to allow data services to perform insert on this column.

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.

Parameters:

pDataServiceAllowInsert - true if data services should allow insert on this column, false otherwise

isDataServiceAllowInsert

public boolean isDataServiceAllowInsert()

Will data services be allowed to perform insert on this column.

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.

Returns:

true if data services should allow insert on this column, false otherwise

setDataServiceAllowUpdate

public void setDataServiceAllowUpdate(boolean pDataServiceAllowUpdate)

Set to true if you want to allow data services to perform update on this column.

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.

Parameters:

pDataServiceAllowUpdate - true if data services should allow update on this column, false otherwise

isDataServiceAllowUpdate

public boolean isDataServiceAllowUpdate()

Will data services be allowed to perform update on this column.

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.

Returns:

true if data services should allow update on this column, false otherwise

setDataServiceAllowSelect

public void setDataServiceAllowSelect(boolean pDataServiceAllowSelect)

Set to true if you want to allow data services to perform select on this column.

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.

Parameters:

pDataServiceAllowSelect - true if data services should allow select on this column, false otherwise

isDataServiceAllowSelect

public boolean isDataServiceAllowSelect()

Will data services be allowed to perform select on this column.

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.

Returns:

true if data services should allow select on this column, false otherwise

Skip navigation links