Module org.jhotdraw8.draw

Package org.jhotdraw8.draw.io

Class SimpleXmlWriter

java.lang.Object

org.jhotdraw8.draw.io.SimpleXmlWriter

All Implemented Interfaces:

ClipboardOutputFormat, OutputFormat

public class SimpleXmlWriter
extends Object
implements OutputFormat, ClipboardOutputFormat

SimpleXmlWriter.

Represents each Figure by an element, and each figure property by an attribute.

All attribute values are treated as value types, except if an attribute type is an instance of Figure.

This writer only works for drawings which can be described entirely by the properties of its figures.

Attempts to preserve comments in the XML file, by associating them to the figures and to the drawing.

Does not preserve whitespace in the XML file.

Author:

Werner Randelshofer

Field Summary

Fields

Modifier and Type	Field	Description
protected FigureFactory	figureFactory
protected final org.jhotdraw8.base.converter.IdFactory	idFactory
static final NonNullObjectKey<Integer>	INDENT_AMOUNT	Specifies the number of characters that should be used for indentation.
protected final String	namespaceQualifier
protected String	namespaceURI

Constructor Summary

Constructors

Constructor	Description
SimpleXmlWriter(FigureFactory factory, org.jhotdraw8.base.converter.IdFactory idFactory)
SimpleXmlWriter(FigureFactory factory, org.jhotdraw8.base.converter.IdFactory idFactory, String namespaceURI, String namespaceQualifier)

Method Summary

Modifier and Type	Method	Description
@NonNull ImmutableMap<Key<?>,Object>	getOptions()
boolean	isNamespaceAware()
void	setFigureFactory(FigureFactory figureFactory)
void	setNamespaceURI(String namespaceURI)
void	setOptions(@NonNull ImmutableMap<Key<?>,Object> newValue)
Document	toDocument(@Nullable URI documentHome, @NonNull Drawing internal)
Document	toDocument(@Nullable URI documentHome, @NonNull Drawing internal, @NonNull Collection<Figure> selection)
void	write(@NonNull OutputStream out, @Nullable URI documentHome, @NonNull Drawing drawing, @NonNull WorkState<Void> workState)	Writes a Drawing into an output stream.
protected void	write(@Nullable URI documentHome, @NonNull Writer out, @NonNull Drawing drawing, @NonNull WorkState<Void> workState)
void	write(@NonNull Map<javafx.scene.input.DataFormat,Object> out, Drawing drawing, Collection<Figure> selection)	Writes a selection of figures from a Drawing into a clipboard
protected void	writeClipping(@NonNull XMLStreamWriter w, @NonNull Drawing internal, @NonNull Collection<Figure> selection, @Nullable URI documentHome)
protected void	writeDocument(@NonNull XMLStreamWriter w, @Nullable URI documentHome, @NonNull Drawing internal)
protected void	writeElementAttributes(@NonNull XMLStreamWriter w, @NonNull Figure figure)
protected void	writeNodeRecursively(@NonNull XMLStreamWriter w, @NonNull Figure figure, int depth)
protected void	writeProcessingInstructions(@NonNull XMLStreamWriter w, @NonNull Drawing external)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jhotdraw8.draw.input.ClipboardOutputFormat

write

Methods inherited from interface org.jhotdraw8.draw.io.OutputFormat

write, write

Field Details

figureFactory

protected FigureFactory figureFactory

idFactory

protected final org.jhotdraw8.base.converter.IdFactory idFactory

namespaceQualifier

protected final String namespaceQualifier

namespaceURI

protected String namespaceURI

INDENT_AMOUNT

public static final NonNullObjectKey<Integer> INDENT_AMOUNT

Specifies the number of characters that should be used for indentation.

Constructor Details

SimpleXmlWriter

public SimpleXmlWriter(FigureFactory factory,
 org.jhotdraw8.base.converter.IdFactory idFactory)

SimpleXmlWriter

public SimpleXmlWriter(FigureFactory factory,
 org.jhotdraw8.base.converter.IdFactory idFactory,
 String namespaceURI,
 String namespaceQualifier)

Method Details

isNamespaceAware

public boolean isNamespaceAware()

setFigureFactory

public void setFigureFactory(FigureFactory figureFactory)

setNamespaceURI

public void setNamespaceURI(String namespaceURI)

toDocument

public Document toDocument(@Nullable URI documentHome,
 @NonNull Drawing internal,
 @NonNull Collection<Figure> selection)
                    throws IOException

Throws:

IOException

toDocument

public Document toDocument(@Nullable URI documentHome,
 @NonNull Drawing internal)
                    throws IOException

Throws:

IOException

setOptions

public void setOptions(@NonNull ImmutableMap<Key<?>,Object> newValue)

Specified by:

setOptions in interface OutputFormat

getOptions

public @NonNull ImmutableMap<Key<?>,Object> getOptions()

Specified by:

getOptions in interface OutputFormat

write

public void write(@NonNull OutputStream out,
 @Nullable URI documentHome,
 @NonNull Drawing drawing,
 @NonNull WorkState<Void> workState)
           throws IOException

Description copied from interface: OutputFormat

Writes a Drawing into an output stream.

Specified by:

write in interface OutputFormat

Parameters:

out - The output stream.

documentHome - Document home URI for creating relative URIs in the document if this URI is null, all URIs in the document will be absolute

drawing - The drawing.

workState - for progress monitoring and cancelling the operation

Throws:

IOException - if an IO error occurs

write

protected void write(@Nullable URI documentHome,
 @NonNull Writer out,
 @NonNull Drawing drawing,
 @NonNull WorkState<Void> workState)
              throws IOException

Throws:

IOException

write

public void write(@NonNull Map<javafx.scene.input.DataFormat,Object> out,
 Drawing drawing,
 Collection<Figure> selection)
           throws IOException

Description copied from interface: ClipboardOutputFormat

Writes a selection of figures from a Drawing into a clipboard

Specified by:

write in interface ClipboardOutputFormat

Parameters:

out - The clipboard

drawing - The drawing.

selection - A selection

Throws:

IOException - if an IO error occurs

writeClipping

protected void writeClipping(@NonNull XMLStreamWriter w,
 @NonNull Drawing internal,
 @NonNull Collection<Figure> selection,
 @Nullable URI documentHome)
                      throws IOException,
XMLStreamException

Throws:

IOException

XMLStreamException

writeDocument

protected void writeDocument(@NonNull XMLStreamWriter w,
 @Nullable URI documentHome,
 @NonNull Drawing internal)
                      throws XMLStreamException

Throws:

XMLStreamException

writeElementAttributes

protected void writeElementAttributes(@NonNull XMLStreamWriter w,
 @NonNull Figure figure)
                               throws IOException,
XMLStreamException

Throws:

IOException

XMLStreamException

writeNodeRecursively

protected void writeNodeRecursively(@NonNull XMLStreamWriter w,
 @NonNull Figure figure,
 int depth)
                             throws IOException

Throws:

IOException

writeProcessingInstructions

protected void writeProcessingInstructions(@NonNull XMLStreamWriter w,
 @NonNull Drawing external)
                                    throws XMLStreamException

Throws:

XMLStreamException