weka.gui.beans.xml

Class XMLBeans

java.lang.Object

weka.core.xml.XMLSerialization

weka.core.xml.XMLBasicSerialization

weka.gui.beans.xml.XMLBeans

All Implemented Interfaces:

RevisionHandler

public class XMLBeans
extends XMLBasicSerialization

This class serializes and deserializes a KnowledgeFlow setup to and fro XML.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DATATYPE_LAYOUT the data that is about to be read/written contains a complete layout
static int	DATATYPE_USERCOMPONENTS the data that is about to be read/written contains user-components, i.e., Metabeans
static int	INDEX_BEANCONNECTIONS the index in the Vector, where the BeanConnections are stored (Instances and Connections are stored in a Vector and then serialized)
static int	INDEX_BEANINSTANCES the index in the Vector, where the BeanInstances are stored (Instances and Connections are stored in a Vector and then serialized)
protected java.util.Hashtable<java.lang.Object,java.util.Vector<java.lang.String>>	m_BeanConnectionRelation the relation between Bean and connection, MetaBean BeanConnections are stored under the reference of the MetaBean, regular connections are stored under REGULAR_CONNECTION.
protected java.beans.beancontext.BeanContextSupport	m_BeanContextSupport the beancontext to use for loading from XML and the beancontext is null in the bean
protected java.util.Vector<java.lang.Object>	m_BeanInstances keeps track of the BeanInstances read so far, used for the BeanConnections
protected java.util.Vector<java.lang.Integer>	m_BeanInstancesID keeps track of the BeanInstances read so far, used for the BeanConnections
protected javax.swing.JComponent	m_BeanLayout the component that manages the layout of the beans
protected MetaBean	m_CurrentMetaBean the current MetaBean (for the BeanConnections)
protected int	m_DataType the type of data that is be read/written
protected boolean	m_IgnoreBeanConnections whether to ignore the BeanConnection
protected int	m_vectorIndex The index of the vector of bean instances or connections to use. this corresponds to a tab in the main KnowledgeFlow UI
protected static java.lang.String	REGULAR_CONNECTION the identifier for regular BeanConnections
static java.lang.String	VAL_ANIMATEDICONPATH the value of the animatedIconPath property
static java.lang.String	VAL_ASSOCIATEDCONNECTIONS the value of the associatedConnections property
static java.lang.String	VAL_BEAN the value of the bean property
static java.lang.String	VAL_BEANCONTEXT the value of the beanContext property
static java.lang.String	VAL_BLUE the value of the blue property
static java.lang.String	VAL_COLOR the value of the color property
static java.lang.String	VAL_CUSTOM_NAME the value of the customName property
static java.lang.String	VAL_DIR the value of the dir property
static java.lang.String	VAL_EVENTNAME the value of the eventname property
static java.lang.String	VAL_FILE the value of the file property
static java.lang.String	VAL_FONT the value of the font property
static java.lang.String	VAL_GREEN the value of the green property
static java.lang.String	VAL_HEIGHT the value of the height property
static java.lang.String	VAL_HIDDEN the value of the hidden property
static java.lang.String	VAL_ICONPATH the value of the iconpath property
static java.lang.String	VAL_ID the value of the id property
static java.lang.String	VAL_INPUTS the value of the input property
static java.lang.String	VAL_INPUTSID the value of the input id property
static java.lang.String	VAL_LOADER the value of the loader property
static java.lang.String	VAL_LOCATION the value of the location property
static java.lang.String	VAL_NAME the value of the value property
static java.lang.String	VAL_OPTIONS the value of the options property
static java.lang.String	VAL_ORIGINALCOORDS the value of the originalCoords property
static java.lang.String	VAL_OUTPUTS the value of the outputs id property
static java.lang.String	VAL_OUTPUTSID the value of the outputs property
static java.lang.String	VAL_PREFIX the value of the prefix property
static java.lang.String	VAL_RED the value of the red property
static java.lang.String	VAL_RELATIONNAMEFORFILENAME the value of the relationNameForFilename property (Saver)
static java.lang.String	VAL_RELATIVE_PATH
static java.lang.String	VAL_SAVER the value of the saver property
static java.lang.String	VAL_SIZE the value of the size property
static java.lang.String	VAL_SOURCEID the value of the source property
static java.lang.String	VAL_STYLE the value of the style property
static java.lang.String	VAL_SUBFLOW the value of the subFlow property
static java.lang.String	VAL_TARGETID the value of the target property
static java.lang.String	VAL_TEXT the value of the text property
static java.lang.String	VAL_WIDTH the value of the width property
static java.lang.String	VAL_X the value of the x property
static java.lang.String	VAL_Y the value of the y property

Fields inherited from class weka.core.xml.XMLBasicSerialization

VAL_CELLS, VAL_KEY, VAL_MAPPING, VAL_VALUE

Fields inherited from class weka.core.xml.XMLSerialization

ATT_ARRAY, ATT_ARRAY_DEFAULT, ATT_CLASS, ATT_NAME, ATT_NULL, ATT_NULL_DEFAULT, ATT_PRIMITIVE, ATT_PRIMITIVE_DEFAULT, ATT_VERSION, DEBUG, DOCTYPE, m_ClassnameOverride, m_CurrentNode, m_CustomMethods, m_Document, m_Properties, m_suppressWarnings, ROOT_NODE, SUPPRESS_PROPERTY_WARNINGS, TAG_OBJECT, VAL_NO, VAL_ROOT, VAL_YES

Constructor Summary

Constructors

Constructor and Description
XMLBeans(javax.swing.JComponent layout, java.beans.beancontext.BeanContextSupport context, int tab) initializes the serialization for layouts
XMLBeans(javax.swing.JComponent layout, java.beans.beancontext.BeanContextSupport context, int datatype, int tab) initializes the serialization for different types of data

Method Summary

Modifier and Type	Method and Description
protected void	addBeanConnectionRelation(MetaBean meta, java.lang.String connection) adds the given connection-relation for the specified MetaBean (or null in case of regular connections)
protected void	addBeanInstances(java.util.Vector<java.lang.Object> list) traverses over all BeanInstances (or MetaBeans) and stores them in a vector (recurses into MetaBeans, since the sub-BeanInstances are not visible)
void	clear() generates internally a new XML document and clears also the IgnoreList and the mappings for the Read/Write-Methods
protected BeanConnection	createBeanConnection(int sourcePos, int targetPos, java.lang.String event, boolean hidden) generates a connection based on the given parameters
protected java.util.Vector<java.lang.String>	getBeanConnectionRelation(MetaBean meta) returns the relation for the given MetaBean, for the regular connections, null has to be used
protected java.util.Vector<java.lang.Object>	getBeanInstancesForIDs(java.util.Vector<java.lang.Integer> ids) returns a vector with references to BeanInstances according to the IDs in the given Vector.
int	getDataType() returns the type of data that is to be read/written
protected java.util.Vector<java.lang.Integer>	getIDsForBeanInstances(java.util.Vector<java.lang.Object> beans) returns the IDs for the given BeanInstances, i.e., the stored IDs in m_BeanInstancesID, based on m_BeanInstances
java.lang.Object	readBeanConnection(org.w3c.dom.Element node) builds the BeanConnection from the given DOM node.
java.lang.Object	readBeanInstance(org.w3c.dom.Element node) builds the BeanInstance from the given DOM node.
java.lang.Object	readBeanVisual(org.w3c.dom.Element node) builds the BeanVisual from the given DOM node.
java.lang.Object	readColor(org.w3c.dom.Element node) builds the Color from the given DOM node.
java.lang.Object	readColorUIResource(org.w3c.dom.Element node) builds the ColorUIResource from the given DOM node.
java.lang.Object	readDimension(org.w3c.dom.Element node) builds the Dimension from the given DOM node.
java.lang.Object	readFont(org.w3c.dom.Element node) builds the Font from the given DOM node.
java.lang.Object	readFontUIResource(org.w3c.dom.Element node) builds the FontUIResource from the given DOM node.
java.lang.Object	readLoader(org.w3c.dom.Element node) builds the Loader from the given DOM node.
java.lang.Object	readMetaBean(org.w3c.dom.Element node) builds the MetaBean from the given DOM node.
java.lang.Object	readPoint(org.w3c.dom.Element node) builds the Point from the given DOM node.
protected java.lang.Object	readPostProcess(java.lang.Object o) additional post-processing can happen in derived classes after reading from XML. re-builds the BeanConnections.
protected org.w3c.dom.Document	readPreProcess(org.w3c.dom.Document document) additional pre-processing can happen in derived classes before the actual reading from XML (working on the raw XML). right now it does nothing with the document, only empties the help-vector for the BeanInstances and reads the IDs for the BeanInstances, s.t. the correct references can be set again
java.lang.Object	readSaver(org.w3c.dom.Element node) builds the Saver from the given DOM node.
protected void	rebuildBeanConnections(java.util.Vector<java.util.Vector<?>> deserialized, java.lang.Object key) rebuilds all the connections for a certain key in the hashtable. for the ones being part of a MetaBean, no new instance is built, but only the reference to the actual BeanConnection set.
protected void	removeUserToolBarBeans(java.util.Vector<?> metabeans) removes the given meta beans from the layout, since they're only listed in the user toolbar
protected void	setBeanConnection(BeanConnection conn, java.util.Vector<BeanConnection> list) puts the given BeanConnection onto the next null in the given Vector, or at the end of the list, if no null is found.
void	setDataType(int value) sets what kind of data is to be read/written
org.w3c.dom.Element	writeBeanConnection(org.w3c.dom.Element parent, java.lang.Object o, java.lang.String name) adds the given BeanConncetion to a DOM structure.
org.w3c.dom.Element	writeBeanInstance(org.w3c.dom.Element parent, java.lang.Object o, java.lang.String name) adds the given BeanInstance to a DOM structure.
org.w3c.dom.Element	writeBeanLoader(org.w3c.dom.Element parent, java.lang.Object o, java.lang.String name) adds the given Loader (a bean) to a DOM structure.
org.w3c.dom.Element	writeBeanSaver(org.w3c.dom.Element parent, java.lang.Object o, java.lang.String name) adds the given Saver (a bean) to a DOM structure.
org.w3c.dom.Element	writeBeanVisual(org.w3c.dom.Element parent, java.lang.Object o, java.lang.String name) adds the given BeanVisual to a DOM structure.
org.w3c.dom.Element	writeColor(org.w3c.dom.Element parent, java.lang.Object o, java.lang.String name) adds the given Color to a DOM structure.
org.w3c.dom.Element	writeColorUIResource(org.w3c.dom.Element parent, java.lang.Object o, java.lang.String name) adds the given ColorUIResource to a DOM structure.
org.w3c.dom.Element	writeDimension(org.w3c.dom.Element parent, java.lang.Object o, java.lang.String name) adds the given Dimension to a DOM structure.
org.w3c.dom.Element	writeFont(org.w3c.dom.Element parent, java.lang.Object o, java.lang.String name) adds the given Font to a DOM structure.
org.w3c.dom.Element	writeFontUIResource(org.w3c.dom.Element parent, java.lang.Object o, java.lang.String name) adds the given FontUIResource to a DOM structure.
org.w3c.dom.Element	writeLoader(org.w3c.dom.Element parent, java.lang.Object o, java.lang.String name) adds the given Loader to a DOM structure.
org.w3c.dom.Element	writeMetaBean(org.w3c.dom.Element parent, java.lang.Object o, java.lang.String name) adds the given MetaBean to a DOM structure.
org.w3c.dom.Element	writePoint(org.w3c.dom.Element parent, java.lang.Object o, java.lang.String name) adds the given Point to a DOM structure.
protected void	writePostProcess(java.lang.Object o) enables derived classes to add other properties to the DOM tree, e.g. ones that do not apply to the get/set convention of beans. only implemented with empty method body.
protected java.lang.Object	writePreProcess(java.lang.Object o) enables derived classes to due some pre-processing on the objects, that's about to be serialized.
org.w3c.dom.Element	writeSaver(org.w3c.dom.Element parent, java.lang.Object o, java.lang.String name) adds the given Saver to a DOM structure.

Methods inherited from class weka.core.xml.XMLBasicSerialization

getRevision, readCollection, readCostMatrix, readCostMatrixOld, readDefaultListModel, readMap, readMatrix, readMatrixOld, writeCollection, writeCostMatrix, writeCostMatrixOld, writeDefaultListModel, writeMap, writeMatrix, writeMatrixOld

Methods inherited from class weka.core.xml.XMLSerialization

addElement, addElement, addElement, booleanToString, determineClass, determineDescriptor, fromXML, getArrayDimensions, getDescriptorByName, getDescriptors, getPath, getPrimitive, getVersion, invokeReadFromXML, invokeWriteToXML, isPrimitiveArray, main, overrideClassname, overrideClassname, read, read, read, read, readBooleanFromXML, readByteFromXML, readCharFromXML, readDoubleFromXML, readFloatFromXML, readFromXML, readFromXML, readIntFromXML, readLongFromXML, readShortFromXML, setSuppressWarnings, stringToBoolean, toXML, trace, write, write, write, write, writeBooleanToXML, writeByteToXML, writeCharToXML, writeDoubleToXML, writeFloatToXML, writeIntToXML, writeLongToXML, writeShortToXML, writeToXML

Methods inherited from class java.lang.Object

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

Field Detail

VAL_ID

public static final java.lang.String VAL_ID

the value of the id property

See Also:

Constant Field Values

VAL_X

public static final java.lang.String VAL_X

the value of the x property

See Also:

Constant Field Values

VAL_Y

public static final java.lang.String VAL_Y

the value of the y property

See Also:

Constant Field Values

VAL_BEAN

public static final java.lang.String VAL_BEAN

the value of the bean property

See Also:

Constant Field Values

VAL_CUSTOM_NAME

public static final java.lang.String VAL_CUSTOM_NAME

the value of the customName property

See Also:

Constant Field Values

VAL_SOURCEID

public static final java.lang.String VAL_SOURCEID

the value of the source property

See Also:

Constant Field Values

VAL_TARGETID

public static final java.lang.String VAL_TARGETID

the value of the target property

See Also:

Constant Field Values

VAL_EVENTNAME

public static final java.lang.String VAL_EVENTNAME

the value of the eventname property

See Also:

Constant Field Values

VAL_HIDDEN

public static final java.lang.String VAL_HIDDEN

the value of the hidden property

See Also:

Constant Field Values

VAL_FILE

public static final java.lang.String VAL_FILE

the value of the file property

See Also:

Constant Field Values

VAL_DIR

public static final java.lang.String VAL_DIR

the value of the dir property

See Also:

Constant Field Values

VAL_PREFIX

public static final java.lang.String VAL_PREFIX

the value of the prefix property

See Also:

Constant Field Values

VAL_RELATIVE_PATH

public static final java.lang.String VAL_RELATIVE_PATH

See Also:

Constant Field Values

VAL_OPTIONS

public static final java.lang.String VAL_OPTIONS

the value of the options property

See Also:

Constant Field Values

VAL_SAVER

public static final java.lang.String VAL_SAVER

the value of the saver property

See Also:

Constant Field Values

VAL_LOADER

public static final java.lang.String VAL_LOADER

the value of the loader property

See Also:

Constant Field Values

VAL_TEXT

public static final java.lang.String VAL_TEXT

the value of the text property

See Also:

Constant Field Values

VAL_BEANCONTEXT

public static final java.lang.String VAL_BEANCONTEXT

the value of the beanContext property

See Also:

Constant Field Values

VAL_WIDTH

public static final java.lang.String VAL_WIDTH

the value of the width property

See Also:

Constant Field Values

VAL_HEIGHT

public static final java.lang.String VAL_HEIGHT

the value of the height property

See Also:

Constant Field Values

VAL_RED

public static final java.lang.String VAL_RED

the value of the red property

See Also:

Constant Field Values

VAL_GREEN

public static final java.lang.String VAL_GREEN

the value of the green property

See Also:

Constant Field Values

VAL_BLUE

public static final java.lang.String VAL_BLUE

the value of the blue property

See Also:

Constant Field Values

VAL_NAME

public static final java.lang.String VAL_NAME

the value of the value property

See Also:

Constant Field Values

VAL_STYLE

public static final java.lang.String VAL_STYLE

the value of the style property

See Also:

Constant Field Values

VAL_LOCATION

public static final java.lang.String VAL_LOCATION

the value of the location property

See Also:

Constant Field Values

VAL_SIZE

public static final java.lang.String VAL_SIZE

the value of the size property

See Also:

Constant Field Values

VAL_COLOR

public static final java.lang.String VAL_COLOR

the value of the color property

See Also:

Constant Field Values

VAL_FONT

public static final java.lang.String VAL_FONT

the value of the font property

See Also:

Constant Field Values

VAL_ICONPATH

public static final java.lang.String VAL_ICONPATH

the value of the iconpath property

See Also:

Constant Field Values

VAL_ANIMATEDICONPATH

public static final java.lang.String VAL_ANIMATEDICONPATH

the value of the animatedIconPath property

See Also:

Constant Field Values

VAL_ASSOCIATEDCONNECTIONS

public static final java.lang.String VAL_ASSOCIATEDCONNECTIONS

the value of the associatedConnections property

See Also:

Constant Field Values

VAL_INPUTS

public static final java.lang.String VAL_INPUTS

the value of the input property

See Also:

Constant Field Values

VAL_INPUTSID

public static final java.lang.String VAL_INPUTSID

the value of the input id property

See Also:

Constant Field Values

VAL_OUTPUTS

public static final java.lang.String VAL_OUTPUTS

the value of the outputs id property

See Also:

Constant Field Values

VAL_OUTPUTSID

public static final java.lang.String VAL_OUTPUTSID

the value of the outputs property

See Also:

Constant Field Values

VAL_SUBFLOW

public static final java.lang.String VAL_SUBFLOW

the value of the subFlow property

See Also:

Constant Field Values

VAL_ORIGINALCOORDS

public static final java.lang.String VAL_ORIGINALCOORDS

the value of the originalCoords property

See Also:

Constant Field Values

VAL_RELATIONNAMEFORFILENAME

public static final java.lang.String VAL_RELATIONNAMEFORFILENAME

the value of the relationNameForFilename property (Saver)

See Also:

Constant Field Values

INDEX_BEANINSTANCES

public static final int INDEX_BEANINSTANCES

the index in the Vector, where the BeanInstances are stored (Instances and Connections are stored in a Vector and then serialized)

See Also:

Constant Field Values

INDEX_BEANCONNECTIONS

public static final int INDEX_BEANCONNECTIONS

the index in the Vector, where the BeanConnections are stored (Instances and Connections are stored in a Vector and then serialized)

See Also:

Constant Field Values

m_BeanLayout

protected javax.swing.JComponent m_BeanLayout

the component that manages the layout of the beans

m_BeanInstances

protected java.util.Vector<java.lang.Object> m_BeanInstances

keeps track of the BeanInstances read so far, used for the BeanConnections

m_BeanInstancesID

protected java.util.Vector<java.lang.Integer> m_BeanInstancesID

keeps track of the BeanInstances read so far, used for the BeanConnections

m_IgnoreBeanConnections

protected boolean m_IgnoreBeanConnections

whether to ignore the BeanConnection

m_CurrentMetaBean

protected MetaBean m_CurrentMetaBean

the current MetaBean (for the BeanConnections)

REGULAR_CONNECTION

protected static final java.lang.String REGULAR_CONNECTION

the identifier for regular BeanConnections

See Also:

Constant Field Values

m_BeanConnectionRelation

protected java.util.Hashtable<java.lang.Object,java.util.Vector<java.lang.String>> m_BeanConnectionRelation

the relation between Bean and connection, MetaBean BeanConnections are stored under the reference of the MetaBean, regular connections are stored under REGULAR_CONNECTION. The relation has the following format (is a string): sourcePos,targetPos,event,hidden

See Also:

REGULAR_CONNECTION

DATATYPE_LAYOUT

public static final int DATATYPE_LAYOUT

the data that is about to be read/written contains a complete layout

See Also:

m_DataType, Constant Field Values

DATATYPE_USERCOMPONENTS

public static final int DATATYPE_USERCOMPONENTS

the data that is about to be read/written contains user-components, i.e., Metabeans

See Also:

m_DataType, Constant Field Values

m_DataType

protected int m_DataType

the type of data that is be read/written

See Also:

DATATYPE_LAYOUT, DATATYPE_USERCOMPONENTS

m_BeanContextSupport

protected java.beans.beancontext.BeanContextSupport m_BeanContextSupport

the beancontext to use for loading from XML and the beancontext is null in the bean

m_vectorIndex

protected int m_vectorIndex

The index of the vector of bean instances or connections to use. this corresponds to a tab in the main KnowledgeFlow UI

Constructor Detail

XMLBeans

public XMLBeans(javax.swing.JComponent layout,
                java.beans.beancontext.BeanContextSupport context,
                int tab)
         throws java.lang.Exception

initializes the serialization for layouts

Parameters:

layout - the component that manages the layout

context - the bean context support to use

tab - the index of the vector of bean instances or connections to use (this corresponds to a visible tab in the main KnowledgeFlow UI)

Throws:

java.lang.Exception - if initialization fails

XMLBeans

public XMLBeans(javax.swing.JComponent layout,
                java.beans.beancontext.BeanContextSupport context,
                int datatype,
                int tab)
         throws java.lang.Exception

initializes the serialization for different types of data

Parameters:

layout - the component that manages the layout

context - the bean context support to use

datatype - the type of data to read/write

Throws:

java.lang.Exception - if initialization fails

Method Detail

setDataType

public void setDataType(int value)

sets what kind of data is to be read/written

Parameters:

value - the type of data

See Also:

m_DataType

getDataType

public int getDataType()

returns the type of data that is to be read/written

Returns:

the type of data

See Also:

m_DataType

clear

public void clear()
           throws java.lang.Exception

generates internally a new XML document and clears also the IgnoreList and the mappings for the Read/Write-Methods

Overrides:

clear in class XMLBasicSerialization

Throws:

java.lang.Exception - if something goes wrong

addBeanInstances

protected void addBeanInstances(java.util.Vector<java.lang.Object> list)

traverses over all BeanInstances (or MetaBeans) and stores them in a vector (recurses into MetaBeans, since the sub-BeanInstances are not visible)

Parameters:

list - the BeanInstances/MetaBeans to traverse

writePreProcess

protected java.lang.Object writePreProcess(java.lang.Object o)
                                    throws java.lang.Exception

enables derived classes to due some pre-processing on the objects, that's about to be serialized. Right now it only returns the object.

Overrides:

writePreProcess in class XMLSerialization

Parameters:

o - the object that is serialized into XML

Returns:

the possibly altered object

Throws:

java.lang.Exception - if post-processing fails

writePostProcess

protected void writePostProcess(java.lang.Object o)
                         throws java.lang.Exception

enables derived classes to add other properties to the DOM tree, e.g. ones that do not apply to the get/set convention of beans. only implemented with empty method body.

Overrides:

writePostProcess in class XMLSerialization

Parameters:

o - the object that is serialized into XML

Throws:

java.lang.Exception - if post-processing fails

readPreProcess

protected org.w3c.dom.Document readPreProcess(org.w3c.dom.Document document)
                                       throws java.lang.Exception

additional pre-processing can happen in derived classes before the actual reading from XML (working on the raw XML). right now it does nothing with the document, only empties the help-vector for the BeanInstances and reads the IDs for the BeanInstances, s.t. the correct references can be set again

Overrides:

readPreProcess in class XMLSerialization

Parameters:

document - the document to pre-process

Returns:

the processed object

Throws:

java.lang.Exception - if post-processing fails

See Also:

m_BeanInstances

setBeanConnection

protected void setBeanConnection(BeanConnection conn,
                                 java.util.Vector<BeanConnection> list)

puts the given BeanConnection onto the next null in the given Vector, or at the end of the list, if no null is found. (during the de-serializing, no BeanConnections are set, only nulls)

Parameters:

conn - the connection to add to the list

list - the list to add the BeanConnection to

createBeanConnection

protected BeanConnection createBeanConnection(int sourcePos,
                                              int targetPos,
                                              java.lang.String event,
                                              boolean hidden)
                                       throws java.lang.Exception

generates a connection based on the given parameters

Parameters:

sourcePos - the source position in the m_BeanInstances vector

targetPos - the target position in the m_BeanInstances vector

event - the name of the event, i.e., the connection

hidden - true if the connection is hidden

Returns:

the generated BeanConnection

Throws:

java.lang.Exception - if something goes wrong

rebuildBeanConnections

protected void rebuildBeanConnections(java.util.Vector<java.util.Vector<?>> deserialized,
                                      java.lang.Object key)
                               throws java.lang.Exception

rebuilds all the connections for a certain key in the hashtable. for the ones being part of a MetaBean, no new instance is built, but only the reference to the actual BeanConnection set.

Parameters:

deserialized - the deserialized knowledgeflow

key - the key of the hashtable to rebuild all connections for

Throws:

java.lang.Exception - if something goes wrong

removeUserToolBarBeans

protected void removeUserToolBarBeans(java.util.Vector<?> metabeans)

removes the given meta beans from the layout, since they're only listed in the user toolbar

Parameters:

metabeans - the list of MetaBeans in the user toolbar

readPostProcess

protected java.lang.Object readPostProcess(java.lang.Object o)
                                    throws java.lang.Exception

additional post-processing can happen in derived classes after reading from XML. re-builds the BeanConnections.

Overrides:

readPostProcess in class XMLSerialization

Parameters:

o - the object to perform some additional processing on

Returns:

the processed object

Throws:

java.lang.Exception - if post-processing fails

getBeanConnectionRelation

protected java.util.Vector<java.lang.String> getBeanConnectionRelation(MetaBean meta)

returns the relation for the given MetaBean, for the regular connections, null has to be used

Parameters:

meta - the MetaBean (or null for regular connections) to retrieve the connections for

Returns:

the associated connections

See Also:

REGULAR_CONNECTION

addBeanConnectionRelation

protected void addBeanConnectionRelation(MetaBean meta,
                                         java.lang.String connection)

adds the given connection-relation for the specified MetaBean (or null in case of regular connections)

Parameters:

meta - the MetaBean (or null for regular connections) to add the relationship for

connection - the connection relation to add

writeColor

public org.w3c.dom.Element writeColor(org.w3c.dom.Element parent,
                                      java.lang.Object o,
                                      java.lang.String name)
                               throws java.lang.Exception

adds the given Color to a DOM structure.

Overrides:

writeColor in class XMLBasicSerialization

Parameters:

parent - the parent of this object, e.g. the class this object is a member of

o - the Object to describe in XML

name - the name of the object

Returns:

the node that was created

Throws:

java.lang.Exception - if the DOM creation fails

See Also:

Color

readColor

public java.lang.Object readColor(org.w3c.dom.Element node)
                           throws java.lang.Exception

builds the Color from the given DOM node.

Overrides:

readColor in class XMLBasicSerialization

Parameters:

node - the associated XML node

Returns:

the instance created from the XML description

Throws:

java.lang.Exception - if instantiation fails

See Also:

Color

writeDimension

public org.w3c.dom.Element writeDimension(org.w3c.dom.Element parent,
                                          java.lang.Object o,
                                          java.lang.String name)
                                   throws java.lang.Exception

adds the given Dimension to a DOM structure.

Parameters:

parent - the parent of this object, e.g. the class this object is a member of

o - the Object to describe in XML

name - the name of the object

Returns:

the node that was created

Throws:

java.lang.Exception - if the DOM creation fails

readDimension

public java.lang.Object readDimension(org.w3c.dom.Element node)
                               throws java.lang.Exception

builds the Dimension from the given DOM node.

Parameters:

node - the associated XML node

Returns:

the instance created from the XML description

Throws:

java.lang.Exception - if instantiation fails

writeFont

public org.w3c.dom.Element writeFont(org.w3c.dom.Element parent,
                                     java.lang.Object o,
                                     java.lang.String name)
                              throws java.lang.Exception

adds the given Font to a DOM structure.

Parameters:

parent - the parent of this object, e.g. the class this object is a member of

o - the Object to describe in XML

name - the name of the object

Returns:

the node that was created

Throws:

java.lang.Exception - if the DOM creation fails

readFont

public java.lang.Object readFont(org.w3c.dom.Element node)
                          throws java.lang.Exception

builds the Font from the given DOM node.

Parameters:

node - the associated XML node

Returns:

the instance created from the XML description

Throws:

java.lang.Exception - if instantiation fails

writePoint

public org.w3c.dom.Element writePoint(org.w3c.dom.Element parent,
                                      java.lang.Object o,
                                      java.lang.String name)
                               throws java.lang.Exception

adds the given Point to a DOM structure.

Parameters:

parent - the parent of this object, e.g. the class this object is a member of

o - the Object to describe in XML

name - the name of the object

Returns:

the node that was created

Throws:

java.lang.Exception - if the DOM creation fails

readPoint

public java.lang.Object readPoint(org.w3c.dom.Element node)
                           throws java.lang.Exception

builds the Point from the given DOM node.

Parameters:

node - the associated XML node

Returns:

the instance created from the XML description

Throws:

java.lang.Exception - if instantiation fails

writeColorUIResource

public org.w3c.dom.Element writeColorUIResource(org.w3c.dom.Element parent,
                                                java.lang.Object o,
                                                java.lang.String name)
                                         throws java.lang.Exception

adds the given ColorUIResource to a DOM structure.

Parameters:

parent - the parent of this object, e.g. the class this object is a member of

o - the Object to describe in XML

name - the name of the object

Returns:

the node that was created

Throws:

java.lang.Exception - if the DOM creation fails

readColorUIResource

public java.lang.Object readColorUIResource(org.w3c.dom.Element node)
                                     throws java.lang.Exception

builds the ColorUIResource from the given DOM node.

Parameters:

node - the associated XML node

Returns:

the instance created from the XML description

Throws:

java.lang.Exception - if instantiation fails

writeFontUIResource

public org.w3c.dom.Element writeFontUIResource(org.w3c.dom.Element parent,
                                               java.lang.Object o,
                                               java.lang.String name)
                                        throws java.lang.Exception

adds the given FontUIResource to a DOM structure.

Parameters:

parent - the parent of this object, e.g. the class this object is a member of

o - the Object to describe in XML

name - the name of the object

Returns:

the node that was created

Throws:

java.lang.Exception - if the DOM creation fails

readFontUIResource

public java.lang.Object readFontUIResource(org.w3c.dom.Element node)
                                    throws java.lang.Exception

builds the FontUIResource from the given DOM node.

Parameters:

node - the associated XML node

Returns:

the instance created from the XML description

Throws:

java.lang.Exception - if instantiation fails

writeBeanInstance

public org.w3c.dom.Element writeBeanInstance(org.w3c.dom.Element parent,
                                             java.lang.Object o,
                                             java.lang.String name)
                                      throws java.lang.Exception

adds the given BeanInstance to a DOM structure.

Parameters:

parent - the parent of this object, e.g. the class this object is a member of

o - the Object to describe in XML

name - the name of the object

Returns:

the node that was created

Throws:

java.lang.Exception - if the DOM creation fails

readBeanInstance

public java.lang.Object readBeanInstance(org.w3c.dom.Element node)
                                  throws java.lang.Exception

builds the BeanInstance from the given DOM node.

Parameters:

node - the associated XML node

Returns:

the instance created from the XML description

Throws:

java.lang.Exception - if instantiation fails

writeBeanConnection

public org.w3c.dom.Element writeBeanConnection(org.w3c.dom.Element parent,
                                               java.lang.Object o,
                                               java.lang.String name)
                                        throws java.lang.Exception

adds the given BeanConncetion to a DOM structure.

Parameters:

parent - the parent of this object, e.g. the class this object is a member of

o - the Object to describe in XML

name - the name of the object

Returns:

the node that was created

Throws:

java.lang.Exception - if the DOM creation fails

readBeanConnection

public java.lang.Object readBeanConnection(org.w3c.dom.Element node)
                                    throws java.lang.Exception

builds the BeanConnection from the given DOM node.

Parameters:

node - the associated XML node

Returns:

the instance created from the XML description

Throws:

java.lang.Exception - if instantiation fails

writeBeanLoader

public org.w3c.dom.Element writeBeanLoader(org.w3c.dom.Element parent,
                                           java.lang.Object o,
                                           java.lang.String name)
                                    throws java.lang.Exception

adds the given Loader (a bean) to a DOM structure.

Parameters:

parent - the parent of this object, e.g. the class this object is a member of

o - the Object to describe in XML

name - the name of the object

Returns:

the node that was created

Throws:

java.lang.Exception - if the DOM creation fails

writeBeanSaver

public org.w3c.dom.Element writeBeanSaver(org.w3c.dom.Element parent,
                                          java.lang.Object o,
                                          java.lang.String name)
                                   throws java.lang.Exception

adds the given Saver (a bean) to a DOM structure.

Parameters:

parent - the parent of this object, e.g. the class this object is a member of

o - the Object to describe in XML

name - the name of the object

Returns:

the node that was created

Throws:

java.lang.Exception - if the DOM creation fails

writeLoader

public org.w3c.dom.Element writeLoader(org.w3c.dom.Element parent,
                                       java.lang.Object o,
                                       java.lang.String name)
                                throws java.lang.Exception

adds the given Loader to a DOM structure.

Parameters:

parent - the parent of this object, e.g. the class this object is a member of

o - the Object to describe in XML

name - the name of the object

Returns:

the node that was created

Throws:

java.lang.Exception - if the DOM creation fails

readLoader

public java.lang.Object readLoader(org.w3c.dom.Element node)
                            throws java.lang.Exception

builds the Loader from the given DOM node.

Parameters:

node - the associated XML node

Returns:

the instance created from the XML description

Throws:

java.lang.Exception - if instantiation fails

writeSaver

public org.w3c.dom.Element writeSaver(org.w3c.dom.Element parent,
                                      java.lang.Object o,
                                      java.lang.String name)
                               throws java.lang.Exception

adds the given Saver to a DOM structure.

Parameters:

parent - the parent of this object, e.g. the class this object is a member of

o - the Object to describe in XML

name - the name of the object

Returns:

the node that was created

Throws:

java.lang.Exception - if the DOM creation fails

readSaver

public java.lang.Object readSaver(org.w3c.dom.Element node)
                           throws java.lang.Exception

builds the Saver from the given DOM node.

Parameters:

node - the associated XML node

Returns:

the instance created from the XML description

Throws:

java.lang.Exception - if instantiation fails

writeBeanVisual

public org.w3c.dom.Element writeBeanVisual(org.w3c.dom.Element parent,
                                           java.lang.Object o,
                                           java.lang.String name)
                                    throws java.lang.Exception

adds the given BeanVisual to a DOM structure.

Parameters:

parent - the parent of this object, e.g. the class this object is a member of

o - the Object to describe in XML

name - the name of the object

Returns:

the node that was created

Throws:

java.lang.Exception - if the DOM creation fails

readBeanVisual

public java.lang.Object readBeanVisual(org.w3c.dom.Element node)
                                throws java.lang.Exception

builds the BeanVisual from the given DOM node.

Parameters:

node - the associated XML node

Returns:

the instance created from the XML description

Throws:

java.lang.Exception - if instantiation fails

getIDsForBeanInstances

protected java.util.Vector<java.lang.Integer> getIDsForBeanInstances(java.util.Vector<java.lang.Object> beans)

returns the IDs for the given BeanInstances, i.e., the stored IDs in m_BeanInstancesID, based on m_BeanInstances

Parameters:

beans - the beans to retrieve the IDs for

Returns:

the IDs for the given BeanInstances

See Also:

m_BeanInstances, m_BeanInstancesID

writeMetaBean

public org.w3c.dom.Element writeMetaBean(org.w3c.dom.Element parent,
                                         java.lang.Object o,
                                         java.lang.String name)
                                  throws java.lang.Exception

adds the given MetaBean to a DOM structure.

Parameters:

parent - the parent of this object, e.g. the class this object is a member of

o - the Object to describe in XML

name - the name of the object

Returns:

the node that was created

Throws:

java.lang.Exception - if the DOM creation fails

getBeanInstancesForIDs

protected java.util.Vector<java.lang.Object> getBeanInstancesForIDs(java.util.Vector<java.lang.Integer> ids)

returns a vector with references to BeanInstances according to the IDs in the given Vector.

Parameters:

ids - contains the IDs of the BeanInstances

Returns:

the corresponding BeanInstances

See Also:

m_BeanInstances, m_BeanInstancesID

readMetaBean

public java.lang.Object readMetaBean(org.w3c.dom.Element node)
                              throws java.lang.Exception

builds the MetaBean from the given DOM node.

Parameters:

node - the associated XML node

Returns:

the instance created from the XML description

Throws:

java.lang.Exception - if instantiation fails