org.jfree.xml.generator

Class ModelWriter

Known Direct Subclasses:
SplittingModelWriter

public class ModelWriter
extends java.lang.Object

A model writer.

Constructor Summary

ModelWriter()
Creates a new model writer instance.

Method Summary

DescriptionModel
getModel()
Returns the model.
static SafeTagList
getSafeTags()
Returns the safe tag list.
XMLWriterSupport
getWriterSupport()
Returns the writer support object.
void
setModel(DescriptionModel model)
Sets the model to be written.
void
write(Writer writer)
Writes a model to the specified writer.
protected void
writeClassDescription(Writer writer, ClassDescription cd)
Writes a class description.
protected void
writeCloseComment(Writer writer, Comments comments)
Writes the close comments from a set of comments.
protected void
writeComment(Writer writer, String[] comments)
Writes a sequence of comments.
protected void
writeManualMapping(Writer writer, ManualMappingInfo mi)
Writes a manual mapping to the XML output.
protected void
writeMultiplexMapping(Writer writer, MultiplexMappingInfo mi)
Writes a multiplex mapping to the XML output.
protected void
writeOpenComment(Writer writer, Comments comments)
Writes the open comments from a set of comments.
protected void
writeStandardComment(Writer writer, Comments comments)
Writes a set of comments.
protected void
writeTag(Writer writer, String tagName, String attribute, String value, Comments comments)
Writes a closed (short) tag with eventually nested comments.
protected void
writeTag(Writer writer, String tagName, AttributeList attributes, Comments comments)
Writes a closed (short) tag with eventually nested comments.
static void
writeXMLHeader(Writer writer)
Writes an XML header.

Constructor Details

ModelWriter

public ModelWriter()
Creates a new model writer instance.

Method Details

getModel

public DescriptionModel getModel()
Returns the model.
Returns:
The model.

getSafeTags

public static SafeTagList getSafeTags()
Returns the safe tag list.
Returns:
The safe tag list.

getWriterSupport

public XMLWriterSupport getWriterSupport()
Returns the writer support object.
Returns:
The writer support object.

setModel

public void setModel(DescriptionModel model)
Sets the model to be written.
Parameters:
model - the model.

write

public void write(Writer writer)
            throws IOException
Writes a model to the specified writer.
Parameters:
writer - the writer.

writeClassDescription

protected void writeClassDescription(Writer writer,
                                     ClassDescription cd)
            throws IOException
Writes a class description.
Parameters:
writer - the writer.
cd - the class description.

writeCloseComment

protected void writeCloseComment(Writer writer,
                                 Comments comments)
            throws IOException
Writes the close comments from a set of comments.
Parameters:
writer - the writer.
comments - the set of comments.

writeComment

protected void writeComment(Writer writer,
                            String[] comments)
            throws IOException
Writes a sequence of comments.
Parameters:
writer - the writer.
comments - the comments (null ignored).

writeManualMapping

protected void writeManualMapping(Writer writer,
                                  ManualMappingInfo mi)
            throws IOException
Writes a manual mapping to the XML output.
Parameters:
writer - the writer.
mi - the mapping info.

writeMultiplexMapping

protected void writeMultiplexMapping(Writer writer,
                                     MultiplexMappingInfo mi)
            throws IOException
Writes a multiplex mapping to the XML output.
Parameters:
writer - the writer.
mi - the mapping info.

writeOpenComment

protected void writeOpenComment(Writer writer,
                                Comments comments)
            throws IOException
Writes the open comments from a set of comments.
Parameters:
writer - the writer.
comments - the set of comments.

writeStandardComment

protected void writeStandardComment(Writer writer,
                                    Comments comments)
            throws IOException
Writes a set of comments.
Parameters:
writer - the writer.
comments - a set of comments.

writeTag

protected void writeTag(Writer writer,
                        String tagName,
                        String attribute,
                        String value,
                        Comments comments)
            throws IOException
Writes a closed (short) tag with eventually nested comments.
Parameters:
writer - the writer.
tagName - the tag name.
attribute - the attribute name.
value - the attribute value.
comments - the comments.

writeTag

protected void writeTag(Writer writer,
                        String tagName,
                        AttributeList attributes,
                        Comments comments)
            throws IOException
Writes a closed (short) tag with eventually nested comments.
Parameters:
writer - the writer.
tagName - the tag name.
attributes - the attributes.
comments - the comments.

writeXMLHeader

public static void writeXMLHeader(Writer writer)
            throws IOException
Writes an XML header.
Parameters:
writer - the writer.