public interface IColumn extends IModelObjectWithLocation
It will be implemented by objects that model a relational column.
Modifier and Type | Method and Description |
---|---|
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 |
isVirtual()
Returns true if this is a virtual column.
|
getGlobalId, getName, getNumericId
java.lang.String getHeading()
IDataStore getTable()
IDataType getDataType()
java.lang.Integer getScale()
null
if undefined.
If the scale is not allowed for DDL with the data type of this column, null
will be returned.java.lang.Integer getRawScale()
null
if undefined. The scale will
be returned even if it is not allowed for DDL.java.lang.Integer getLength()
null
if undefined.
If the length is not allowed for DDL with the data type of this column, null
will be returned.java.lang.Integer getRawLength()
null
if undefined. The length will
be returned even if it is not allowed for DDL.java.lang.String getDdlDataType()
boolean isMandatory()
true
if this column is mandatory, false
otherwiseint getPosition()
IFileFieldDescriptor getFileFieldDescriptor()
boolean isVirtual()
boolean isStaticCheckEnabled()
true
if static check is enabled, false
otherwiseboolean isFlowCheckEnabled()
true
if flow check is enabled, false
otherwiseIColumn getSourceColumn()