com.mindfusion.diagramming
Class XmlPersistContext

java.lang.Object
  com.mindfusion.diagramming.XmlPersistContext

public class XmlPersistContext
extends java.lang.Object

Contains methods that can help you serialize and deserialize MindFusion.Diagramming items to and from XML documents.

Constructor Summary

XmlPersistContext(Diagram diagram, org.w3c.dom.Document document)
Initializes a new instance of the XmlPersistContext class.

Method Summary

org.w3c.dom.Element	addChildElement(java.lang.String elementName, org.w3c.dom.Element parentElement) Adds a new child node with the specified name to the specified parent node.
org.w3c.dom.Element	addChildElement(java.lang.String elementName, org.w3c.dom.Element parentElement, java.lang.String innerText) Adds a new child node with the specified name and value to the specified parent node.
static java.lang.Class[]	getClasses(java.lang.String packageName) Returns a list with all classes in the package with the specified name.
int	getClassVersion()
Diagram	getDiagram()
boolean	getIncludeUnalteredProperties() Gets whether properties should be saved to XML when they have the default values.
org.w3c.dom.Document	getXmlDocument()
AnchorPattern	readAnchorPattern(java.lang.String elementName, org.w3c.dom.Element parentElement)
boolean	readBool(java.lang.String elementName, org.w3c.dom.Element parentElement)
boolean	readBool(java.lang.String elementName, org.w3c.dom.Element parentElement, boolean defaultValue)
Brush	readBrush(java.lang.String elementName, org.w3c.dom.Element parentElement)
byte	readByte(java.lang.String elementName, org.w3c.dom.Element parentElement)
char	readChar(java.lang.String elementName, org.w3c.dom.Element parentElement)
java.awt.Color	readColor(java.lang.String elementName, org.w3c.dom.Element parentElement)
java.awt.Color	readColor(java.lang.String elementName, org.w3c.dom.Element parentElement, java.awt.Color defaultValue)
double	readDouble(java.lang.String elementName, org.w3c.dom.Element parentElement)
int	readEnum(java.lang.String elementName, org.w3c.dom.Element parentElement)
int	readEnum(java.lang.String elementName, org.w3c.dom.Element parentElement, int defaultValue)
float	readFloat(java.lang.String elementName, org.w3c.dom.Element parentElement)
float	readFloat(java.lang.String elementName, org.w3c.dom.Element parentElement, float defaultValue)
float[]	readFloatArray(java.lang.String elementName, java.lang.String subElementName, org.w3c.dom.Element parentElement)
java.awt.Font	readFont(java.lang.String elementName, org.w3c.dom.Element parentElement, boolean convertToPoint)
Group	readGroup(java.lang.String elementName, org.w3c.dom.Element parentElement)
java.util.Hashtable<java.lang.Object,java.lang.Object>	readHashtable(java.lang.String elementName, org.w3c.dom.Element parentElement) Reads a hash or traits table object with the specified name.
java.awt.Image	readImage(java.lang.String elementName, org.w3c.dom.Element parentElement)
int	readInt(java.lang.String elementName, org.w3c.dom.Element parentElement)
int	readInt(java.lang.String elementName, org.w3c.dom.Element parentElement, int defaultValue)
DiagramItem	readItemReference(org.w3c.dom.Element itemElement) Reads an item reference from the specified element.
DiagramItem	readItemReference(java.lang.String elementName, org.w3c.dom.Element parentElement)
long	readLong(java.lang.String elementName, org.w3c.dom.Element parentElement)
NodeConstraints	readNodeConstraints(java.lang.String elementName, org.w3c.dom.Element parentElement)
java.lang.Object	readObject(java.lang.String elementName, org.w3c.dom.Element parentElement)
Pen	readPen(java.lang.String elementName, org.w3c.dom.Element parentElement)
PointList	readPointCollection(java.lang.String elementName, org.w3c.dom.Element parentElement)
java.awt.geom.Point2D.Float	readPointF(java.lang.String elementName, org.w3c.dom.Element parentElement)
java.awt.geom.Rectangle2D.Float	readRectangleF(java.lang.String elementName, org.w3c.dom.Element parentElement)
Shape	readShape(java.lang.String elementName, org.w3c.dom.Element parentElement)
short	readShort(java.lang.String elementName, org.w3c.dom.Element parentElement)
short	readShort(java.lang.String elementName, org.w3c.dom.Element parentElement, short defaultValue)
java.awt.geom.Dimension2D	readSizeF(java.lang.String elementName, org.w3c.dom.Element parentElement)
java.lang.String	readString(java.lang.String elementName, org.w3c.dom.Element parentElement)
java.lang.String	readString(java.lang.String elementName, org.w3c.dom.Element parentElement, java.lang.String defaultValue)
TextFormat	readStringFormat(java.lang.String elementName, org.w3c.dom.Element parentElement)
TextFormat	readStringFormat(java.lang.String elementName, org.w3c.dom.Element parentElement, TextFormat defaultValue)
java.lang.Object	readTag(java.lang.Object item, java.lang.String elementName, org.w3c.dom.Element parentElement)
void	setIncludeUnalteredProperties(boolean value) Sets whether properties should be saved to XML when they have the default values.
org.w3c.dom.Element	writeAnchorPattern(AnchorPattern anchorPattern, java.lang.String elementName, org.w3c.dom.Element parentElement) Writes the specified anchor pattern.
org.w3c.dom.Element	writeBool(boolean boolValue, java.lang.String elementName, org.w3c.dom.Element parentElement) Writes a boolean value with the specified name.
org.w3c.dom.Element	writeBrush(Brush brush, java.lang.String elementName, org.w3c.dom.Element parentElement)
org.w3c.dom.Element	writeByte(byte byteValue, java.lang.String elementName, org.w3c.dom.Element parentElement) Write a byte value with the specified name.
org.w3c.dom.Element	writeChar(char charValue, java.lang.String elementName, org.w3c.dom.Element parentElement) Write a char value with the specified name.
org.w3c.dom.Element	writeColor(java.awt.Color color, java.lang.String elementName, org.w3c.dom.Element parentElement)
org.w3c.dom.Element	writeDouble(double doubleValue, java.lang.String elementName, org.w3c.dom.Element parentElement) Writes a double value with the specified name.
org.w3c.dom.Element	writeEnum(int enumValue, java.lang.String elementName, org.w3c.dom.Element parentElement)
org.w3c.dom.Element	writeFloat(float floatValue, java.lang.String elementName, org.w3c.dom.Element parentElement) Writes a float value with the specified name.
org.w3c.dom.Element	writeFloatArray(float[] array, java.lang.String elementName, java.lang.String subElementName, org.w3c.dom.Element parentElement)
org.w3c.dom.Element	writeFont(java.awt.Font font, java.lang.String elementName, org.w3c.dom.Element parentElement)
org.w3c.dom.Element	writeGroup(Group group, java.lang.String elementName, org.w3c.dom.Element parentElement)
org.w3c.dom.Element	writeImage(java.awt.Image image, java.lang.String elementName, org.w3c.dom.Element parentElement)
org.w3c.dom.Element	writeInt(int intValue, java.lang.String elementName, org.w3c.dom.Element parentElement) Writes an integer value with the specified name.
org.w3c.dom.Element	writeItemReference(DiagramItem item, java.lang.String elementName, org.w3c.dom.Element parentElement) Writes a reference to the specified item with the specified name.
org.w3c.dom.Element	writeLong(long longValue, java.lang.String elementName, org.w3c.dom.Element parentElement) Writes a long value with the specified name.
org.w3c.dom.Element	writeNodeConstraints(NodeConstraints nodeConstraints, java.lang.String elementName, org.w3c.dom.Element parentElement) Writes the specified NodeConstraints object.
org.w3c.dom.Element	writePen(Pen pen, java.lang.String elementName, org.w3c.dom.Element parentElement)
org.w3c.dom.Element	writePointCollection(PointList points, java.lang.String elementName, org.w3c.dom.Element parentElement)
org.w3c.dom.Element	writePointF(java.awt.geom.Point2D point, java.lang.String elementName, org.w3c.dom.Element parentElement) Writes a Point2D with the specified name.
org.w3c.dom.Element	writeRectangleF(java.awt.geom.Rectangle2D rectangle, java.lang.String elementName, org.w3c.dom.Element parentElement) Writes a Rectangle2D with the specified name.
org.w3c.dom.Element	writeShape(Shape shape, java.lang.String elementName, org.w3c.dom.Element parentElement) Writes the specified shape with the specified name.
org.w3c.dom.Element	writeShort(short shortValue, java.lang.String elementName, org.w3c.dom.Element parentElement) Writes a short value with the specified name.
org.w3c.dom.Element	writeSizeF(java.awt.geom.Dimension2D size, java.lang.String elementName, org.w3c.dom.Element parentElement) Writes a Dimension2D with the specified name.
org.w3c.dom.Element	writeString(java.lang.String stringValue, java.lang.String elementName, org.w3c.dom.Element parentElement) Writes a string value with the specified name.
org.w3c.dom.Element	writeStringFormat(TextFormat stringFormat, java.lang.String elementName, org.w3c.dom.Element parentElement)
org.w3c.dom.Element	writeTag(java.lang.Object item, java.lang.Object tagValue, java.lang.String elementName, org.w3c.dom.Element parentElement)
org.w3c.dom.Element	writeTraits(java.util.Hashtable<java.lang.Object,java.lang.Object> traits, java.lang.String elementName, org.w3c.dom.Element parentElement)

Methods inherited from class java.lang.Object

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

Constructor Detail

XmlPersistContext

public XmlPersistContext(Diagram diagram,
                         org.w3c.dom.Document document)

Initializes a new instance of the XmlPersistContext class.

Parameters:

diagram - The Diagram this class will operate on.

document - The Xml Document to serializeto / deserialize from.

Method Detail

addChildElement

public org.w3c.dom.Element addChildElement(java.lang.String elementName,
                                           org.w3c.dom.Element parentElement)

Adds a new child node with the specified name to the specified parent node.

addChildElement

public org.w3c.dom.Element addChildElement(java.lang.String elementName,
                                           org.w3c.dom.Element parentElement,
                                           java.lang.String innerText)

Adds a new child node with the specified name and value to the specified parent node.

writeString

public org.w3c.dom.Element writeString(java.lang.String stringValue,
                                       java.lang.String elementName,
                                       org.w3c.dom.Element parentElement)

Writes a string value with the specified name.

writeBool

public org.w3c.dom.Element writeBool(boolean boolValue,
                                     java.lang.String elementName,
                                     org.w3c.dom.Element parentElement)

Writes a boolean value with the specified name.

writeChar

public org.w3c.dom.Element writeChar(char charValue,
                                     java.lang.String elementName,
                                     org.w3c.dom.Element parentElement)

Write a char value with the specified name.

writeByte

public org.w3c.dom.Element writeByte(byte byteValue,
                                     java.lang.String elementName,
                                     org.w3c.dom.Element parentElement)

Write a byte value with the specified name.

writeInt

public org.w3c.dom.Element writeInt(int intValue,
                                    java.lang.String elementName,
                                    org.w3c.dom.Element parentElement)

Writes an integer value with the specified name.

Returns:

writeShort

public org.w3c.dom.Element writeShort(short shortValue,
                                      java.lang.String elementName,
                                      org.w3c.dom.Element parentElement)

Writes a short value with the specified name.

writeLong

public org.w3c.dom.Element writeLong(long longValue,
                                     java.lang.String elementName,
                                     org.w3c.dom.Element parentElement)

Writes a long value with the specified name.

writeFloat

public org.w3c.dom.Element writeFloat(float floatValue,
                                      java.lang.String elementName,
                                      org.w3c.dom.Element parentElement)

Writes a float value with the specified name.

writeDouble

public org.w3c.dom.Element writeDouble(double doubleValue,
                                       java.lang.String elementName,
                                       org.w3c.dom.Element parentElement)

Writes a double value with the specified name.

writeRectangleF

public org.w3c.dom.Element writeRectangleF(java.awt.geom.Rectangle2D rectangle,
                                           java.lang.String elementName,
                                           org.w3c.dom.Element parentElement)

Writes a Rectangle2D with the specified name.

writePointF

public org.w3c.dom.Element writePointF(java.awt.geom.Point2D point,
                                       java.lang.String elementName,
                                       org.w3c.dom.Element parentElement)

Writes a Point2D with the specified name.

writeSizeF

public org.w3c.dom.Element writeSizeF(java.awt.geom.Dimension2D size,
                                      java.lang.String elementName,
                                      org.w3c.dom.Element parentElement)

Writes a Dimension2D with the specified name.

writeAnchorPattern

public org.w3c.dom.Element writeAnchorPattern(AnchorPattern anchorPattern,
                                              java.lang.String elementName,
                                              org.w3c.dom.Element parentElement)

Writes the specified anchor pattern.

writeNodeConstraints

public org.w3c.dom.Element writeNodeConstraints(NodeConstraints nodeConstraints,
                                                java.lang.String elementName,
                                                org.w3c.dom.Element parentElement)

Writes the specified NodeConstraints object.

writeShape

public org.w3c.dom.Element writeShape(Shape shape,
                                      java.lang.String elementName,
                                      org.w3c.dom.Element parentElement)

Writes the specified shape with the specified name.

writeItemReference

public org.w3c.dom.Element writeItemReference(DiagramItem item,
                                              java.lang.String elementName,
                                              org.w3c.dom.Element parentElement)

Writes a reference to the specified item with the specified name.

writePointCollection

public org.w3c.dom.Element writePointCollection(PointList points,
                                                java.lang.String elementName,
                                                org.w3c.dom.Element parentElement)

writeBrush

public org.w3c.dom.Element writeBrush(Brush brush,
                                      java.lang.String elementName,
                                      org.w3c.dom.Element parentElement)

writeFloatArray

public org.w3c.dom.Element writeFloatArray(float[] array,
                                           java.lang.String elementName,
                                           java.lang.String subElementName,
                                           org.w3c.dom.Element parentElement)

writeColor

public org.w3c.dom.Element writeColor(java.awt.Color color,
                                      java.lang.String elementName,
                                      org.w3c.dom.Element parentElement)

writeStringFormat

public org.w3c.dom.Element writeStringFormat(TextFormat stringFormat,
                                             java.lang.String elementName,
                                             org.w3c.dom.Element parentElement)

writeGroup

public org.w3c.dom.Element writeGroup(Group group,
                                      java.lang.String elementName,
                                      org.w3c.dom.Element parentElement)

writeTraits

public org.w3c.dom.Element writeTraits(java.util.Hashtable<java.lang.Object,java.lang.Object> traits,
                                       java.lang.String elementName,
                                       org.w3c.dom.Element parentElement)

writePen

public org.w3c.dom.Element writePen(Pen pen,
                                    java.lang.String elementName,
                                    org.w3c.dom.Element parentElement)

writeFont

public org.w3c.dom.Element writeFont(java.awt.Font font,
                                     java.lang.String elementName,
                                     org.w3c.dom.Element parentElement)

writeEnum

public org.w3c.dom.Element writeEnum(int enumValue,
                                     java.lang.String elementName,
                                     org.w3c.dom.Element parentElement)

writeImage

public org.w3c.dom.Element writeImage(java.awt.Image image,
                                      java.lang.String elementName,
                                      org.w3c.dom.Element parentElement)

writeTag

public org.w3c.dom.Element writeTag(java.lang.Object item,
                                    java.lang.Object tagValue,
                                    java.lang.String elementName,
                                    org.w3c.dom.Element parentElement)

readString

public java.lang.String readString(java.lang.String elementName,
                                   org.w3c.dom.Element parentElement)
                            throws javax.xml.transform.TransformerException

Throws:

javax.xml.transform.TransformerException

readString

public java.lang.String readString(java.lang.String elementName,
                                   org.w3c.dom.Element parentElement,
                                   java.lang.String defaultValue)
                            throws javax.xml.transform.TransformerException

Throws:

javax.xml.transform.TransformerException

readBool

public boolean readBool(java.lang.String elementName,
                        org.w3c.dom.Element parentElement)
                 throws javax.xml.transform.TransformerException

Throws:

javax.xml.transform.TransformerException

readBool

public boolean readBool(java.lang.String elementName,
                        org.w3c.dom.Element parentElement,
                        boolean defaultValue)
                 throws javax.xml.transform.TransformerException

Throws:

javax.xml.transform.TransformerException

readByte

public byte readByte(java.lang.String elementName,
                     org.w3c.dom.Element parentElement)
              throws javax.xml.transform.TransformerException

Throws:

javax.xml.transform.TransformerException

readChar

public char readChar(java.lang.String elementName,
                     org.w3c.dom.Element parentElement)
              throws javax.xml.transform.TransformerException

Throws:

javax.xml.transform.TransformerException

readInt

public int readInt(java.lang.String elementName,
                   org.w3c.dom.Element parentElement)
            throws javax.xml.transform.TransformerException

Throws:

javax.xml.transform.TransformerException

readInt

public int readInt(java.lang.String elementName,
                   org.w3c.dom.Element parentElement,
                   int defaultValue)
            throws javax.xml.transform.TransformerException

Throws:

javax.xml.transform.TransformerException

readShort

public short readShort(java.lang.String elementName,
                       org.w3c.dom.Element parentElement)
                throws javax.xml.transform.TransformerException

Throws:

javax.xml.transform.TransformerException

readShort

public short readShort(java.lang.String elementName,
                       org.w3c.dom.Element parentElement,
                       short defaultValue)
                throws javax.xml.transform.TransformerException

Throws:

javax.xml.transform.TransformerException

readLong

public long readLong(java.lang.String elementName,
                     org.w3c.dom.Element parentElement)
              throws javax.xml.transform.TransformerException

Throws:

javax.xml.transform.TransformerException

readItemReference

public DiagramItem readItemReference(org.w3c.dom.Element itemElement)

Reads an item reference from the specified element.

readPointCollection

public PointList readPointCollection(java.lang.String elementName,
                                     org.w3c.dom.Element parentElement)
                              throws javax.xml.transform.TransformerException

Throws:

javax.xml.transform.TransformerException

readBrush

public Brush readBrush(java.lang.String elementName,
                       org.w3c.dom.Element parentElement)
                throws javax.xml.transform.TransformerException

Throws:

javax.xml.transform.TransformerException

readFloatArray

public float[] readFloatArray(java.lang.String elementName,
                              java.lang.String subElementName,
                              org.w3c.dom.Element parentElement)
                       throws javax.xml.transform.TransformerException

Throws:

javax.xml.transform.TransformerException

readFloat

public float readFloat(java.lang.String elementName,
                       org.w3c.dom.Element parentElement)
                throws javax.xml.transform.TransformerException

Throws:

javax.xml.transform.TransformerException

readFloat

public float readFloat(java.lang.String elementName,
                       org.w3c.dom.Element parentElement,
                       float defaultValue)
                throws javax.xml.transform.TransformerException

Throws:

javax.xml.transform.TransformerException

readDouble

public double readDouble(java.lang.String elementName,
                         org.w3c.dom.Element parentElement)
                  throws javax.xml.transform.TransformerException

Throws:

javax.xml.transform.TransformerException

readRectangleF

public java.awt.geom.Rectangle2D.Float readRectangleF(java.lang.String elementName,
                                                      org.w3c.dom.Element parentElement)
                                               throws javax.xml.transform.TransformerException

Throws:

javax.xml.transform.TransformerException

readPointF

public java.awt.geom.Point2D.Float readPointF(java.lang.String elementName,
                                              org.w3c.dom.Element parentElement)
                                       throws javax.xml.transform.TransformerException

Throws:

javax.xml.transform.TransformerException

readSizeF

public java.awt.geom.Dimension2D readSizeF(java.lang.String elementName,
                                           org.w3c.dom.Element parentElement)
                                    throws javax.xml.transform.TransformerException

Throws:

javax.xml.transform.TransformerException

readAnchorPattern

public AnchorPattern readAnchorPattern(java.lang.String elementName,
                                       org.w3c.dom.Element parentElement)
                                throws javax.xml.transform.TransformerException

Throws:

javax.xml.transform.TransformerException

readNodeConstraints

public NodeConstraints readNodeConstraints(java.lang.String elementName,
                                           org.w3c.dom.Element parentElement)
                                    throws javax.xml.transform.TransformerException

Throws:

javax.xml.transform.TransformerException

readShape

public Shape readShape(java.lang.String elementName,
                       org.w3c.dom.Element parentElement)
                throws javax.xml.transform.TransformerException

Throws:

javax.xml.transform.TransformerException

readItemReference

public DiagramItem readItemReference(java.lang.String elementName,
                                     org.w3c.dom.Element parentElement)
                              throws javax.xml.transform.TransformerException

Throws:

javax.xml.transform.TransformerException

readColor

public java.awt.Color readColor(java.lang.String elementName,
                                org.w3c.dom.Element parentElement)
                         throws javax.xml.transform.TransformerException

Throws:

javax.xml.transform.TransformerException

readColor

public java.awt.Color readColor(java.lang.String elementName,
                                org.w3c.dom.Element parentElement,
                                java.awt.Color defaultValue)
                         throws javax.xml.transform.TransformerException

Throws:

javax.xml.transform.TransformerException

readStringFormat

public TextFormat readStringFormat(java.lang.String elementName,
                                   org.w3c.dom.Element parentElement)
                            throws javax.xml.transform.TransformerException

Throws:

javax.xml.transform.TransformerException

readStringFormat

public TextFormat readStringFormat(java.lang.String elementName,
                                   org.w3c.dom.Element parentElement,
                                   TextFormat defaultValue)
                            throws javax.xml.transform.TransformerException

Throws:

javax.xml.transform.TransformerException

readGroup

public Group readGroup(java.lang.String elementName,
                       org.w3c.dom.Element parentElement)
                throws javax.xml.transform.TransformerException

Throws:

javax.xml.transform.TransformerException

readPen

public Pen readPen(java.lang.String elementName,
                   org.w3c.dom.Element parentElement)
            throws javax.xml.transform.TransformerException

Throws:

javax.xml.transform.TransformerException

readFont

public java.awt.Font readFont(java.lang.String elementName,
                              org.w3c.dom.Element parentElement,
                              boolean convertToPoint)
                       throws javax.xml.transform.TransformerException

Throws:

javax.xml.transform.TransformerException

readEnum

public int readEnum(java.lang.String elementName,
                    org.w3c.dom.Element parentElement)
             throws javax.xml.transform.TransformerException

Throws:

javax.xml.transform.TransformerException

readEnum

public int readEnum(java.lang.String elementName,
                    org.w3c.dom.Element parentElement,
                    int defaultValue)
             throws javax.xml.transform.TransformerException

Throws:

javax.xml.transform.TransformerException

readImage

public java.awt.Image readImage(java.lang.String elementName,
                                org.w3c.dom.Element parentElement)
                         throws javax.xml.transform.TransformerException

Throws:

javax.xml.transform.TransformerException

readHashtable

public java.util.Hashtable<java.lang.Object,java.lang.Object> readHashtable(java.lang.String elementName,
                                                                            org.w3c.dom.Element parentElement)
                                                                     throws javax.xml.transform.TransformerException

Reads a hash or traits table object with the specified name.

Throws:

javax.xml.transform.TransformerException

getClasses

public static java.lang.Class[] getClasses(java.lang.String packageName)
                                    throws java.lang.ClassNotFoundException

Returns a list with all classes in the package with the specified name.

Throws:

java.lang.ClassNotFoundException

readObject

public java.lang.Object readObject(java.lang.String elementName,
                                   org.w3c.dom.Element parentElement)
                            throws javax.xml.transform.TransformerException

Throws:

javax.xml.transform.TransformerException

readTag

public java.lang.Object readTag(java.lang.Object item,
                                java.lang.String elementName,
                                org.w3c.dom.Element parentElement)
                         throws javax.xml.transform.TransformerException

Throws:

javax.xml.transform.TransformerException

getDiagram

public Diagram getDiagram()

getXmlDocument

public org.w3c.dom.Document getXmlDocument()

getClassVersion

public int getClassVersion()

setIncludeUnalteredProperties

public void setIncludeUnalteredProperties(boolean value)

Sets whether properties should be saved to XML when they have the default values.

Parameters:

value - true to save all properties; false to save only altered properties

getIncludeUnalteredProperties

public boolean getIncludeUnalteredProperties()

Gets whether properties should be saved to XML when they have the default values.

Returns:

true if all properties should be saved; false if only the altered ones should be saved