Package 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

Fields

Modifier and Type	Field	Description
static java.lang.String	PROP_COLUMN_NAMES
static java.lang.String	PROP_DEFAULT_VALUE
static java.lang.String	PROP_REQUIRED

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

PROP_ERROR_MESSAGE, PROP_VALID

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

PROP_DESCRIPTION, PROP_NEW_DFITEM_NAME

Method Summary

Modifier and Type	Method	Description
boolean	acceptsColumn(com.im.commons.db.ddl.DBColInfo columnInfo)	Returns true, if the NT can create a DFField for this type of column.
java.lang.String[]	getColumnNames()
int	getColumnNamesCount()
java.lang.String	getExtraOptionsText()
DFField.Required	getRequired()
boolean	isDisctinctValues()	Deprecated. As of release 6.3, replaced with DFFieldPickListCapability
boolean	isFixedColumn()
void	setColumnNames(java.lang.String[] columnNames)
void	setDisctinctValues(boolean distinctValues)	Deprecated. As of release 6.3, replaced with DFFieldPickListCapability
void	setFixedColumn(boolean fixed)	column cannot be changed in customizer
void	setRequired(DFField.Required required)
float	supportsColumn(com.im.commons.db.ddl.DBColInfo[] columnInfo)	How well supported is this column(s).

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

addPropertyChangeListener, getErrorMessage, isValid, removePropertyChangeListener

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

Field Detail

PROP_COLUMN_NAMES

static final java.lang.String PROP_COLUMN_NAMES

See Also:

Constant Field Values

PROP_DEFAULT_VALUE

static final java.lang.String PROP_DEFAULT_VALUE

See Also:

Constant Field Values

PROP_REQUIRED

static final java.lang.String PROP_REQUIRED

See Also:

Constant Field Values

Method Detail

acceptsColumn

boolean acceptsColumn(com.im.commons.db.ddl.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(com.im.commons.db.ddl.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

java.lang.String[] getColumnNames()

setColumnNames

void setColumnNames(java.lang.String[] columnNames)

setFixedColumn

void setFixedColumn(boolean fixed)

column cannot be changed in customizer

isFixedColumn

boolean isFixedColumn()

isDisctinctValues

@Deprecated
boolean isDisctinctValues()

Deprecated.

As of release 6.3, replaced with DFFieldPickListCapability

setDisctinctValues

@Deprecated
void setDisctinctValues(boolean distinctValues)

Deprecated.

As of release 6.3, replaced with DFFieldPickListCapability

getRequired

DFField.Required getRequired()

setRequired

void setRequired(DFField.Required required)

getExtraOptionsText

java.lang.String getExtraOptionsText()

Returns:

The short information about extra options