org.openlowcode.design.data

Class ChoiceField

java.lang.Object

org.openlowcode.tools.misc.Named

org.openlowcode.design.data.ObjectElement

org.openlowcode.design.data.Field

org.openlowcode.design.data.ChoiceField

All Implemented Interfaces:

NamedInterface

public class ChoiceField
extends Field

A choice field is a field offering a choice to the user between items of a list. As an example would be a choice field asking for size of apparel between S, M, L, XL.

Author:

Open Lowcode SAS

Field Summary

Fields

Modifier and Type	Field and Description
static int	INDEXTYPE_NONE
static int	INDEXTYPE_RAWINDEX
static int	INDEXTYPE_SEARCHWITHNOINDEX

Constructor Summary

Constructors

Constructor and Description
ChoiceField(java.lang.String name, java.lang.String displayname, java.lang.String tooltip, ChoiceCategory choice) creates a choice field to be added to a data object, with default priority and no index
ChoiceField(java.lang.String name, java.lang.String displayname, java.lang.String tooltip, ChoiceCategory choice, int displaypriority) creates a choice field to be added to a data object, with given priority and no index
ChoiceField(java.lang.String name, java.lang.String displayname, java.lang.String tooltip, ChoiceCategory choice, int displaypriority, int indextype) creates a choice field to be added to a data object, with given priority and index

Method Summary

Modifier and Type	Method and Description
Field	copy(java.lang.String newname, java.lang.String newdisplaylabel) performs a copy of the field with new name and new display label
ChoiceCategory	getChoice()
java.lang.String	getDataObjectConstructorAttributes()
java.lang.String	getDataObjectFieldName()
java.lang.String	getJavaType()
StoredElement	getMainStoredElementForCompositeIndex() Returns the main stored element of a field to be used in composite index
void	writeDependentClass(SourceGenerator sg, Module module) only send here classes that are NOT data objects.

Methods inherited from class org.openlowcode.design.data.Field

copy, getDisplayPriority, getParentObject, isNoUserEdition, isShowinbottomnotes, isShowintitle, setDataObjectDefinition, setDisplayPriority, setNoUserEdition, setShowinbottomnotes, setShowInTitle

Methods inherited from class org.openlowcode.design.data.ObjectElement

addElement, AddElementWithSearch, addIndex, getDisplayname, getElements, getIndex, getSearchWidgetList, getTooltip

Methods inherited from class org.openlowcode.tools.misc.Named

changeName, cleanName, equals, getName

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

INDEXTYPE_NONE

public static final int INDEXTYPE_NONE

See Also:

Constant Field Values

INDEXTYPE_SEARCHWITHNOINDEX

public static final int INDEXTYPE_SEARCHWITHNOINDEX

See Also:

Constant Field Values

INDEXTYPE_RAWINDEX

public static final int INDEXTYPE_RAWINDEX

See Also:

Constant Field Values

Constructor Detail

ChoiceField

public ChoiceField(java.lang.String name,
                   java.lang.String displayname,
                   java.lang.String tooltip,
                   ChoiceCategory choice)

creates a choice field to be added to a data object, with default priority and no index

Parameters:

name - unique name of the field, should be a valid java field name and a valid database column name

displayname - description of the field in the default language of the application

tooltip - roll-over tooltip

choice - choice category

ChoiceField

public ChoiceField(java.lang.String name,
                   java.lang.String displayname,
                   java.lang.String tooltip,
                   ChoiceCategory choice,
                   int displaypriority)

creates a choice field to be added to a data object, with given priority and no index

Parameters:

name - unique name of the field, should be a valid java field name and a valid database column name

displayname - description of the field in the default language of the application

tooltip - roll-over tooltip

choice - choice category

displaypriority - length of storage. Should be enough to accomodate the storage code of the expected number of elements

ChoiceField

public ChoiceField(java.lang.String name,
                   java.lang.String displayname,
                   java.lang.String tooltip,
                   ChoiceCategory choice,
                   int displaypriority,
                   int indextype)

creates a choice field to be added to a data object, with given priority and index

Parameters:

name - unique name of the field, should be a valid java field name and a valid database column name

displayname - description of the field in the default language of the application

tooltip - roll-over tooltip

choice - choice category

displaypriority - length of storage. Should be enough to accomodate the storage code of the expected number of elements

indextype - type of index as defined in a constant integer on this class

Method Detail

getChoice

public ChoiceCategory getChoice()

Returns:

returns the choice category used for this choice field

getDataObjectFieldName

public java.lang.String getDataObjectFieldName()

Specified by:

getDataObjectFieldName in class ObjectElement

Returns:

the unique name of the field

getDataObjectConstructorAttributes

public java.lang.String getDataObjectConstructorAttributes()

Specified by:

getDataObjectConstructorAttributes in class ObjectElement

Returns:

the attributes for the constructor to be used during code generation

getJavaType

public java.lang.String getJavaType()

Specified by:

getJavaType in class ObjectElement

Returns:

the java type of the object element in data object code

writeDependentClass

public void writeDependentClass(SourceGenerator sg,
                                Module module)
                         throws java.io.IOException

Description copied from class: ObjectElement

only send here classes that are NOT data objects. For data object dependencies for properties, use the property method getExternalObjectDependence TODO: needs to replace this logic by the sending of list of strings to remove duplicates issue #12

Specified by:

writeDependentClass in class ObjectElement

Throws:

java.io.IOException

getMainStoredElementForCompositeIndex

public StoredElement getMainStoredElementForCompositeIndex()

Description copied from class: Field

Returns the main stored element of a field to be used in composite index

Specified by:

getMainStoredElementForCompositeIndex in class Field

Returns:

a stored element

copy

public Field copy(java.lang.String newname,
                  java.lang.String newdisplaylabel)

Description copied from class: Field

performs a copy of the field with new name and new display label

Specified by:

copy in class Field

Parameters:

newname - newname for the field (null if keep originalname)

newdisplaylabel - new display label (null to keep original display name)

Returns: