com.bowstreet.webapp
Interface DataDefinitionElement

All Known Subinterfaces:

DataDefinitionContainer, DataDefinitionLeaf, PageDataContainer, PageDataElement, PageDataLeaf

All Known Implementing Classes:

Container, Element, Leaf, PageReference

public interface DataDefinitionElement

DDElement.java

Author:

szagieboylo Copyright (c) 2004 Bowstreet, Inc. Interface for DataDefinitionElement. The DataDefinition is an object-based abstract of a schema. A Container will have a list of children. A Leaf will never have children.

Field Summary

static int	DISPLAY_AUTO
static int	DISPLAY_HORIZONTAL
static int	DISPLAY_NO_VISIBLE
static int	DISPLAY_NONE
static int	DISPLAY_VERTICAL
static java.lang.String	KEY_ACTIONTYPE String, one of (form, link, script); Action type of a button, link, or image button
static java.lang.String	KEY_ALWAYS_ADD_VALIDATION_CODE Boolean -- if true, all Data Entry leaves will add the code to the JSP to present a validation message, whether they have validation or not
static java.lang.String	KEY_APPEND_BAD_VALUE_TO_ERROR_MSG Boolean -- if true, then the error message when validation fails will have the user's value appended to it
static java.lang.String	KEY_ATTRIBUTES XML Value!
static java.lang.String	KEY_COLUMN_SUMMARY ColumnCalculator -- used to calculate total, sum, whatever in leaves.
static java.lang.String	KEY_COLUMN_SUMMARY_ARGUMENT
static java.lang.String	KEY_COLUMN_SUMMARY_COLUMN1
static java.lang.String	KEY_COLUMN_SUMMARY_COLUMN2
static java.lang.String	KEY_COLUMN_SUMMARY_NODE
static java.lang.String	KEY_COLUMN_SUMMARY_OPERATION
static java.lang.String	KEY_COLUMN_SUMMARY_STANDARD_VARIABLE
static java.lang.String	KEY_COLUMN_SUMMARY_TEXTAFTER
static java.lang.String	KEY_COLUMN_SUMMARY_TEXTBEFORE
static java.lang.String	KEY_COLUMNALIGNMENT Column alignment, String, one of: left, right, center -- placed on a Leaf node in a Table (See Data Column Modifier)
static java.lang.String	KEY_COLUMNWIDTH Column width, String, placed on a Leaf node in a Table (See Data Column Modifier)
static java.lang.String	KEY_CREATE_ROW_METHOD Name of user-supplied create row method
static java.lang.String	KEY_CREATE_ROW_METHODS Boolean, local-only, set on a Container -- True if Create and Delete methods should be created.
static java.lang.String	KEY_CUSTOMHIDELOCATION
static java.lang.String	KEY_DATA_SOURCE_MANAGER An implementation of the interface com.bowstreet.builders.webapp.pageautomation.content.DataSourceManager
static java.lang.String	KEY_DELETE_METHOD Name of user delete method to be called -- must have the right signature to match value in KEY_DELETE_METHOD_TYPE
static java.lang.String	KEY_DELETE_METHOD_TYPE Style of user-included delete method -- one of DataPageTableModifier.BuilderStaticValues.DMTVAL_????
static java.lang.String	KEY_EMPTYDATAACTION
static java.lang.String	KEY_EMPTYDATAMESSAGE
static java.lang.String	KEY_EMPTYDATAMESSAGE_NAMEDLOCATION
static java.lang.String	KEY_EMPTYDATAMESSAGE_NODE
static java.lang.String	KEY_ERROR_MESSAGE_OVERRIDE String -- Error Message override: will be used instead of the error message from the validator
static java.lang.String	KEY_ESCAPEOUTPUTTEXT Set to cause calls to the Text builder to arrange for output text to be escaped, thereby preventing HTML or other markup to be rendered in text - aiding the prevention of cross-site scripting attacks.
static java.lang.String	KEY_FIELD_MERGE_DEFINITION
static java.lang.String	KEY_GENELEMENT The GenElement for this Page Automation element
static java.lang.String	KEY_GENERATELABELS Boolean -- if false, do not generate labels
static java.lang.String	KEY_HANDLEEXISTING String!
static java.lang.String	KEY_HAS_BEEN_RDD_PROCESSED GENERAL PROPERTIES
static java.lang.String	KEY_INFERCONTROLTYPE Boolean, default true; should Leaf try to infer the control type from the HTML
static java.lang.String	KEY_IS_DATA_TRANSPARENT_CONTAINER Boolean -- set by DHM on Containers that are just for visual grouping and do no participate in data access
static java.lang.String	KEY_IS_POST_GENERATED_ELEMENT Boolean -- set for elements created by DCM and DHM so their Coordinators can recognize their own handiwork
static java.lang.String	KEY_IS_VISUALLY_TRANSPARENT_CONTAINER
static java.lang.String	KEY_ISMODELACTION String!!
static java.lang.String	KEY_KEY_FIELD The key field to be used if KEY_DELETE_METHOD_TYPE is "byKey..."
static java.lang.String	KEY_LABELCLASS_ERROR
static java.lang.String	KEY_LABELCLASS_NOERROR Set to enable label highlighting of errors
static java.lang.String	KEY_LABELTRANSLATETABLE XML Data -- should be same format as generated by Resource Bundle builder - Labels will be translated through it.
static java.lang.String	KEY_LABELTRANSLATEVARIABLE If this has a value, then labels will be translated at runtime through this resource variable.
static java.lang.String	KEY_LAYOUT_GRID
static java.lang.String	KEY_LOOKUP_TABLE String -- the name of a lookup table.
static java.lang.String	KEY_MODIFIERSLIST_DATAENTRY Modifiers Lists.
static java.lang.String	KEY_MODIFIERSLIST_DISPLAYONLY
static java.lang.String	KEY_NO_ASSIGN_IF_VALIDATION_ERROR Boolean -- if true, skips the assign part if validation falis.
static java.lang.String	KEY_ORIGINAL_DATASOURCE
static java.lang.String	KEY_PAGE_GENELEMENT The GenElement associated with the page -- for purposes of constructing tree shown in Designer WebApp view
static java.lang.String	KEY_PUT_ASSIGN_IN_TRY_CATCH Boolean -- if true, wraps assignment code (in SaveDAta method) with try/catch
static java.lang.String	KEY_RADIO_GROUP_STYLE_CLASS String value for the style class to use on wrapper table for Radio Button Groups (Struts/JSF)
static java.lang.String	KEY_RENDEROUTERPAGE String!!
static java.lang.String	KEY_REQUIREDPROMPT String which will be used for any field marked as required in the required prompt location
static java.lang.String	KEY_REQUIREDPROMPTPLACEMENT Integer value!
static java.lang.String	KEY_RESOURCE_KEY_PREFIX Resource key prefix is prefixed to resource key before bundle lookup
static java.lang.String	KEY_SELECT_OPTIONS String -- comma-separated values for a select or radio button group
static java.lang.String	KEY_SEPARATOR String separator value as the attribute setter builder would expect
static java.lang.String	KEY_SPLIT_CHILDREN_INTO_COLUMNS Integer -- This is the number of columns that the contained elements should be split into.
static java.lang.String	KEY_TRANSLATE_HTML_LABELS Boolean -- True if the labels should go through ResourceBundle translation even though there wer on original HTML
static java.lang.String	KEY_UNIQUE_ID_LEVEL if <=0 or missing, uses backwards compat mode, where unique IDs are generated using the fieldname.
static java.lang.String	KEY_USINGCHECKBOXES Boolean -- This will be set automatically if delete column - checkboxes is selected in DCM
static java.lang.String	KEY_VALIDATIONERRORPLACEMENT Integer value!
static java.lang.String	KEY_VARIABLENAME Top level only -- the variable name that got us here
static java.lang.String	TYPE_ANYTYPE
static java.lang.String	TYPE_BOOLEAN
static java.lang.String	TYPE_BYTE
static java.lang.String	TYPE_DATE
static java.lang.String	TYPE_DATETIME
static java.lang.String	TYPE_DECIMAL
static java.lang.String	TYPE_DOUBLE
static java.lang.String	TYPE_FLOATINGPOINT
static java.lang.String	TYPE_INT
static java.lang.String	TYPE_INTEGER
static java.lang.String	TYPE_LONG
static java.lang.String	TYPE_NEGINT
static java.lang.String	TYPE_NONNEGINT
static java.lang.String	TYPE_NONPOSINT
static java.lang.String	TYPE_POSINT
static java.lang.String	TYPE_SHORT
static java.lang.String	TYPE_STRING
static java.lang.String	TYPE_TIME

Method Summary

java.lang.String	bestReadableName() Get the best readable name for this node.
DataDefinitionElement	findDDChild(java.lang.String name) Search through the existing immediate children for one with the passed-in name
boolean	getBooleanProperty(java.lang.String key, boolean defaultValue) See getProperty.
BuilderCall	getBuilderCall() The builderCall which was responsible for creating this element, or perhaps the last one to modify it, if the modification was "significant."
java.lang.String	getDataSourceExtension() Note that if this node has a DataSourceOverride, then the dataSourceExtension is moot
DataDefinitionContainer	getDDParent() Gets the parent of this DDElement
java.lang.String	getDescription() A long description of the element
int	getDisplayMode() See if this node is "turned on" and how it is displaying
int	getIntProperty(java.lang.String key, int defaultValue) See getProperty.
boolean	getIsRepeated() Is this element repeated
boolean	getIsRequired() Is this element required.
java.lang.String	getLabel() Get the label for this element.
java.lang.String	getName() Within a given structure, all the names should be unique.
java.lang.Object	getProperty(java.lang.String key) Get the value with this key.
java.lang.String	getShortLabel() The short label is used only for column headers.
java.lang.String	getStringProperty(java.lang.String key, java.lang.String defaultValue) See getProperty.
java.lang.String	getType() Get the most useful type from the schema.
IXml	getXmlProperty(java.lang.String key, IXml defaultValue) See getProperty.
void	putBothProperties(java.lang.String key, java.lang.Object value) Put a value to be applied to this node AND to be inherited by this element's children
void	putLocalProperty(java.lang.String key, java.lang.Object value) Put a value to apply only to this node
void	putProperty(java.lang.String key, java.lang.Object value) Put a value to be inherited by this element's children
void	setBuilderCall(BuilderCall bc)
void	setDataSourceExtension(java.lang.String s) The dataSourceExtension will be used in generating the Data Source for this node, by taking the parent's Data Source, appending a slash, and then the dataSourceExtension.
void	setDescription(java.lang.String desc)
void	setDisplayMode(int mode)
void	setIsRepeated(boolean b)
void	setIsRequired(boolean b)
void	setLabel(java.lang.String label) Set the label to be used for this element.
void	setShortLabel(java.lang.String label) The short label is used only for column headers.
void	setType(java.lang.String t)

Field Detail

DISPLAY_AUTO

static final int DISPLAY_AUTO

See Also:

Constant Field Values

DISPLAY_HORIZONTAL

static final int DISPLAY_HORIZONTAL

See Also:

Constant Field Values

DISPLAY_NO_VISIBLE

static final int DISPLAY_NO_VISIBLE

See Also:

Constant Field Values

DISPLAY_NONE

static final int DISPLAY_NONE

See Also:

Constant Field Values

DISPLAY_VERTICAL

static final int DISPLAY_VERTICAL

See Also:

Constant Field Values

KEY_ACTIONTYPE

static final java.lang.String KEY_ACTIONTYPE

String, one of (form, link, script); Action type of a button, link, or image button

See Also:

Constant Field Values

KEY_ALWAYS_ADD_VALIDATION_CODE

static final java.lang.String KEY_ALWAYS_ADD_VALIDATION_CODE

Boolean -- if true, all Data Entry leaves will add the code to the JSP to present a validation message, whether they have validation or not

See Also:

Constant Field Values

KEY_APPEND_BAD_VALUE_TO_ERROR_MSG

static final java.lang.String KEY_APPEND_BAD_VALUE_TO_ERROR_MSG

Boolean -- if true, then the error message when validation fails will have the user's value appended to it

See Also:

Constant Field Values

KEY_ATTRIBUTES

static final java.lang.String KEY_ATTRIBUTES

XML Value! This expects the same XML structure that would be passed to an Attribute setter builder

See Also:

Constant Field Values

KEY_COLUMN_SUMMARY

static final java.lang.String KEY_COLUMN_SUMMARY

ColumnCalculator -- used to calculate total, sum, whatever in leaves. These are all local only

See Also:

Constant Field Values

KEY_COLUMN_SUMMARY_ARGUMENT

static final java.lang.String KEY_COLUMN_SUMMARY_ARGUMENT

See Also:

Constant Field Values

KEY_COLUMN_SUMMARY_COLUMN1

static final java.lang.String KEY_COLUMN_SUMMARY_COLUMN1

See Also:

Constant Field Values

KEY_COLUMN_SUMMARY_COLUMN2

static final java.lang.String KEY_COLUMN_SUMMARY_COLUMN2

See Also:

Constant Field Values

KEY_COLUMN_SUMMARY_NODE

static final java.lang.String KEY_COLUMN_SUMMARY_NODE

See Also:

Constant Field Values

KEY_COLUMN_SUMMARY_OPERATION

static final java.lang.String KEY_COLUMN_SUMMARY_OPERATION

See Also:

Constant Field Values

KEY_COLUMN_SUMMARY_STANDARD_VARIABLE

static final java.lang.String KEY_COLUMN_SUMMARY_STANDARD_VARIABLE

See Also:

Constant Field Values

KEY_COLUMN_SUMMARY_TEXTAFTER

static final java.lang.String KEY_COLUMN_SUMMARY_TEXTAFTER

See Also:

Constant Field Values

KEY_COLUMN_SUMMARY_TEXTBEFORE

static final java.lang.String KEY_COLUMN_SUMMARY_TEXTBEFORE

See Also:

Constant Field Values

KEY_COLUMNALIGNMENT

static final java.lang.String KEY_COLUMNALIGNMENT

Column alignment, String, one of: left, right, center -- placed on a Leaf node in a Table (See Data Column Modifier)

See Also:

Constant Field Values

KEY_COLUMNWIDTH

static final java.lang.String KEY_COLUMNWIDTH

Column width, String, placed on a Leaf node in a Table (See Data Column Modifier)

See Also:

Constant Field Values

KEY_CREATE_ROW_METHOD

static final java.lang.String KEY_CREATE_ROW_METHOD

Name of user-supplied create row method

See Also:

Constant Field Values

KEY_CREATE_ROW_METHODS

static final java.lang.String KEY_CREATE_ROW_METHODS

Boolean, local-only, set on a Container -- True if Create and Delete methods should be created.

See Also:

Constant Field Values

KEY_CUSTOMHIDELOCATION

static final java.lang.String KEY_CUSTOMHIDELOCATION

See Also:

Constant Field Values

KEY_DATA_SOURCE_MANAGER

static final java.lang.String KEY_DATA_SOURCE_MANAGER

An implementation of the interface com.bowstreet.builders.webapp.pageautomation.content.DataSourceManager

See Also:

DataSourceManager, Constant Field Values

KEY_DELETE_METHOD

static final java.lang.String KEY_DELETE_METHOD

Name of user delete method to be called -- must have the right signature to match value in KEY_DELETE_METHOD_TYPE

See Also:

Constant Field Values

KEY_DELETE_METHOD_TYPE

static final java.lang.String KEY_DELETE_METHOD_TYPE

Style of user-included delete method -- one of DataPageTableModifier.BuilderStaticValues.DMTVAL_????

See Also:

Constant Field Values

KEY_EMPTYDATAACTION

static final java.lang.String KEY_EMPTYDATAACTION

See Also:

Constant Field Values

KEY_EMPTYDATAMESSAGE

static final java.lang.String KEY_EMPTYDATAMESSAGE

See Also:

Constant Field Values

KEY_EMPTYDATAMESSAGE_NAMEDLOCATION

static final java.lang.String KEY_EMPTYDATAMESSAGE_NAMEDLOCATION

See Also:

Constant Field Values

KEY_EMPTYDATAMESSAGE_NODE

static final java.lang.String KEY_EMPTYDATAMESSAGE_NODE

See Also:

Constant Field Values

KEY_ERROR_MESSAGE_OVERRIDE

static final java.lang.String KEY_ERROR_MESSAGE_OVERRIDE

String -- Error Message override: will be used instead of the error message from the validator

See Also:

Constant Field Values

KEY_ESCAPEOUTPUTTEXT

static final java.lang.String KEY_ESCAPEOUTPUTTEXT

Set to cause calls to the Text builder to arrange for output text to be escaped, thereby preventing HTML or other markup to be rendered in text - aiding the prevention of cross-site scripting attacks. Default set by the system property "bowstreet.security.escapeOutputText"

See Also:

Constant Field Values

KEY_FIELD_MERGE_DEFINITION

static final java.lang.String KEY_FIELD_MERGE_DEFINITION

See Also:

Constant Field Values

KEY_GENELEMENT

static final java.lang.String KEY_GENELEMENT

The GenElement for this Page Automation element

See Also:

Constant Field Values

KEY_GENERATELABELS

static final java.lang.String KEY_GENERATELABELS

Boolean -- if false, do not generate labels

See Also:

Constant Field Values

KEY_HANDLEEXISTING

static final java.lang.String KEY_HANDLEEXISTING

String! Containing "true" or "false," as the attribute setter builder would expect

See Also:

Constant Field Values

KEY_HAS_BEEN_RDD_PROCESSED

static final java.lang.String KEY_HAS_BEEN_RDD_PROCESSED

GENERAL PROPERTIES

See Also:

Constant Field Values

KEY_INFERCONTROLTYPE

static final java.lang.String KEY_INFERCONTROLTYPE

Boolean, default true; should Leaf try to infer the control type from the HTML

See Also:

Constant Field Values

KEY_IS_DATA_TRANSPARENT_CONTAINER

static final java.lang.String KEY_IS_DATA_TRANSPARENT_CONTAINER

Boolean -- set by DHM on Containers that are just for visual grouping and do no participate in data access

See Also:

Constant Field Values

KEY_IS_POST_GENERATED_ELEMENT

static final java.lang.String KEY_IS_POST_GENERATED_ELEMENT

Boolean -- set for elements created by DCM and DHM so their Coordinators can recognize their own handiwork

See Also:

Constant Field Values

KEY_IS_VISUALLY_TRANSPARENT_CONTAINER

static final java.lang.String KEY_IS_VISUALLY_TRANSPARENT_CONTAINER

See Also:

Constant Field Values

KEY_ISMODELACTION

static final java.lang.String KEY_ISMODELACTION

String!! which contains either "true" or "false" determines if action specified is a "Model Action"

See Also:

Constant Field Values

KEY_KEY_FIELD

static final java.lang.String KEY_KEY_FIELD

The key field to be used if KEY_DELETE_METHOD_TYPE is "byKey..."

See Also:

Constant Field Values

KEY_LABELCLASS_ERROR

static final java.lang.String KEY_LABELCLASS_ERROR

See Also:

Constant Field Values

KEY_LABELCLASS_NOERROR

static final java.lang.String KEY_LABELCLASS_NOERROR

Set to enable label highlighting of errors

See Also:

Constant Field Values

KEY_LABELTRANSLATETABLE

static final java.lang.String KEY_LABELTRANSLATETABLE

XML Data -- should be same format as generated by Resource Bundle builder - Labels will be translated through it.

See Also:

Constant Field Values

KEY_LABELTRANSLATEVARIABLE

static final java.lang.String KEY_LABELTRANSLATEVARIABLE

If this has a value, then labels will be translated at runtime through this resource variable. Note: A label will only be translated at runtime IF the resource bundle included an entry for that label.

See Also:

Constant Field Values

KEY_LAYOUT_GRID

static final java.lang.String KEY_LAYOUT_GRID

See Also:

Constant Field Values

KEY_LOOKUP_TABLE

static final java.lang.String KEY_LOOKUP_TABLE

String -- the name of a lookup table. Used in text, select, and radio button group controls

See Also:

Constant Field Values

KEY_MODIFIERSLIST_DATAENTRY

static final java.lang.String KEY_MODIFIERSLIST_DATAENTRY

Modifiers Lists. Applied to controls after the control builder is apoplied. Local only

See Also:

Constant Field Values

KEY_MODIFIERSLIST_DISPLAYONLY

static final java.lang.String KEY_MODIFIERSLIST_DISPLAYONLY

See Also:

Constant Field Values

KEY_NO_ASSIGN_IF_VALIDATION_ERROR

static final java.lang.String KEY_NO_ASSIGN_IF_VALIDATION_ERROR

Boolean -- if true, skips the assign part if validation falis. (in SaveData method)

See Also:

Constant Field Values

KEY_ORIGINAL_DATASOURCE

static final java.lang.String KEY_ORIGINAL_DATASOURCE

See Also:

Constant Field Values

KEY_PAGE_GENELEMENT

static final java.lang.String KEY_PAGE_GENELEMENT

The GenElement associated with the page -- for purposes of constructing tree shown in Designer WebApp view

See Also:

Constant Field Values

KEY_PUT_ASSIGN_IN_TRY_CATCH

static final java.lang.String KEY_PUT_ASSIGN_IN_TRY_CATCH

Boolean -- if true, wraps assignment code (in SaveDAta method) with try/catch

See Also:

Constant Field Values

KEY_RADIO_GROUP_STYLE_CLASS

static final java.lang.String KEY_RADIO_GROUP_STYLE_CLASS

String value for the style class to use on wrapper table for Radio Button Groups (Struts/JSF)

See Also:

Constant Field Values

KEY_RENDEROUTERPAGE

static final java.lang.String KEY_RENDEROUTERPAGE

String!! which contains either "true" or "false" determines if action control should reinvoke the page after invoking the action

See Also:

Constant Field Values

KEY_REQUIREDPROMPT

static final java.lang.String KEY_REQUIREDPROMPT

String which will be used for any field marked as required in the required prompt location

See Also:

Constant Field Values

KEY_REQUIREDPROMPTPLACEMENT

static final java.lang.String KEY_REQUIREDPROMPTPLACEMENT

Integer value! One of DataPageBuilder.Fields.IVEPVAL_...

See Also:

Constant Field Values

KEY_RESOURCE_KEY_PREFIX

static final java.lang.String KEY_RESOURCE_KEY_PREFIX

Resource key prefix is prefixed to resource key before bundle lookup

See Also:

Constant Field Values

KEY_SELECT_OPTIONS

static final java.lang.String KEY_SELECT_OPTIONS

String -- comma-separated values for a select or radio button group

See Also:

Constant Field Values

KEY_SEPARATOR

static final java.lang.String KEY_SEPARATOR

String separator value as the attribute setter builder would expect

See Also:

Constant Field Values

KEY_SPLIT_CHILDREN_INTO_COLUMNS

static final java.lang.String KEY_SPLIT_CHILDREN_INTO_COLUMNS

Integer -- This is the number of columns that the contained elements should be split into. DisplayGroup and DataEntryGroup only

See Also:

Constant Field Values

KEY_TRANSLATE_HTML_LABELS

static final java.lang.String KEY_TRANSLATE_HTML_LABELS

Boolean -- True if the labels should go through ResourceBundle translation even though there wer on original HTML

See Also:

Constant Field Values

KEY_UNIQUE_ID_LEVEL

static final java.lang.String KEY_UNIQUE_ID_LEVEL

if <=0 or missing, uses backwards compat mode, where unique IDs are generated using the fieldname. if == 1, uses modelname, pagename and fieldname. This is the default for new projects if >= 2, uses the unique clientside ID builder.

See Also:

Constant Field Values

KEY_USINGCHECKBOXES

static final java.lang.String KEY_USINGCHECKBOXES

Boolean -- This will be set automatically if delete column - checkboxes is selected in DCM

See Also:

Constant Field Values

KEY_VALIDATIONERRORPLACEMENT

static final java.lang.String KEY_VALIDATIONERRORPLACEMENT

Integer value! One of DataPageBuilder.Fields.IVEPVAL_...

See Also:

Constant Field Values

KEY_VARIABLENAME

static final java.lang.String KEY_VARIABLENAME

Top level only -- the variable name that got us here

See Also:

Constant Field Values

TYPE_ANYTYPE

static final java.lang.String TYPE_ANYTYPE

See Also:

Constant Field Values

TYPE_BOOLEAN

static final java.lang.String TYPE_BOOLEAN

See Also:

Constant Field Values

TYPE_BYTE

static final java.lang.String TYPE_BYTE

See Also:

Constant Field Values

TYPE_DATE

static final java.lang.String TYPE_DATE

See Also:

Constant Field Values

TYPE_DATETIME

static final java.lang.String TYPE_DATETIME

See Also:

Constant Field Values

TYPE_DECIMAL

static final java.lang.String TYPE_DECIMAL

See Also:

Constant Field Values

TYPE_DOUBLE

static final java.lang.String TYPE_DOUBLE

See Also:

Constant Field Values

TYPE_FLOATINGPOINT

static final java.lang.String TYPE_FLOATINGPOINT

See Also:

Constant Field Values

TYPE_INT

static final java.lang.String TYPE_INT

See Also:

Constant Field Values

TYPE_INTEGER

static final java.lang.String TYPE_INTEGER

See Also:

Constant Field Values

TYPE_LONG

static final java.lang.String TYPE_LONG

See Also:

Constant Field Values

TYPE_NEGINT

static final java.lang.String TYPE_NEGINT

See Also:

Constant Field Values

TYPE_NONNEGINT

static final java.lang.String TYPE_NONNEGINT

See Also:

Constant Field Values

TYPE_NONPOSINT

static final java.lang.String TYPE_NONPOSINT

See Also:

Constant Field Values

TYPE_POSINT

static final java.lang.String TYPE_POSINT

See Also:

Constant Field Values

TYPE_SHORT

static final java.lang.String TYPE_SHORT

See Also:

Constant Field Values

TYPE_STRING

static final java.lang.String TYPE_STRING

See Also:

Constant Field Values

TYPE_TIME

static final java.lang.String TYPE_TIME

See Also:

Constant Field Values

Method Detail

bestReadableName

java.lang.String bestReadableName()

Get the best readable name for this node. This will not return null unless the Translate Table has explicitly translated this value to null. If the label and defaultLabel are null, will return the field's name.

Returns:

String, the best Readable Name we can find.

findDDChild

DataDefinitionElement findDDChild(java.lang.String name)

Search through the existing immediate children for one with the passed-in name

Parameters:

name -

Returns:

The DD child or null

getBooleanProperty

boolean getBooleanProperty(java.lang.String key,
                           boolean defaultValue)

See getProperty. Used when the value is known to be Boolean

Parameters:

key - One of the static strings in this class whose names start with KEY_

defaultValue - to be used if the result for this key is null

Returns:

value translated from Boolean to boolean

getBuilderCall

BuilderCall getBuilderCall()

The builderCall which was responsible for creating this element, or perhaps the last one to modify it, if the modification was "significant." This is the builderCall which will recieve any errors or warnings if this node causes a rendering error.

Returns:

The BuilderCall currently associated with this element

getDataSourceExtension

java.lang.String getDataSourceExtension()

Note that if this node has a DataSourceOverride, then the dataSourceExtension is moot

Returns:

this node's dataSourceExtension.

getDDParent

DataDefinitionContainer getDDParent()

Gets the parent of this DDElement

Returns:

the parent

getDescription

java.lang.String getDescription()

A long description of the element

Returns:

the long description

getDisplayMode

int getDisplayMode()

See if this node is "turned on" and how it is displaying

Returns:

Leaf: DISPLAY_NONE or DISPLAY_AUTO; Container: as Leaf, or DISPLAY_VERTICAL or DISPLAY_HORIZONTAL

getIntProperty

int getIntProperty(java.lang.String key,
                   int defaultValue)

See getProperty. Used when the value is known to be an Integer

Parameters:

key - One of the static strings in this class whose names start with KEY_

defaultValue - to be used if the result for this key is null

Returns:

value translated from Integer to int

getIsRepeated

boolean getIsRepeated()

Is this element repeated

Returns:

true if this element is repeated

getIsRequired

boolean getIsRequired()

Is this element required.

Returns:

true if this element is required

getLabel

java.lang.String getLabel()

Get the label for this element. If there is a translation table, this has already been translated.

Returns:

the translated label

getName

java.lang.String getName()

Within a given structure, all the names should be unique. They are prefixed with the parent name in the cases where they otherwise would not be

Returns:

the unique Name of this element

getProperty

java.lang.Object getProperty(java.lang.String key)

Get the value with this key. If this node does not have the value in LocalProperties, look to see if it is inherited from parent.

Parameters:

key - One of the static strings in this class whose names start with KEY_

Returns:

value for this property.

getShortLabel

java.lang.String getShortLabel()

The short label is used only for column headers. Get the short label for this element. If there is a translation table, this has already been translated.

Returns:

the translated label

getStringProperty

java.lang.String getStringProperty(java.lang.String key,
                                   java.lang.String defaultValue)

See getProperty. Used when the value is known to be an String

Parameters:

key - One of the static strings in this class whose names start with KEY_

defaultValue - to be used if the result for this key is null

Returns:

value

getType

java.lang.String getType()

Get the most useful type from the schema. If the immediate type was null, uses parent, etc.

Returns:

String the type

getXmlProperty

IXml getXmlProperty(java.lang.String key,
                    IXml defaultValue)

See getProperty. Used when the value is known to be an IXml

Parameters:

key - One of the static strings in this class whose names start with KEY_

defaultValue - to be used if the result for this key is null

Returns:

value

putBothProperties

void putBothProperties(java.lang.String key,
                       java.lang.Object value)

Put a value to be applied to this node AND to be inherited by this element's children

Parameters:

key - One of the static strings in this class whose names start with KEY_

value - Any value

putLocalProperty

void putLocalProperty(java.lang.String key,
                      java.lang.Object value)

Put a value to apply only to this node

Parameters:

key - One of the static strings in this class whose names start with KEY_

value - Any value

putProperty

void putProperty(java.lang.String key,
                 java.lang.Object value)

Put a value to be inherited by this element's children

Parameters:

key - One of the static strings in this class whose names start with KEY_

value - Any value

setBuilderCall

void setBuilderCall(BuilderCall bc)

setDataSourceExtension

void setDataSourceExtension(java.lang.String s)

The dataSourceExtension will be used in generating the Data Source for this node, by taking the parent's Data Source, appending a slash, and then the dataSourceExtension. Note that if there is a value in the dataSourceOverride, then the dataSourceExtension is ignored. Note that the actual construction of the dataSourceString and the appliedDataSourceString is performed by the DataSourceManager, a pluggable interface

Parameters:

s - extension to parent's Data Source to find this Data source

setDescription

void setDescription(java.lang.String desc)

setDisplayMode

void setDisplayMode(int mode)

setIsRepeated

void setIsRepeated(boolean b)

setIsRequired

void setIsRequired(boolean b)

setLabel

void setLabel(java.lang.String label)

Set the label to be used for this element. It might still be translated through the translation table before being used

Parameters:

label -

setShortLabel

void setShortLabel(java.lang.String label)

The short label is used only for column headers. Set the short label to be used for this element. It might still be translated through the translation table before being used

Parameters:

label -

setType

void setType(java.lang.String t)