org.openlowcode.design.data

Class ObjectElement

java.lang.Object

org.openlowcode.tools.misc.Named

org.openlowcode.design.data.ObjectElement

All Implemented Interfaces:

NamedInterface

Direct Known Subclasses:

Field, Property

public abstract class ObjectElement
extends Named

An object element is a brick of an object. It will contain stored information, binary search indexes, and potentially a list of search widgets to display in search pages

Author:

Open Lowcode SAS

Constructor Summary

Constructors

Constructor and Description
ObjectElement(java.lang.String name, java.lang.String displayname, java.lang.String tooltip) creates an object element

Method Summary

Modifier and Type	Method and Description
void	addElement(Element element)
void	AddElementWithSearch(Element element, SearchWidgetDefinition searchwidget) adds an element with a search widget
void	addIndex(Index index)
abstract java.lang.String	getDataObjectConstructorAttributes()
abstract java.lang.String	getDataObjectFieldName()
java.lang.String	getDisplayname()
Element[]	getElements() get all the data elements of the object element
Index[]	getIndex() get all the binary search indexes for the object element
abstract java.lang.String	getJavaType()
SearchWidgetDefinition[]	getSearchWidgetList()
java.lang.String	getTooltip()
abstract void	writeDependentClass(SourceGenerator sg, Module module) only send here classes that are NOT data objects.

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

Constructor Detail

ObjectElement

public ObjectElement(java.lang.String name,
                     java.lang.String displayname,
                     java.lang.String tooltip)

creates an object element

Parameters:

name - name of the element

displayname - display name of the element (not used for property, see #13)

tooltip - roll-over tooltip (not used for property, see #13)

Method Detail

getSearchWidgetList

public SearchWidgetDefinition[] getSearchWidgetList()

Returns:

the list of search widgets for this object element

getDisplayname

public java.lang.String getDisplayname()

Returns:

label of the widget TODO should be moved to field, see issue #13

getTooltip

public java.lang.String getTooltip()

Returns:

tooltip roll-over tooltip for the element TODO should be moved to field, see issue #13

addIndex

public void addIndex(Index index)

Parameters:

index - adds an index to the object element

addElement

public void addElement(Element element)

Parameters:

element - adds a data element to the object element

AddElementWithSearch

public void AddElementWithSearch(Element element,
                                 SearchWidgetDefinition searchwidget)

adds an element with a search widget

Parameters:

element - data element (mostly stored element)

searchwidget - search widget to use for the element

getElements

public Element[] getElements()

get all the data elements of the object element

Returns:

an array with the elements

getIndex

public Index[] getIndex()

get all the binary search indexes for the object element

Returns:

an array of all the indexes

getDataObjectFieldName

public abstract java.lang.String getDataObjectFieldName()

Returns:

the unique name of the field

getDataObjectConstructorAttributes

public abstract java.lang.String getDataObjectConstructorAttributes()

Returns:

the attributes for the constructor to be used during code generation

getJavaType

public abstract java.lang.String getJavaType()

Returns:

the java type of the object element in data object code

writeDependentClass

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

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

Parameters:

sg -

module -

Throws:

java.io.IOException