com.sap.sl.sdk.authoring.datafoundation

Interface Column

All Superinterfaces:

Identifiable, Nameable

All Known Subinterfaces:

CalculatedColumn, DatabaseColumn, InputColumn

public interface Column
extends Identifiable, Nameable

A representation of the 'Column' model object.

This is the base interface for column type objects (CalculatedColumn and InputColumn).

Use DataFoundationFactory.createColumn(String, SQLDataType, Table) to instantiate a column of a data foundation table.

The following features are supported:

• Description
• Table
• Data Type
• Nullable
• Signed
• Visible

Method Summary

Modifier and Type	Method and Description
SQLDataType	getDataType() Returns the value of the 'Data Type' attribute.
java.lang.String	getDescription() Returns the value of the 'Description' attribute.
Table	getTable() Returns the value of the 'Table' container reference.
boolean	isNullable() Returns the value of the 'Nullable' attribute.
boolean	isSigned() Returns the value of the 'Signed' attribute.
boolean	isVisible() Returns the value of the 'Visible' attribute.
void	setDataType(SQLDataType value) Sets the value of the 'Data Type' attribute.
void	setDescription(java.lang.String value) Sets the value of the 'Description' attribute.
void	setNullable(boolean value) Sets the value of the 'Nullable' attribute.
void	setSigned(boolean value) Sets the value of the 'Signed' attribute.
void	setVisible(boolean value) Sets the value of the 'Visible' attribute.

Methods inherited from interface com.sap.sl.sdk.authoring.commons.Identifiable

getIdentifier

Methods inherited from interface com.sap.sl.sdk.authoring.commons.Nameable

getName, setName

Method Detail

getDescription

java.lang.String getDescription()

Returns the value of the 'Description' attribute.

This string represents the description of the column.

Returns:

the value of the 'Description' attribute.

See Also:

setDescription(String)

setDescription

void setDescription(java.lang.String value)

Sets the value of the 'Description' attribute.

This string represents the description of the column.

Parameters:

value - the new value of the 'Description' attribute.

See Also:

getDescription()

getTable

Table getTable()

Returns the value of the 'Table' container reference. It is bidirectional and its opposite is 'Columns'.

This represents the name of a table of the data foundation.

Returns:

the value of the 'Table' container reference.

See Also:

Table.getColumns()

getDataType

SQLDataType getDataType()

Returns the value of the 'Data Type' attribute. The literals are from the enumeration SQLDataType.

This represents the SQL data type of the column.

Returns:

the value of the 'Data Type' attribute.

See Also:

SQLDataType, setDataType(SQLDataType)

setDataType

void setDataType(SQLDataType value)

Sets the value of the 'Data Type' attribute.

Parameters:

value - the new value of the 'Data Type' attribute.

See Also:

SQLDataType, getDataType()

isNullable

boolean isNullable()

Returns the value of the 'Nullable' attribute.

Checks if the column is nullable.

Returns:

the value of the 'Nullable' attribute.

See Also:

setNullable(boolean)

setNullable

void setNullable(boolean value)

Sets the value of the 'Nullable' attribute.

Parameters:

value - the new value of the 'Nullable' attribute.

See Also:

isNullable()

isSigned

boolean isSigned()

Returns the value of the 'Signed' attribute.

Checks if the column content is signed.

Returns:

the value of the 'Signed' attribute.

See Also:

setSigned(boolean)

setSigned

void setSigned(boolean value)

Sets the value of the 'Signed' attribute.

In the information design tool, you select the "Unsigned" checkbox to make the column unsigned. This method makes the column signed if value is true.

Parameters:

value - the new value of the 'Signed' attribute.

See Also:

isSigned()

isVisible

boolean isVisible()

Returns the value of the 'Visible' attribute. The default value is "true".

Checks if the column is displayed in the data foundation editor.

Returns:

the value of the 'Visible' attribute.

See Also:

setVisible(boolean)

setVisible

void setVisible(boolean value)

Sets the value of the 'Visible' attribute.

Displays or hides the corresponding column in the data foundation editor.

Parameters:

value - the new value of the 'Visible' attribute.

See Also:

isVisible()