com.im.df.api.support
Interface DFNewTypeWellKnownOptions.ExistingDBField

All Superinterfaces:

DFNewTypeOptions, DFNewTypeWellKnownOptions.FieldOptions, DFNewTypeWellKnownOptions.SingleDFItem

Enclosing interface:

DFNewTypeWellKnownOptions

public static interface DFNewTypeWellKnownOptions.ExistingDBField
extends DFNewTypeWellKnownOptions.FieldOptions

Options for creating a DFField where database column(s) already exist (so called promoting column(s) to DFField).

Field Summary

static String	PROP_COLUMN_NAMES
static String	PROP_DEFAULT_VALUE
static String	PROP_DISTINCT_VALUES
static String	PROP_REQUIRED

Fields inherited from interface com.im.df.api.support.DFNewTypeWellKnownOptions.SingleDFItem

PROP_DESCRIPTION, PROP_NEW_DFITEM_NAME

Fields inherited from interface com.im.df.api.support.DFNewTypeOptions

PROP_ERROR_MESSAGE, PROP_VALID

Method Summary

boolean	acceptsColumn(DBColInfo columnInfo) Returns true, if the NT can create a DFField for this type of column.
String[]	getColumnNames()
int	getColumnNamesCount()
String	getExtraOptionsText()
DFField.Required	getRequired()
boolean	isDisctinctValues()
boolean	isFixedColumn()
void	setColumnNames(String[] columnNames)
void	setDisctinctValues(boolean disctinctValues)
void	setFixedColumn(boolean fixed) column cannot be changed in customizer
void	setRequired(DFField.Required required)
float	supportsColumn(DBColInfo[] columnInfo) How well supported is this column(s).

Methods inherited from interface com.im.df.api.support.DFNewTypeWellKnownOptions.FieldOptions

createInsertOptions, getConvertor

Methods inherited from interface com.im.df.api.support.DFNewTypeWellKnownOptions.SingleDFItem

getDescription, getNewDFItemName, setDescription, setNewDFItemName, setNewDFItemNameSafe

Methods inherited from interface com.im.df.api.support.DFNewTypeOptions

addPropertyChangeListener, getErrorMessage, isValid, removeAllPropertyChangeListener, removePropertyChangeListener

Field Detail

PROP_COLUMN_NAMES

static final String PROP_COLUMN_NAMES

See Also:

Constant Field Values

PROP_DEFAULT_VALUE

static final String PROP_DEFAULT_VALUE

See Also:

Constant Field Values

PROP_DISTINCT_VALUES

static final String PROP_DISTINCT_VALUES

See Also:

Constant Field Values

PROP_REQUIRED

static final String PROP_REQUIRED

See Also:

Constant Field Values

Method Detail

acceptsColumn

boolean acceptsColumn(DBColInfo columnInfo)

Returns true, if the NT can create a DFField for this type of column. This method returns true if supportsColumn(com.im.commons.db.ddl.DBColInfo[]) returns value greater than 0. This method returns false if supportsColumn(com.im.commons.db.ddl.DBColInfo[]) returns zero.

TODO - signature of this method might change in the future when multi-column fields will be supported.

supportsColumn

float supportsColumn(DBColInfo[] columnInfo)

How well supported is this column(s). Zero means not at all supported, one means ideally supported, and anything in between means something in between

Parameters:

columnInfo - Array of columns. Usually array will have just one item as each field represent typically one column.

Returns:

A number between 0 and 1 (including 0 and 1)

See Also:

acceptsColumn(com.im.commons.db.ddl.DBColInfo)

getColumnNamesCount

int getColumnNamesCount()

getColumnNames

String[] getColumnNames()

setColumnNames

void setColumnNames(String[] columnNames)

setFixedColumn

void setFixedColumn(boolean fixed)

column cannot be changed in customizer

isFixedColumn

boolean isFixedColumn()

isDisctinctValues

boolean isDisctinctValues()

setDisctinctValues

void setDisctinctValues(boolean disctinctValues)

getRequired

DFField.Required getRequired()

setRequired

void setRequired(DFField.Required required)

getExtraOptionsText

String getExtraOptionsText()

Returns:

The short information about extra options