de.enflexit.common.ontology.gui

Class DynFormBase

java.lang.Object

de.enflexit.common.ontology.gui.DynFormBase

Direct Known Subclasses:

DynForm

public abstract class DynFormBase
extends java.lang.Object

This class can be used in order to generate a Swing based user form, that represents the structure of one or more ontology-classes. Especially this abstract class is used in order reduce the lines of code in one class. The basically used class is the class DynForm.

See Also:

DynForm

Field Summary

Fields

Modifier and Type	Field and Description
protected AgentStartConfiguration	agentStartConfiguration Constructor parameter
protected java.util.Vector<AgentStartArgument>	currOntologyClassReferenceList Based on this vector the user interface will be created
protected boolean	debug For debugging purposes
protected KeyAdapter4Numbers	numWatcherFloat The KeyAdapter for float values
protected KeyAdapter4Numbers	numWatcherInteger The KeyAdapter for Integer values
protected javax.swing.tree.DefaultTreeModel	objectTree The TreeModel for the class hierarchy of the current ontology configuration
protected java.lang.Object[]	ontoArgsInstance The instances that are to be created by the DynForm
protected java.lang.String[]	ontoArgsXML The XML strings that are to be created by the DynForm
protected OntologyVisualizationHelper	ontologyVisualisationHelper Necessary parameter that comes from the constructor

Constructor Summary

Constructors

Constructor and Description
DynFormBase()

Method Summary

Modifier and Type	Method and Description
protected abstract javax.swing.tree.DefaultMutableTreeNode	addSingleMultipleNode(javax.swing.tree.DefaultMutableTreeNode currNode, boolean isInnerClass) This method has to create a copy of the passed JPanel and adds it.
protected java.lang.Object	getInstanceOfXML(java.lang.String xmlString, java.lang.String className, jade.content.onto.Ontology ontology) This method translates an XML String to an object instance by the given instance of the current ontology.
protected java.lang.Object[]	getInstancesFromXML(java.lang.String[] ontoArgsXML) This method reads the given XML configuration of the arguments, fills the form and creates the instances.
protected javax.swing.tree.DefaultTreeModel	getObjectTree() Returns the object tree with all elements to display.
java.util.Vector<AgentStartArgument>	getOntologyClassReferenceList() Gets the ontology class reference list.
OntologyClassWidget	getOntologyClassWidget(javax.swing.tree.DefaultMutableTreeNode node) Returns the form component for a OntologyClassVisualisation.
java.util.HashMap<javax.swing.tree.DefaultMutableTreeNode,OntologyClassWidget>	getOntologyClassWidgets() Returns the OntologyClassWidget's for all current OntologyClassVisualisation's.
protected javax.swing.tree.DefaultMutableTreeNode	getRootNode() Returns the root node of the object tree.
javax.swing.tree.DefaultMutableTreeNode	getTreeNodeByDynType(DynType dynType) Returns a tree node, specified by the user object (DynType).
java.util.HashMap<DynType,javax.swing.tree.DefaultMutableTreeNode>	getTreeNodesByDynType() Returns the HshMap of tree nodes by DynType.
javax.swing.JComponent	getVisualComponent(java.lang.String valueType) This method creates the JComponent, which will be displayed for an ontology slot.
boolean	isEmptyForm() Indicates if the created form is empty.
protected boolean	isRawType(java.lang.String valueType) This method checks if the type of the field is a raw type (String, int, float, ...)
protected abstract void	removeMultiple(javax.swing.tree.DefaultMutableTreeNode delNode) This method has to remove the JPanel passed with the given tree node.
protected void	resetValuesOnForm() Resets the form values.
void	save(boolean fromForm) This method can be invoked to generate the instance of the current configuration.
protected void	setFormState(java.lang.Object object, javax.swing.tree.DefaultMutableTreeNode node) This method sets the object state to the form.
protected void	setInstancesFromForm() This methods reads the current form configuration and creates the instances and the XML form of that configuration.
protected void	setInstancesFromXML() This method reads the current XML configuration of the arguments, fills the form and creates the instances.
protected void	setIsEmptyForm(boolean isEmptyForm) Sets the indicator if the DynForm is empty.
protected void	setXMLFromInstances() This method creates the XML form from the instances.
protected void	showObjectTree() Shows the object tree in a visual way in a JDialog, if the internal debug value is set to be true.

Methods inherited from class java.lang.Object

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

Field Detail

ontologyVisualisationHelper

protected OntologyVisualizationHelper ontologyVisualisationHelper

Necessary parameter that comes from the constructor

agentStartConfiguration

protected AgentStartConfiguration agentStartConfiguration

Constructor parameter

currOntologyClassReferenceList

protected java.util.Vector<AgentStartArgument> currOntologyClassReferenceList

Based on this vector the user interface will be created

debug

protected boolean debug

For debugging purposes

numWatcherFloat

protected KeyAdapter4Numbers numWatcherFloat

The KeyAdapter for float values

numWatcherInteger

protected KeyAdapter4Numbers numWatcherInteger

The KeyAdapter for Integer values

objectTree

protected javax.swing.tree.DefaultTreeModel objectTree

The TreeModel for the class hierarchy of the current ontology configuration

ontoArgsInstance

protected java.lang.Object[] ontoArgsInstance

The instances that are to be created by the DynForm

ontoArgsXML

protected java.lang.String[] ontoArgsXML

The XML strings that are to be created by the DynForm

Constructor Detail

DynFormBase

public DynFormBase()

Method Detail

getOntologyClassReferenceList

public java.util.Vector<AgentStartArgument> getOntologyClassReferenceList()

Gets the ontology class reference list.

Returns:

the ontology class reference list

getObjectTree

protected javax.swing.tree.DefaultTreeModel getObjectTree()

Returns the object tree with all elements to display.

Returns:

the object tree

getRootNode

protected javax.swing.tree.DefaultMutableTreeNode getRootNode()

Returns the root node of the object tree.

Returns:

the root node

See Also:

getObjectTree()

showObjectTree

protected void showObjectTree()

Shows the object tree in a visual way in a JDialog, if the internal debug value is set to be true.

getOntologyClassWidgets

public java.util.HashMap<javax.swing.tree.DefaultMutableTreeNode,OntologyClassWidget> getOntologyClassWidgets()

Returns the OntologyClassWidget's for all current OntologyClassVisualisation's.

Returns:

the HashMap

getOntologyClassWidget

public OntologyClassWidget getOntologyClassWidget(javax.swing.tree.DefaultMutableTreeNode node)

Returns the form component for a OntologyClassVisualisation.

Parameters:

node - the current node

Returns:

the corresponding OntologyClassWidget

getTreeNodesByDynType

public java.util.HashMap<DynType,javax.swing.tree.DefaultMutableTreeNode> getTreeNodesByDynType()

Returns the HshMap of tree nodes by DynType.

Returns:

the HshMap of tree nodes by DynType

getTreeNodeByDynType

public javax.swing.tree.DefaultMutableTreeNode getTreeNodeByDynType(DynType dynType)

Returns a tree node, specified by the user object (DynType).

Parameters:

dynType - the DynType

Returns:

the object tree node

isEmptyForm

public boolean isEmptyForm()

Indicates if the created form is empty.

Returns:

the emptyForm

setIsEmptyForm

protected void setIsEmptyForm(boolean isEmptyForm)

Sets the indicator if the DynForm is empty.

Parameters:

isEmptyForm - the indicator if the DynForm is empty or not

isRawType

protected boolean isRawType(java.lang.String valueType)

This method checks if the type of the field is a raw type (String, int, float, ...)

Parameters:

valueType - the value type

Returns:

true, if is special type

getVisualComponent

public javax.swing.JComponent getVisualComponent(java.lang.String valueType)

This method creates the JComponent, which will be displayed for an ontology slot.

Parameters:

valueType - the value type

Returns:

the visual component

save

public void save(boolean fromForm)

This method can be invoked to generate the instance of the current configuration.

Parameters:

fromForm - the from form

setXMLFromInstances

protected void setXMLFromInstances()

This method creates the XML form from the instances.

setInstancesFromXML

protected void setInstancesFromXML()

This method reads the current XML configuration of the arguments, fills the form and creates the instances.

getInstancesFromXML

protected java.lang.Object[] getInstancesFromXML(java.lang.String[] ontoArgsXML)

This method reads the given XML configuration of the arguments, fills the form and creates the instances.

Parameters:

ontoArgsXML - the ontology arguments as String array containing XML

Returns:

the concrete instances from the XML argument description

getInstanceOfXML

protected java.lang.Object getInstanceOfXML(java.lang.String xmlString,
                                            java.lang.String className,
                                            jade.content.onto.Ontology ontology)

This method translates an XML String to an object instance by the given instance of the current ontology. The translated object must be a part of this ontology.

Parameters:

xmlString - the xml string

ontology - the ontology

Returns:

the instance of xml

setInstancesFromForm

protected void setInstancesFromForm()

This methods reads the current form configuration and creates the instances and the XML form of that configuration.

setFormState

protected void setFormState(java.lang.Object object,
                            javax.swing.tree.DefaultMutableTreeNode node)

This method sets the object state to the form.

Parameters:

object - the object

node - the node

removeMultiple

protected abstract void removeMultiple(javax.swing.tree.DefaultMutableTreeNode delNode)

This method has to remove the JPanel passed with the given tree node.

Parameters:

delNode - the node

addSingleMultipleNode

protected abstract javax.swing.tree.DefaultMutableTreeNode addSingleMultipleNode(javax.swing.tree.DefaultMutableTreeNode currNode,
                                                                                 boolean isInnerClass)

This method has to create a copy of the passed JPanel and adds it.

Parameters:

currNode - the current node

isInnerClass - the is inner class

Returns:

the default mutable tree node

resetValuesOnForm

protected void resetValuesOnForm()

Resets the form values.