com.highqsoft.fwk

Class FwkDOMHandler

java.lang.Object

com.highqsoft.fwk.Fwk

com.highqsoft.fwk.FwkDescription

com.highqsoft.fwk.FwkDOMHandler

All Implemented Interfaces:

FwkDescriptionInterface, FwkDOMHandlerInterface, FwkInterface, FwkTransferableInterface, java.awt.datatransfer.ClipboardOwner, java.awt.datatransfer.Transferable, java.io.Serializable, java.lang.Cloneable

public class FwkDOMHandler
extends FwkDescription
implements FwkDOMHandlerInterface

The FwkDomHandler implements the basic methods of the FwkDomHandlerInterface. Additionally it implements a set of useful methods used to create DOM elements.

Since:

$Date: 2017/04/06 13:28:59 $

Version:

$Revision: 1.17 $

Author:

Andreas Hofmann

See Also:

, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.util.HashMap	cmdPropObjects
static java.lang.String	version

Fields inherited from class com.highqsoft.fwk.FwkDescription

author, buildnr, className, company, copyright, creationDate, dateFormatString, description, eMail, FWK_ICON, FWK_ICON_ARRAY, FWK_ICON_BG, FWK_ICON_BG_ARRAY, FWK_ICON_BG_LARGE, FWK_ICON_BG_LARGE_ARRAY, FWK_ICON_LARGE, FWK_ICON_LARGE_ARRAY, icon, ICON, iconCount, iconKey, internetAddress, name, titleName

Fields inherited from interface com.highqsoft.interfaces.fwk.FwkDescriptionInterface

AUTHOR, BUILDNR, COMPANY, COPYRIGHT, DATE_FORMAT, DEFAULT_ICON, DESCRIPTION, INTERNET, LARGE_ICON, LARGE_KEY_EXT, LARGE_OPAQUE_ICON, LARGE_OPAQUE_KEY_EXT, OPAQUE_ICON, OPAQUE_KEY_EXT, RCS_DATE_FORMAT, SUPPORT_EMAIL, TITLE_NAME

Constructor Summary

Constructors

Constructor and Description
FwkDOMHandler() The constructor.

Method Summary

Methods

Modifier and Type	Method and Description
static org.w3c.dom.Element	appendPropertyNode(org.w3c.dom.Node node, java.lang.String name, java.lang.String value) Append a property node to the specified node.
static FwkArrayInterface	getCommandProperties(java.lang.Class clazz) Get an array containing the command properties.
java.lang.String	getCompany() Get the company that is responsable for that handler.
java.lang.String	getVersion() Return the version string of the FWK component.
static FwkDescriptionInterface	readCommandsFromDOM(org.w3c.dom.Document doc, org.w3c.dom.Element elem) Reads a description object from DOM.
static FwkInstructionInterface	readCommandsFromDOM(FwkInstructionInterface cmd, org.w3c.dom.Document doc, org.w3c.dom.Element elem) Reads an instruction object from DOM.
java.lang.Object	readConstructor(org.w3c.dom.Document document, org.w3c.dom.Element node) Read a construtor dom node.
static java.lang.Object	readConstructor(java.lang.Object obj, org.w3c.dom.Document document, org.w3c.dom.Element node) Read a construtor dom node.
void	readFromDOM(org.w3c.dom.Document doc, org.w3c.dom.Element element) Read from DOM
static void	readFromDOM(java.lang.Object obj, org.w3c.dom.Document doc, org.w3c.dom.Element element) Read from DOM.
static java.lang.Object	readFromXML(FwkControllerInterface controller, java.io.InputStream is, boolean validate) Read a xml coming from an input stream.
static java.lang.Object	readFromXML(FwkControllerInterface controller, java.lang.String filename) Read an xml file.
boolean	readingDOM() Get the DOM reading flag.
void	readingDOM(boolean flag) Set a flag that the object is currently reading the DOM.
static java.util.Map	readMapFromDOM(org.w3c.dom.Document document, org.w3c.dom.Element node) This method reads a map from the given node.
static java.util.Map	readMapFromDOM(java.util.Map map, org.w3c.dom.Document document, org.w3c.dom.Element node) This method reads a map from the given node.
static void	writeCommandsToDOM(FwkCommandInterface[] commands, org.w3c.dom.Document document, FwkXmlDtdInterface dtd, org.w3c.dom.Element node, FwkArrayInterface props) Write an array containing commands to DOM.
org.w3c.dom.Element	writeConstructor(org.w3c.dom.Document document, FwkXmlDtdInterface dtd, org.w3c.dom.Node node, java.util.Map classProperties) Write a construtor dom node.
static org.w3c.dom.Element	writeConstructor(java.lang.Object object, java.lang.String name, boolean recursive, org.w3c.dom.Document document, FwkXmlDtdInterface dtd, org.w3c.dom.Node node, java.util.Map classProperties, boolean withPropertyBus) Write a construtor dom node.
static org.w3c.dom.Element	writeDescriptionToDOM(FwkDescriptionInterface descriptor, org.w3c.dom.Document document, FwkXmlDtdInterface dtd, org.w3c.dom.Node node) Write a description to DOM.
static org.w3c.dom.Element	writeFrameToDOM(FwkApplicationInterface application, org.w3c.dom.Document document, FwkXmlDtdInterface dtd, org.w3c.dom.Element node) Write the frame of the application to DOM.
static org.w3c.dom.Element	writeMapToDOM(java.util.Map map, org.w3c.dom.Document document, FwkXmlDtdInterface dtd, org.w3c.dom.Element node, java.util.Map classProperties) This method writes a map of the given object to DOM.
static org.w3c.dom.Element	writePanelToDOM(FwkPanelInterface panel, org.w3c.dom.Document document, FwkXmlDtdInterface dtd, org.w3c.dom.Element node) Write a panel to DOM.
static void	writePropertiesToDOM(java.lang.Object object, org.w3c.dom.Document document, FwkXmlDtdInterface dtd, org.w3c.dom.Element node, java.util.Map classProperties) This method writes the properties of the given object to DOM.
org.w3c.dom.Element	writeToDOM(org.w3c.dom.Document document, FwkXmlDtdInterface dtd, org.w3c.dom.Node node, java.util.Map classProperties) Write the container as child to the given DOM node.
static boolean	writeToXML(FwkDescriptionInterface descriptor, java.lang.String filename, boolean validate) Writes a descriptor to a XML file.
static boolean	writeToXML(FwkDOMHandlerInterface handler, java.lang.String filename, java.lang.Class[] interpreters, boolean validate) Writes a dom handler to an XML file.
static boolean	writeToXML(FwkDOMHandlerInterface handler, java.lang.String filename, java.lang.Class interpreter, boolean validate) Writes a DOM handler to a XML file.
static boolean	writeToXML(FwkDOMHandlerInterface handler, java.io.Writer writer, java.lang.Class[] interpreters, boolean validate) Writes a dom handler to a writer.
boolean	writeToXML(java.lang.String filename, boolean validate) Write the handle to the given xml file.

Methods inherited from class com.highqsoft.fwk.FwkDescription

getAuthor, getBuild, getClassName, getCompanyInternetAddress, getCopyright, getCreationDate, getCreationDate, getDateFormatString, getDescription, getIcon, getIcon, getIconKey, getIconKey, getName, getPresentationString, getPresentationString, getSupportEMail, getTitle, getTitleName, getTransferData, getTransferDataFlavors, isDataFlavorSupported, lostOwnership, setAuthor, setBuild, setClassName, setCompany, setCompanyInternetAddress, setCopyright, setCreationDate, setCreationDate, setDateFormatString, setDescription, setDescriptor, setIcon, setIcon, setIconKey, setIconKey, setName, setSupportEMail, setTitleName, toString

Methods inherited from class com.highqsoft.fwk.Fwk

getNiceVersion, release

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkDescriptionInterface

getAuthor, getBuild, getClassName, getCompanyInternetAddress, getCopyright, getCreationDate, getCreationDate, getDateFormatString, getDescription, getIcon, getIcon, getIconKey, getIconKey, getName, getPresentationString, getPresentationString, getSupportEMail, getTitle, getTitleName, setAuthor, setBuild, setClassName, setCompany, setCompanyInternetAddress, setCopyright, setCreationDate, setCreationDate, setDateFormatString, setDescription, setDescriptor, setIcon, setIcon, setIconKey, setIconKey, setName, setSupportEMail, setTitleName

Methods inherited from interface com.highqsoft.interfaces.fwk.FwkInterface

release

Methods inherited from interface java.awt.datatransfer.Transferable

getTransferData, getTransferDataFlavors, isDataFlavorSupported

Methods inherited from interface java.awt.datatransfer.ClipboardOwner

lostOwnership

Field Detail

version

public static final java.lang.String version

See Also:

Constant Field Values

cmdPropObjects

protected static java.util.HashMap cmdPropObjects

Constructor Detail

FwkDOMHandler

public FwkDOMHandler()

The constructor.

Method Detail

getVersion

public java.lang.String getVersion()

Description copied from interface: FwkInterface

Return the version string of the FWK component.

Specified by:

getVersion in interface FwkInterface

Overrides:

getVersion in class FwkDescription

readingDOM

public void readingDOM(boolean flag)

Set a flag that the object is currently reading the DOM.

Specified by:

readingDOM in interface FwkDOMHandlerInterface

Parameters:

flag - true if the object reads currently fom DOM.

readingDOM

public boolean readingDOM()

Get the DOM reading flag.

Specified by:

readingDOM in interface FwkDOMHandlerInterface

Returns:

true if the object reads currently fom DOM.

readConstructor

public java.lang.Object readConstructor(org.w3c.dom.Document document,
                               org.w3c.dom.Element node)

Read a construtor dom node.

Specified by:

readConstructor in interface FwkDOMHandlerInterface

Parameters:

document - The documnent Object Model.

node - The node.

readConstructor

public static java.lang.Object readConstructor(java.lang.Object obj,
                               org.w3c.dom.Document document,
                               org.w3c.dom.Element node)

Read a construtor dom node.

Parameters:

obj - The parent object.

document - The documnent Object Model.

node - The node.

readFromDOM

public void readFromDOM(org.w3c.dom.Document doc,
               org.w3c.dom.Element element)

Read from DOM

Specified by:

readFromDOM in interface FwkDOMHandlerInterface

Parameters:

document - The documnent Object Model.

node - The node.

readFromDOM

public static void readFromDOM(java.lang.Object obj,
               org.w3c.dom.Document doc,
               org.w3c.dom.Element element)

Read from DOM.

Parameters:

object - The object that should be configurate.

document - The documnent Object Model.

node - The node.

writeConstructor

public org.w3c.dom.Element writeConstructor(org.w3c.dom.Document document,
                                   FwkXmlDtdInterface dtd,
                                   org.w3c.dom.Node node,
                                   java.util.Map classProperties)

Write a construtor dom node.

Specified by:

writeConstructor in interface FwkDOMHandlerInterface

Parameters:

document - The documnent Object Model.

dtd - The dtd descriptor.

node - The node.

classProperties - Map the contains the writable object properties. May be null.

Returns:

The created document element node.

writeConstructor

public static org.w3c.dom.Element writeConstructor(java.lang.Object object,
                                   java.lang.String name,
                                   boolean recursive,
                                   org.w3c.dom.Document document,
                                   FwkXmlDtdInterface dtd,
                                   org.w3c.dom.Node node,
                                   java.util.Map classProperties,
                                   boolean withPropertyBus)

Write a construtor dom node.

Parameters:

object - The object to be written.

name - The name of the new node.

recursive - If true the element will be defined as recursive element.

document - The documnent Object Model.

dtd - The dtd descriptor.

node - The node.

classProperties - Map the contains the writable object properties. May be null.

withPropertyBus - If the node is the root node and this value is true then the properties from PropertyBus will be written first.

writeToDOM

public org.w3c.dom.Element writeToDOM(org.w3c.dom.Document document,
                             FwkXmlDtdInterface dtd,
                             org.w3c.dom.Node node,
                             java.util.Map classProperties)

Write the container as child to the given DOM node.

Specified by:

writeToDOM in interface FwkDOMHandlerInterface

Parameters:

document - The documnent Object Model.

dtd - The dtd descriptor.

node - The parent node.

classProperties - Map the contains the writable properties. May be null.

Returns:

The create document element.

getCommandProperties

public static FwkArrayInterface getCommandProperties(java.lang.Class clazz)

Get an array containing the command properties.

Returns:

The array containing the command properties.

readCommandsFromDOM

public static FwkInstructionInterface readCommandsFromDOM(FwkInstructionInterface cmd,
                                          org.w3c.dom.Document doc,
                                          org.w3c.dom.Element elem)

Reads an instruction object from DOM.

Parameters:

cmd - The command.

doc - The document object model.

elem - The node from that the command should read.

Returns:

The command itself.

writeFrameToDOM

public static org.w3c.dom.Element writeFrameToDOM(FwkApplicationInterface application,
                                  org.w3c.dom.Document document,
                                  FwkXmlDtdInterface dtd,
                                  org.w3c.dom.Element node)

Write the frame of the application to DOM.

Parameters:

application - The application.

document - The document object model.

dtd - The dtd descriptor.

node - The parent node.

Returns:

the node of the frame or node

writePanelToDOM

public static org.w3c.dom.Element writePanelToDOM(FwkPanelInterface panel,
                                  org.w3c.dom.Document document,
                                  FwkXmlDtdInterface dtd,
                                  org.w3c.dom.Element node)

Write a panel to DOM.

Parameters:

panel - The panel.

document - The document object model.

dtd - The dtd descriptor.

node - The parent node.

Returns:

the node of the panel or node

writeDescriptionToDOM

public static org.w3c.dom.Element writeDescriptionToDOM(FwkDescriptionInterface descriptor,
                                        org.w3c.dom.Document document,
                                        FwkXmlDtdInterface dtd,
                                        org.w3c.dom.Node node)

Write a description to DOM.

Parameters:

description - A description.

document - The document object model.

dtd - The dtd descriptor.

node - The parent node.

readCommandsFromDOM

public static FwkDescriptionInterface readCommandsFromDOM(org.w3c.dom.Document doc,
                                          org.w3c.dom.Element elem)

Reads a description object from DOM.

Parameters:

doc - The document object model.

elem - The node from that the command should read.

Returns:

The command itself.

writeCommandsToDOM

public static void writeCommandsToDOM(FwkCommandInterface[] commands,
                      org.w3c.dom.Document document,
                      FwkXmlDtdInterface dtd,
                      org.w3c.dom.Element node,
                      FwkArrayInterface props)

Write an array containing commands to DOM.

Parameters:

commands - The array containing the commands to be written.

document - The document object model.

dtd - The dtd descriptor.

node - The parent node.

classProperties - Map the contains the writable properties. May be null.

appendPropertyNode

public static org.w3c.dom.Element appendPropertyNode(org.w3c.dom.Node node,
                                     java.lang.String name,
                                     java.lang.String value)

Append a property node to the specified node.

Parameters:

node - The node to that the property node should be appended. It must be part of a document.

name - The name of the property node.

value - The value of the property node.

writePropertiesToDOM

public static void writePropertiesToDOM(java.lang.Object object,
                        org.w3c.dom.Document document,
                        FwkXmlDtdInterface dtd,
                        org.w3c.dom.Element node,
                        java.util.Map classProperties)

This method writes the properties of the given object to DOM.

Parameters:

object - The object that should be dumped to DOM.

document - The document object model.

dtd - The dtd descriptor.

node - The node of the object.

classProperties - Map the contains the writable properties. May be null.

readMapFromDOM

public static java.util.Map readMapFromDOM(java.util.Map map,
                           org.w3c.dom.Document document,
                           org.w3c.dom.Element node)

This method reads a map from the given node.

Parameters:

map - The map to be read.

document - The document object model.

node - The node of the object.

classProperties - Map the contains the writable properties. May be null.

readMapFromDOM

public static java.util.Map readMapFromDOM(org.w3c.dom.Document document,
                           org.w3c.dom.Element node)

This method reads a map from the given node.

Parameters:

document - The document object model.

node - The node of the object.

classProperties - Map the contains the writable properties. May be null.

writeMapToDOM

public static org.w3c.dom.Element writeMapToDOM(java.util.Map map,
                                org.w3c.dom.Document document,
                                FwkXmlDtdInterface dtd,
                                org.w3c.dom.Element node,
                                java.util.Map classProperties)

This method writes a map of the given object to DOM.

Parameters:

map - The map that should be dumped to DOM.

document - The document object model.

dtd - The dtd descriptor.

node - The node of the object.

classProperties - Map the contains the writable properties. May be null.

getCompany

public java.lang.String getCompany()

Get the company that is responsable for that handler.

Specified by:

getCompany in interface FwkDescriptionInterface

Specified by:

getCompany in interface FwkDOMHandlerInterface

Overrides:

getCompany in class FwkDescription

Returns:

the company.

See Also:

FwkDescription.setCompany(String)

writeToXML

public boolean writeToXML(java.lang.String filename,
                 boolean validate)

Write the handle to the given xml file.

Specified by:

writeToXML in interface FwkDOMHandlerInterface

Parameters:

filename - The name of the xml file.

validate - Write a validated cml file.

writeToXML

public static boolean writeToXML(FwkDescriptionInterface descriptor,
                 java.lang.String filename,
                 boolean validate)

Writes a descriptor to a XML file.

Parameters:

descriptor - The descriptor to be written.

filename - The name of the file to be written.

validate - Write a validate XML file.

writeToXML

public static boolean writeToXML(FwkDOMHandlerInterface handler,
                 java.lang.String filename,
                 java.lang.Class interpreter,
                 boolean validate)

Writes a DOM handler to a XML file.

Parameters:

handler - The object to be written.

filename - The name of the file to be written.

interpreters - The interpreter class.

validate - If true the DTD will be written.

writeToXML

public static boolean writeToXML(FwkDOMHandlerInterface handler,
                 java.lang.String filename,
                 java.lang.Class[] interpreters,
                 boolean validate)

Writes a dom handler to an XML file.

Parameters:

handler - The object to be written.

filename - The name of the file to be written.

interpreters - An Array containing the interpreters.

validate - If true the DTD will be written.

writeToXML

public static boolean writeToXML(FwkDOMHandlerInterface handler,
                 java.io.Writer writer,
                 java.lang.Class[] interpreters,
                 boolean validate)

Writes a dom handler to a writer.

Parameters:

handler - The object to be written.

writer - The writer.

interpreters - An Array containing the interpreters.

validate - If true the DTD will be written.

readFromXML

public static java.lang.Object readFromXML(FwkControllerInterface controller,
                           java.lang.String filename)
                                    throws FwkException

Read an xml file.

Parameters:

filename - The name of the file to be read.

Throws:

FwkException

readFromXML

public static java.lang.Object readFromXML(FwkControllerInterface controller,
                           java.io.InputStream is,
                           boolean validate)
                                    throws java.lang.Exception

Read a xml coming from an input stream.

Parameters:

controller - the controller the read object.

is - The input stream.

validate - If true the parser will validate the stream.

Throws:

java.lang.Exception