oracle.odi.domain.adapter.relational

Interface IColumn

All Superinterfaces:

IModelObject, IModelObjectBase, IModelObjectWithLocation

All Known Implementing Classes:

OdiColumn

public interface IColumn
extends IModelObjectWithLocation

An interface that represents a column type object in an external model.

It will be implemented by objects that model a relational column.

Since:

12.1.2

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDataFormat() Returns the data format for this instance.
IDataType	getDataType() Obtains the data type of this column.
java.lang.String	getDdlDataType() Get the full DDL data type string for creating the column using SQL DDL.
IFileFieldDescriptor	getFileFieldDescriptor() Gets a file field descriptor instance if this column represents a file field, else null.
java.lang.String	getHeading() Obtains the short description of this column.
java.lang.Integer	getLength() Obtains the length of this column, or null if undefined.
int	getPosition() Gets the position of this column relative to the position of other columns in the owning data store, if available.
java.lang.Integer	getRawLength() Obtains the raw length of this column, or null if undefined.
java.lang.Integer	getRawScale() Obtains the raw scale (for numeric types) of this column, or null if undefined.
java.lang.Integer	getScale() Obtains the scale (for numeric types) of this column, or null if undefined.
IColumn	getSourceColumn() Obtains the source column if it exists.
IDataStore	getTable() Obtains the owning table of this column.
boolean	isFlowCheckEnabled() Returns true if the flow check is enabled for this column.
boolean	isMandatory() Returns true if this column is mandatory (nullable).
boolean	isStaticCheckEnabled() Returns true if the static check is enabled for this column.
boolean	isUsedForPartitioning() Returns true if this column is used for partitioning.
boolean	isVirtual() Returns true if this is a virtual column.
void	setDataFormat(java.lang.String pDataFormat) Sets the data format of this instance.

Methods inherited from interface oracle.odi.domain.adapter.IModelObjectWithLocation

getObjectLocation

Methods inherited from interface oracle.odi.domain.adapter.IModelObject

getName

Methods inherited from interface oracle.odi.domain.adapter.IModelObjectBase

getBigNumericId, getGlobalId, getNumericId

Method Detail

getHeading

java.lang.String getHeading()

Obtains the short description of this column.

Returns:

column short description

getTable

IDataStore getTable()

Obtains the owning table of this column.

Returns:

owning table

getDataType

IDataType getDataType()

Obtains the data type of this column.

Returns:

data type

getScale

java.lang.Integer getScale()

Obtains the scale (for numeric types) of this column, or null if undefined. If the scale is not allowed for DDL with the data type of this column, null will be returned.

Returns:

column scale

getRawScale

java.lang.Integer getRawScale()

Obtains the raw scale (for numeric types) of this column, or null if undefined. The scale will be returned even if it is not allowed for DDL.

Returns:

column' scale

getLength

java.lang.Integer getLength()

Obtains the length of this column, or null if undefined. If the length is not allowed for DDL with the data type of this column, null will be returned.

Returns:

column's length

getRawLength

java.lang.Integer getRawLength()

Obtains the raw length of this column, or null if undefined. The length will be returned even if it is not allowed for DDL.

Returns:

column's length

getDdlDataType

java.lang.String getDdlDataType()

Get the full DDL data type string for creating the column using SQL DDL.

Returns:

The DDL data type string.

isMandatory

boolean isMandatory()

Returns true if this column is mandatory (nullable).

Returns:

true if this column is mandatory, false otherwise

getPosition

int getPosition()

Gets the position of this column relative to the position of other columns in the owning data store, if available.

Returns:

The position value.

getFileFieldDescriptor

IFileFieldDescriptor getFileFieldDescriptor()

Gets a file field descriptor instance if this column represents a file field, else null.

Returns:

file field descriptor, or null if not a file field.

isVirtual

boolean isVirtual()

Returns true if this is a virtual column.

Returns:

true if this is a virtual column, otherwise false.

isUsedForPartitioning

boolean isUsedForPartitioning()

Returns true if this column is used for partitioning.

Returns:

true if this column is used for partitioning, otherwise false.

isStaticCheckEnabled

boolean isStaticCheckEnabled()

Returns true if the static check is enabled for this column.

Returns:

true if static check is enabled, false otherwise

isFlowCheckEnabled

boolean isFlowCheckEnabled()

Returns true if the flow check is enabled for this column.

Returns:

true if flow check is enabled, false otherwise

getSourceColumn

IColumn getSourceColumn()

Obtains the source column if it exists.

Returns:

source column

getDataFormat

java.lang.String getDataFormat()

Returns the data format for this instance.

Returns:

the data format

See Also:

setDataFormat(String)

setDataFormat

void setDataFormat(java.lang.String pDataFormat)

Sets the data format of this instance.

Parameters:

pDataFormat - the data format value

See Also:

getDataFormat()