|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.jrefinery.report.io.ext.writer.AbstractXMLDefinitionWriter
A base class for writer classes for the JFreeReport XML report files.
Field Summary | |
static boolean |
CLOSE
A constant for close. |
protected static int |
CLOSE_TAG_DECREASE
A int constant for controling the indent function. |
protected static int |
INDENT_ONLY
A int constant for controling the indent function. |
static boolean |
OPEN
A constant for open. |
protected static int |
OPEN_TAG_INCREASE
A int constant for controling the indent function. |
Constructor Summary | |
AbstractXMLDefinitionWriter(ReportWriter reportWriter,
int indentLevel)
Creates a new writer. |
Method Summary | |
protected void |
decreaseIndent()
Decreates the indention by one level. |
protected int |
getIndentLevel()
Returns the current indent level. |
static java.lang.String |
getLineSeparator()
Returns the line separator. |
protected JFreeReport |
getReport()
Returns the report. |
protected ReportWriter |
getReportWriter()
Returns the report writer. |
static SafeTagList |
getSafeTags()
Returns the tags that can safely extend over several lines in the XML definition. |
protected void |
increaseIndent()
Increases the indention by one level. |
protected void |
indent(java.io.Writer writer,
int increase)
Indent the line. |
static java.lang.String |
normalize(java.lang.String s)
Normalises a string, replacing certain characters with their escape sequences so that the XML text is not corrupted. |
abstract void |
write(java.io.Writer writer)
Writes the report definition portion. |
protected void |
writeCloseTag(java.io.Writer w,
java.lang.String tag)
Writes a closing XML tag. |
protected void |
writeTag(java.io.Writer w,
java.lang.String name)
Writes an opening XML tag that has no attributes. |
protected void |
writeTag(java.io.Writer w,
java.lang.String name,
java.util.Properties attributes,
boolean close)
Writes an opening XML tag along with a list of attribute/value pairs. |
protected void |
writeTag(java.io.Writer w,
java.lang.String name,
java.lang.String attributeName,
java.lang.String attributeValue,
boolean close)
Writes an opening XML tag with an attribute/value pair. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
protected static final int OPEN_TAG_INCREASE
protected static final int CLOSE_TAG_DECREASE
protected static final int INDENT_ONLY
public static final boolean CLOSE
public static final boolean OPEN
Constructor Detail |
public AbstractXMLDefinitionWriter(ReportWriter reportWriter, int indentLevel)
reportWriter
- the report writer.indentLevel
- the current indention level.Method Detail |
public static SafeTagList getSafeTags()
public static java.lang.String getLineSeparator()
protected ReportWriter getReportWriter()
protected JFreeReport getReport()
protected void writeTag(java.io.Writer w, java.lang.String name) throws java.io.IOException
w
- the writer.name
- the tag name.
java.io.IOException
- if there is an I/O problem.protected void writeCloseTag(java.io.Writer w, java.lang.String tag) throws java.io.IOException
w
- the writer.tag
- the tag name.
java.io.IOException
- if there is an I/O problem.protected void writeTag(java.io.Writer w, java.lang.String name, java.lang.String attributeName, java.lang.String attributeValue, boolean close) throws java.io.IOException
w
- the writer.name
- the tag name.attributeName
- the attribute name.attributeValue
- the attribute value.close
- controls whether the tag is closed.
java.io.IOException
- if there is an I/O problem.protected void writeTag(java.io.Writer w, java.lang.String name, java.util.Properties attributes, boolean close) throws java.io.IOException
w
- the writer.name
- the tag name.attributes
- the attributes.close
- controls whether the tag is closed.
java.io.IOException
- if there is an I/O problem.public static java.lang.String normalize(java.lang.String s)
s
- the string.
protected void indent(java.io.Writer writer, int increase) throws java.io.IOException
writer
- the writer which should receive the indentention.increase
- the current indent level.
java.io.IOException
- if writing the stream failed.protected int getIndentLevel()
protected void increaseIndent()
protected void decreaseIndent()
public abstract void write(java.io.Writer writer) throws java.io.IOException, ReportWriterException
writer
- the writer.
java.io.IOException
- if there is an I/O problem.
ReportWriterException
- if the report serialisation failed.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |