de.must.markup

Class DataPropertyAdministration

java.lang.Object

de.must.markup.Dialog

de.must.markup.PropertyAdministration

de.must.markup.DataPropertyAdministration

All Implemented Interfaces:

Invokable

public abstract class DataPropertyAdministration
extends PropertyAdministration

Frame-like container to enclose input-output fields like text fields with database field association and controlling load and save actions. Used for property administration of a single database record. It is meant to contain several storables like e.g. DataTextField

Field Summary

Fields

Modifier and Type	Field and Description
static int	MODE_COPY
static int	MODE_NEW
static int	MODE_PROPERTY
static int	MODE_VIRGIN

Fields inherited from class de.must.markup.PropertyAdministration

currentAttributeList, dialogNbr, wantToBeFinalized

Fields inherited from class de.must.markup.Dialog

additionalButtons, backButton, cancelButton, NAME_FOR_BACK_ACTION, NAME_FOR_CANCEL_ACTION, NAME_FOR_CLOSE_ACTION, NAME_FOR_DIALOG_NBR, NAME_FOR_HELP_ACTION, NAME_FOR_LIST_ACTION, NAME_FOR_NEW_ENTRY_ACTION, NAME_FOR_OK_ACTION, okButton, processComplete, sessionData, stackMovement

Constructor Summary

Constructors

Constructor and Description
DataPropertyAdministration(DataObject mainDataObject, SessionData sessionData) Constructs a new data property administration.
DataPropertyAdministration(SessionData sessionData) Constructs a new data property administration.

Method Summary

Modifier and Type	Method and Description
protected void	append(java.lang.String stringToAppend) Appends a string to the same line as previously used.
protected DataCheckBox	createCheckBox(java.lang.String checkLabel, java.lang.String columnName) Creates a database connected check box in the same line as previously used.
protected DataCheckBox	createCheckBox(java.lang.String lineLabel, java.lang.String checkLabel, java.lang.String columnName) Creates a database connected check box in a new line with its describing label.
protected DataCheckBox	createCheckBox(java.lang.String lineLabel, java.lang.String checkLabel, java.lang.String columnName, java.lang.String trueString, java.lang.String falseString)
protected DataVariableChoice	createChoice(java.lang.String label, java.lang.String[][] content, java.lang.String columnName) Creates a database connected filled combo box with static choice in a new line with its describing label.
protected DataComboBox	createComboBox(java.lang.String columnName, DataObject sourceDataObject, java.lang.String visibleColumn) Creates a database connected and dynamically data filled combo box in the same line as previously used.
protected DataComboBox	createComboBox(java.lang.String columnName, DataObject sourceDataObject, java.lang.String visibleColumn, java.lang.String orderByColumnName, java.lang.String nameForNoChoice) Creates a database connected and dynamically data filled combo box in the same line as previously used.
protected DataComboBox	createComboBox(java.lang.String label, java.lang.String columnName, DataObject sourceDataObject, java.lang.String visibleColumn) Creates a database connected and dynamically data filled combo box in a new line with its describing label.
protected DataComboBox	createComboBox(java.lang.String label, java.lang.String columnName, DataObject sourceDataObject, java.lang.String visibleColumn, java.lang.String orderByColumnName, java.lang.String nameForNoChoice) Creates a database connected and dynamically data filled combo box in a new line with its describing label.
protected DataDateField	createDateField(java.lang.String columnName) Creates a database connected date field in the same line as previously used.
protected DataDateField	createDateField(java.lang.String label, java.lang.String columnName) Creates a database connected date field in a new line with its describing label.
protected DataDecimalField	createDecimalField(java.lang.String columnName) Creates a database connected decimal field in the same line as previously used.
protected DataDecimalField	createDecimalField(java.lang.String label, java.lang.String columnName) Creates a database connected decimal field in a new line with the specified label.
DataFileUploader	createFileUploader(java.lang.String lineLabel, java.lang.String saveDirectory) Creates a database connected file uploader.
protected DataIntField	createIntField(java.lang.String columnName) Creates a database connected int field in the same line as previously used.
protected DataIntField	createIntField(java.lang.String label, java.lang.String columnName) Creates a database connected int field in a new line with its describing label.
protected DataPasswordField	createPasswordField(java.lang.String columnName) Creates a database connected password input field in the same line as previously used.
protected DataPasswordField	createPasswordField(java.lang.String label, java.lang.String columnName) Creates a database connected password input field in a new line with its describing label.
protected DataTextArea	createTextArea(java.lang.String label, java.lang.String columnName) Creates a database connected text area in a new line with its describing label.
protected DataTextCheck	createTextCheck(java.lang.String lineLabel, java.lang.String columnName, int[] keys, java.lang.String[] meaning) Creates a database connected radio button group in a new line.
protected DataTextCheck	createTextCheck(java.lang.String lineLabel, java.lang.String columnName, java.lang.String[] keys, java.lang.String[] meaning) Creates a database connected radio button group in a new line.
protected DataTextField	createTextField(java.lang.String columnName) Creates a database connected text input field in the same line as previously used.
protected DataTextField	createTextField(java.lang.String label, java.lang.String columnName) Creates a database connected text input field in a new line with its describing label.
protected DataTimeField	createTimeField(java.lang.String columnName) Creates a database connected time field in the same line as previously used.
protected DataTimeField	createTimeField(java.lang.String label, java.lang.String columnName) Creates a database connected time field in a new line with its describing label.
protected void	free() Frees (releases) references caused by this frame, particularly static register entries.
protected int	getAdministrationMode() Returns the administration mode.
java.lang.String	getEntryDescription() Returns the description of the administered entry.
protected Identifier	getLastAdministrationIdentifier()
Submission	getSubmission() Returns the submission details for the next invokable in stack.
java.lang.String	getTagSequence() Returns the default tag sequence to represent the component in markup languages.
java.lang.String	getTitle() Returns the title of the property administration
void	handleSaveRequest() Stores the administered entity if accepted and necessary.
boolean	hasUploadFunctionality() Returns the uploadFunctionality.
void	init() Initializes the invokable in order to reuse the component without garbage from the previous use.
boolean	isCancelable() Indicates whether the invokable accepts to be canceled.
protected boolean	isInputAccepted() Returns true if user input is accepted.
protected boolean	isModified() Returns true if input was modified.
void	loadValues(Identifier identifier) Loads an entity specified by an identifier (primary key).
void	loadValues(int identifyValue) Loads an entity specified by a primary key integer value.
void	newInput() Prepares for inserting data.
void	process(GeneralizedRequest request) Allows the invokable to react to the request.
protected void	saveValues() Saves the components' values.
protected void	setFrameTitleNew(java.lang.String frameTitleNew) Sets the title of the "frame" for insert usage.
protected void	setFrameUpdateTitleField(DataTextField newFrameUpdateTitleField) Sets the title of the "frame" for update usage.
protected void	setFrameUpdateTitleField(DataTextField[] newFrameUpdateTitleFields) Sets the title of the "frame" for update usage.
void	setMainDataObject(DataObject dataObject) Sets the main data object and calls new row to get column length via meta data.
protected void	setRequired(boolean required) Sets the previously added component to be mandatory.
void	setSubmitter(Invokable submitter) Sets the submitter of this dialog step.
void	setTitle(java.lang.String title) Sets the title of the property administration
boolean	wantToBeFinalized() Returns true if the invokable wants to be finalized after request is worked off.

Methods inherited from class de.must.markup.PropertyAdministration

creationEnding, fetchValuesFromRequest, getAttributeList, getTabbedPaneTagSequence, hasMultiplePanels, newPanel, newPanel, newPanel, newPanel, setTabSize, setToolTipText

Methods inherited from class de.must.markup.Dialog

afterOutput, appendAdditionalButton, beforeOutput, destroy, finalize, getAdditionalButtons, getBackButtonTagSequence, getCancelButtonTagSequence, getFooter, getHeader, getHelpContext, getInvokableInAdvance, getOkButtonTagSequence, getScriptToExecute, getScriptToExecuteSequence, getStackMovement, getSubTitle, isPost, isSuitableDialog, setHelpContext, setHelpContext, setMessageToKeep, setMessageToKeepIfNotAlreadySet, setScriptToExecute, setStackMovement, setSubTitle

Methods inherited from class java.lang.Object

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

Field Detail

MODE_VIRGIN

public static final int MODE_VIRGIN

See Also:

Constant Field Values

MODE_NEW

public static final int MODE_NEW

See Also:

Constant Field Values

MODE_PROPERTY

public static final int MODE_PROPERTY

See Also:

Constant Field Values

MODE_COPY

public static final int MODE_COPY

See Also:

Constant Field Values

Constructor Detail

DataPropertyAdministration

public DataPropertyAdministration(SessionData sessionData)

Constructs a new data property administration.

Parameters:

sessionData - the session's public data

DataPropertyAdministration

public DataPropertyAdministration(DataObject mainDataObject,
                                  SessionData sessionData)

Constructs a new data property administration.

Parameters:

mainDataObject - the data object that is to be used mainly

sessionData - the session's public data

Method Detail

setMainDataObject

public void setMainDataObject(DataObject dataObject)

Sets the main data object and calls new row to get column length via meta data.

Parameters:

dataObject - the data object that is to be used mainly

setTitle

public void setTitle(java.lang.String title)

Sets the title of the property administration

Overrides:

setTitle in class Dialog

Parameters:

title - the title of the property administration

getTitle

public java.lang.String getTitle()

Returns the title of the property administration

Overrides:

getTitle in class Dialog

Returns:

the title of the property administration

setSubmitter

public void setSubmitter(Invokable submitter)

Sets the submitter of this dialog step.

Parameters:

submitter - the calling submitter

createTextField

protected DataTextField createTextField(java.lang.String columnName)

Creates a database connected text input field in the same line as previously used.

Parameters:

columnName - the name of the field which has to be the column name of the database table.

Returns:

the created database connected text input field

createTextField

protected DataTextField createTextField(java.lang.String label,
                                        java.lang.String columnName)

Creates a database connected text input field in a new line with its describing label.

Parameters:

label - the line label.

columnName - the name of the field which has to be the column name of the database table.

Returns:

the created database connected text input field

createPasswordField

protected DataPasswordField createPasswordField(java.lang.String columnName)

Creates a database connected password input field in the same line as previously used.

Parameters:

columnName - the name of the field = the column name of the database table

Returns:

the created database connected password input field

createPasswordField

protected DataPasswordField createPasswordField(java.lang.String label,
                                                java.lang.String columnName)

Creates a database connected password input field in a new line with its describing label.

Parameters:

columnName - the name of the field = the column name of the database table

Returns:

the created database connected password input field

createTextArea

protected DataTextArea createTextArea(java.lang.String label,
                                      java.lang.String columnName)

Creates a database connected text area in a new line with its describing label.

Parameters:

label - the line label.

columnName - the name of the field = the column name of the database table

Returns:

the created database connected text area

createDateField

protected DataDateField createDateField(java.lang.String columnName)

Creates a database connected date field in the same line as previously used.

Parameters:

columnName - the name of the field which has to be the column name of the database table.

Returns:

the created database connected date field

createDateField

protected DataDateField createDateField(java.lang.String label,
                                        java.lang.String columnName)

Creates a database connected date field in a new line with its describing label.

Parameters:

label - the line label.

columnName - the name of the field which has to be the column name of the database table.

Returns:

the created database connected date field

createTimeField

protected DataTimeField createTimeField(java.lang.String columnName)

Creates a database connected time field in the same line as previously used.

Parameters:

columnName - the name of the field which has to be the column name of the database table.

Returns:

the created database connected time field

createTimeField

protected DataTimeField createTimeField(java.lang.String label,
                                        java.lang.String columnName)

Creates a database connected time field in a new line with its describing label.

Parameters:

label - the line label.

columnName - the name of the field which has to be the column name of the database table.

Returns:

the created database connected time field

createIntField

protected DataIntField createIntField(java.lang.String columnName)

Creates a database connected int field in the same line as previously used.

Parameters:

columnName - the name of the field which has to be the column name of the database table.

Returns:

the created database connected int field

createIntField

protected DataIntField createIntField(java.lang.String label,
                                      java.lang.String columnName)

Creates a database connected int field in a new line with its describing label.

Parameters:

label - the line label.

columnName - the name of the field which has to be the column name of the database table.

Returns:

the created database connected int field

createDecimalField

protected DataDecimalField createDecimalField(java.lang.String label,
                                              java.lang.String columnName)

Creates a database connected decimal field in a new line with the specified label.

Parameters:

label - the label of the new line

columnName - the name of the column to connect to

Returns:

the created database connected decimal field

createDecimalField

protected DataDecimalField createDecimalField(java.lang.String columnName)

Creates a database connected decimal field in the same line as previously used.

Parameters:

columnName - the name of the column to connect to

Returns:

the created database connected decimal field

createComboBox

protected DataComboBox createComboBox(java.lang.String columnName,
                                      DataObject sourceDataObject,
                                      java.lang.String visibleColumn)

Creates a database connected and dynamically data filled combo box in the same line as previously used.

Parameters:

columnName - the name of the field = the column name of the database table

sourceDataObject - the source data object that shall fill the content of the combo box

visibleColumn - the column to be used to fill the combo box from the source data object

Returns:

the created database connected combo box

createComboBox

protected DataComboBox createComboBox(java.lang.String label,
                                      java.lang.String columnName,
                                      DataObject sourceDataObject,
                                      java.lang.String visibleColumn)

Creates a database connected and dynamically data filled combo box in a new line with its describing label.

Parameters:

label - the line label.

columnName - the name of the field = the column name of the database table

sourceDataObject - the source data object that shall fill the content of the combo box

visibleColumn - the column to be used to fill the combo box from the source data object

Returns:

the created database connected combo box

createComboBox

protected DataComboBox createComboBox(java.lang.String label,
                                      java.lang.String columnName,
                                      DataObject sourceDataObject,
                                      java.lang.String visibleColumn,
                                      java.lang.String orderByColumnName,
                                      java.lang.String nameForNoChoice)

Creates a database connected and dynamically data filled combo box in a new line with its describing label.

Parameters:

label - the line label.

columnName - the name of the field = the column name of the database table

sourceDataObject - the source data object that shall fill the content of the combo box

visibleColumn - the column to be used to fill the combo box from the source data object

orderByColumnName - the column name to determine for the list order

nameForNoChoice - the expression that indicates "no choice"

Returns:

the created database connected combo box

createComboBox

protected DataComboBox createComboBox(java.lang.String columnName,
                                      DataObject sourceDataObject,
                                      java.lang.String visibleColumn,
                                      java.lang.String orderByColumnName,
                                      java.lang.String nameForNoChoice)

Creates a database connected and dynamically data filled combo box in the same line as previously used.

Parameters:

columnName - the name of the field = the column name of the database table

sourceDataObject - the source data object that shall fill the content of the combo box

visibleColumn - the column to be used to fill the combo box from the source data object

orderByColumnName - the column name to determine for the list order

nameForNoChoice - the expression that indicates "no choice"

Returns:

the created database connected combo box

createChoice

protected DataVariableChoice createChoice(java.lang.String label,
                                          java.lang.String[][] content,
                                          java.lang.String columnName)

Creates a database connected filled combo box with static choice in a new line with its describing label.

Parameters:

label - the line label.

content - the wished content of the combo box

columnName - the name of the field = the column name of the database table

Returns:

the created database connected variable choice field

createCheckBox

protected DataCheckBox createCheckBox(java.lang.String checkLabel,
                                      java.lang.String columnName)

Creates a database connected check box in the same line as previously used.

Parameters:

checkLabel - the label to the right of the check box

columnName - the name of the field = the column name of the database table

Returns:

the created database connected check box

createCheckBox

protected DataCheckBox createCheckBox(java.lang.String lineLabel,
                                      java.lang.String checkLabel,
                                      java.lang.String columnName)

Creates a database connected check box in a new line with its describing label.

Parameters:

label - the line label.

checkLabel -

columnName - the name of the field = the column name of the database table

Returns:

the created database connected check box

createCheckBox

protected DataCheckBox createCheckBox(java.lang.String lineLabel,
                                      java.lang.String checkLabel,
                                      java.lang.String columnName,
                                      java.lang.String trueString,
                                      java.lang.String falseString)

createTextCheck

protected DataTextCheck createTextCheck(java.lang.String lineLabel,
                                        java.lang.String columnName,
                                        java.lang.String[] keys,
                                        java.lang.String[] meaning)

Creates a database connected radio button group in a new line.

Parameters:

label - the label of the new line

columnName - the name of the column to connect to

keys - the keys as to be used in the database tables

meaning - the meanings of these keys to be presented for the user

Returns:

the created database connected

createTextCheck

protected DataTextCheck createTextCheck(java.lang.String lineLabel,
                                        java.lang.String columnName,
                                        int[] keys,
                                        java.lang.String[] meaning)

Creates a database connected radio button group in a new line.

Parameters:

label - the label of the new line

columnName - the name of the column to connect to

keys - the keys as to be used in the database tables

meaning - the meanings of these keys to be presented for the user

Returns:

the created database connected

createFileUploader

public DataFileUploader createFileUploader(java.lang.String lineLabel,
                                           java.lang.String saveDirectory)

Creates a database connected file uploader.

Parameters:

label - the label of the new line

saveDirectory - the directory to save the files to

Returns:

the created database connected file uploader

append

protected void append(java.lang.String stringToAppend)

Appends a string to the same line as previously used.

Parameters:

stringToAppend - the string to add

setRequired

protected void setRequired(boolean required)

Sets the previously added component to be mandatory.

Parameters:

required - whether the component is mandatory or not

init

public void init()

Initializes the invokable in order to reuse the component without garbage from the previous use.

Specified by:

init in interface Invokable

Overrides:

init in class Dialog

setFrameTitleNew

protected void setFrameTitleNew(java.lang.String frameTitleNew)

Sets the title of the "frame" for insert usage.

Parameters:

frameTitleNew - the title for insert usage

setFrameUpdateTitleField

protected void setFrameUpdateTitleField(DataTextField newFrameUpdateTitleField)

Sets the title of the "frame" for update usage.

Parameters:

newFrameUpdateTitleField - the field to determine the for update title

setFrameUpdateTitleField

protected void setFrameUpdateTitleField(DataTextField[] newFrameUpdateTitleFields)

Sets the title of the "frame" for update usage.

Parameters:

newFrameUpdateTitleFields - the fields to determine the for update title

getTagSequence

public java.lang.String getTagSequence()

Returns the default tag sequence to represent the component in markup languages.

Returns:

the default tag sequence to represent the component in markup languages

getEntryDescription

public java.lang.String getEntryDescription()

Returns the description of the administered entry.

Returns:

the description of the administered entry

isCancelable

public boolean isCancelable()

Indicates whether the invokable accepts to be canceled.

Specified by:

isCancelable in interface Invokable

Overrides:

isCancelable in class Dialog

Returns:

true if the invokable accepts to be canceled

process

public void process(GeneralizedRequest request)

Allows the invokable to react to the request.

Specified by:

process in interface Invokable

Overrides:

process in class PropertyAdministration

Parameters:

the - request to react to

newInput

public void newInput()

Prepares for inserting data.

loadValues

public void loadValues(int identifyValue)

Loads an entity specified by a primary key integer value.

Parameters:

identifyValue - the primary key integer value.

loadValues

public void loadValues(Identifier identifier)

Loads an entity specified by an identifier (primary key).

Parameters:

identifier - the identifier (primary key).

handleSaveRequest

public void handleSaveRequest()

Stores the administered entity if accepted and necessary.

isInputAccepted

protected boolean isInputAccepted()

Returns true if user input is accepted. Override this method to implement individual input checks.

Returns:

true if user input is accepted

getAdministrationMode

protected int getAdministrationMode()

Returns the administration mode.

Returns:

the administration mode which may be MODE_VIRGIN, MODE_NEW, MODE_PROPERTY or MODE_COPY

isModified

protected boolean isModified()

Returns true if input was modified.

Returns:

true if input was modified.

saveValues

protected void saveValues()

Saves the components' values.

getLastAdministrationIdentifier

protected Identifier getLastAdministrationIdentifier()

hasUploadFunctionality

public boolean hasUploadFunctionality()

Returns the uploadFunctionality.

Returns:

boolean

getSubmission

public Submission getSubmission()

Returns the submission details for the next invokable in stack.

Returns:

the submission details

free

protected void free()

Description copied from class: Dialog

Frees (releases) references caused by this frame, particularly static register entries. To be called via destroy() to prevent multiple call. Override it to do additional releases and don't forget to call super.free() at the end.

Overrides:

free in class Dialog

See Also:

Dialog.destroy()

wantToBeFinalized

public boolean wantToBeFinalized()

Returns true if the invokable wants to be finalized after request is worked off.

Specified by:

wantToBeFinalized in interface Invokable

Overrides:

wantToBeFinalized in class PropertyAdministration

Returns:

true if the invokable wants to be finalized