org.ujac.util.table
Interface Column

All Superinterfaces:

TableConstants, UjacTypes

All Known Implementing Classes:

BeanColumn, DefaultColumn, PrintTableTag.DummyColumn, PrintTableTag.DummyColumn

public interface Column
extends TableConstants

Name: Column
Description: A class holding definitions of table columns.

Author:

lauerc

Field Summary

Fields inherited from interface org.ujac.util.table.TableConstants

DEFAULT_DATE_FORMAT, DEFAULT_DOUBLE_FORMAT, DEFAULT_INTEGER_FORMAT, DEFAULT_TIME_FORMAT, DEFAULT_TIMESTAMP_FORMAT, ROW_TYPE_FOOTER, ROW_TYPE_GROUP, ROW_TYPE_GROUP_TITLE, ROW_TYPE_HEADER, ROW_TYPE_NORMAL

Fields inherited from interface org.ujac.util.UjacTypes

TYPE_BOOLEAN, TYPE_DATE, TYPE_DOUBLE, TYPE_FLOAT, TYPE_INT, TYPE_LONG, TYPE_NAME_BOOLEAN, TYPE_NAME_DATE, TYPE_NAME_DOUBLE, TYPE_NAME_FLOAT, TYPE_NAME_INT, TYPE_NAME_LONG, TYPE_NAME_OBJECT, TYPE_NAME_SHORT, TYPE_NAME_STRING, TYPE_NAME_TABLE, TYPE_NAME_TIME, TYPE_NAME_TIMESTAMP, TYPE_OBJECT, TYPE_SHORT, TYPE_STRING, TYPE_TABLE, TYPE_TIME, TYPE_TIMESTAMP

Method Summary

String	getAlias() Gets the column alias.
int	getDataIndex() Gets the data index.
Format	getFormat() Gets the colum format.
int	getIndex() Gets the colum index.
LayoutHints	getLayoutHints() Gets the layout hints.
String	getName() Gets the colum name.
int	getType() Gets the colum name.
String	getTypeName() Gets the name of the column type.
boolean	isKey() Tells wheter this column defines a key value or not.
Column	setAlias(String alias) Sets the colum alias.
Column	setDataIndex(int dataIndex) Sets the data index.
Column	setFormat(Format format) Sets the colum format.
Column	setFormat(String format) Sets the colum format.
Column	setIndex(int index) Sets the colum index.
Column	setKey(boolean key) Sets the key flag.
Column	setLayoutHints(LayoutHints layoutHints) Sets the layout hints.
void	setType(int typeId) Sets the colum type.

Method Detail

getName

String getName()

Gets the colum name.

Returns:

The column name.

isKey

boolean isKey()

Tells wheter this column defines a key value or not.

Returns:

true if this column defines a key value, else false.

setKey

Column setKey(boolean key)

Sets the key flag.

Parameters:

key - The key flag to set.

Returns:

A reference to this instance for more convinience.

getType

int getType()

Gets the colum name.

Returns:

The column type.

setType

void setType(int typeId)

Sets the colum type. This method is for internal usage only, please use method Table.setColumnType(int, int) instead.

Parameters:

typeId - The column type to set.

getAlias

String getAlias()

Gets the column alias.

Returns:

The column alias.

setAlias

Column setAlias(String alias)

Sets the colum alias.

Parameters:

alias - The new column alias.

Returns:

A reference to this instance for more convinience.

getFormat

Format getFormat()

Gets the colum format.

Returns:

The column format.

setFormat

Column setFormat(Format format)

Sets the colum format.

Parameters:

format - The new column format.

Returns:

A reference to this instance for more convinience.

setFormat

Column setFormat(String format)

Sets the colum format.

Parameters:

format - The format string to use.

Returns:

A reference to this instance for more convinience.

getIndex

int getIndex()

Gets the colum index.

Returns:

The column index.

setIndex

Column setIndex(int index)

Sets the colum index.

Parameters:

index - The new column index.

Returns:

A reference to this instance for more convinience.

getDataIndex

int getDataIndex()

Gets the data index.

Returns:

The data index.

setDataIndex

Column setDataIndex(int dataIndex)

Sets the data index.

Parameters:

dataIndex - The new data index.

Returns:

A reference to this instance for more convinience.

getLayoutHints

LayoutHints getLayoutHints()

Gets the layout hints.

Returns:

Returns the layout hints.

setLayoutHints

Column setLayoutHints(LayoutHints layoutHints)

Sets the layout hints.

Parameters:

layoutHints - The layout hints to set.

Returns:

A reference to this instance for more convinience.

getTypeName

String getTypeName()

Gets the name of the column type.

Returns:

the name of the type or UNKNOWN.