|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.pentaho.reporting.libraries.xmlns.writer.XmlWriterSupport
public class XmlWriterSupport
A support class for writing XML files.
Field Summary | |
---|---|
static boolean |
CLOSE
A constant for close. |
static int |
CLOSE_TAG_DECREASE
A constant for controlling the indent function. |
static int |
INDENT_ONLY
A constant for controlling the indent function. |
static boolean |
OPEN
A constant for open. |
static int |
OPEN_TAG_INCREASE
A constant for controlling the indent function. |
Constructor Summary | |
---|---|
XmlWriterSupport()
Default Constructor. |
|
XmlWriterSupport(TagDescription safeTags,
java.lang.String indentString)
Creates a new support instance. |
|
XmlWriterSupport(TagDescription safeTags,
java.lang.String indentString,
java.lang.String lineseparator)
Create a new XmlWriterSupport instance. |
Method Summary | |
---|---|
void |
addImpliedNamespace(java.lang.String uri,
java.lang.String prefix)
Adds an implied namespace to the document. |
void |
copyNamespaces(XmlWriterSupport writerSupport)
Copies all currently declared namespaces of the given XmlWriterSupport instance as new implied namespaces into this instance. |
int |
getAdditionalIndent()
Returns the indent level that should be added to the automaticly computed indentation. |
int |
getCurrentIndentLevel()
Returns the current indention level. |
java.lang.String |
getLineSeparator()
Returns the line separator. |
java.util.Properties |
getNamespaces()
Returns all namespaces as properties-collection. |
TagDescription |
getTagDescription()
Returns the list of safe tags. |
void |
indent(java.io.Writer writer)
Indent the line. |
void |
indentForClose(java.io.Writer writer)
Indent the line. |
boolean |
isAlwaysAddNamespace()
Checks, whether the XML writer should always add a namespace prefix to the attributes. |
boolean |
isAssumeDefaultNamespace()
Checks, whether attributes of the same namespace as the current element should be written without a prefix. |
boolean |
isHtmlCompatiblityMode()
Checks, whether the HTML compatibility mode is enabled. |
boolean |
isLineEmpty()
Checks, whether the currently generated line of text is empty. |
boolean |
isNamespaceDefined(java.lang.String uri)
Checks, whether the given URI is defined as valid namespace. |
boolean |
isNamespacePrefixDefined(java.lang.String prefix)
Checks, whether the given namespace prefix is defined. |
boolean |
isWriteFinalLinebreak()
Checks, whether the written XML file should end with an empty line. |
static java.lang.String |
normalize(java.lang.String s,
boolean transformNewLine)
Normalises a string, replacing certain characters with their escape sequences so that the XML text is not corrupted. |
java.lang.String |
normalizeLocal(java.lang.String s,
boolean transformNewLine)
Normalizes the given string using a shared buffer. |
void |
setAdditionalIndent(int additionalIndent)
Defines the indent level that should be added to the automaticly computed indentation. |
void |
setAlwaysAddNamespace(boolean alwaysAddNamespace)
Defines, whether the XML writer should always add a namespace prefix to the attributes. |
void |
setAssumeDefaultNamespace(boolean assumeDefaultNamespace)
Defines, whether attributes of the same namespace as the current element should be written without a prefix. |
void |
setHtmlCompatiblityMode(boolean htmlCompatiblityMode)
Enables or disables the HTML Compatibility mode. |
void |
setLineEmpty(boolean lineEmpty)
A marker flag to track, wether the current line is empty. |
void |
setWriteFinalLinebreak(boolean writeFinalLinebreak)
Defines, whether the written XML file should end with an empty line. |
void |
writeCloseTag(java.io.Writer w)
Writes a closing XML tag. |
void |
writeComment(java.io.Writer writer,
java.lang.String comment)
Writes a comment into the generated xml file. |
void |
writeNewLine(java.io.Writer writer)
Writes a linebreak to the writer. |
void |
writeTag(java.io.Writer w,
java.lang.String namespaceUri,
java.lang.String name)
Writes an opening XML tag that has no attributes. |
void |
writeTag(java.io.Writer w,
java.lang.String namespaceUri,
java.lang.String name,
AttributeList attributes,
boolean close)
Writes an opening XML tag along with a list of attribute/value pairs. |
void |
writeTag(java.io.Writer w,
java.lang.String namespace,
java.lang.String name,
java.lang.String attributeName,
java.lang.String attributeValue,
boolean close)
Writes an opening XML tag with an attribute/value pair. |
void |
writeTextNormalized(java.io.Writer writer,
java.lang.String s,
boolean transformNewLine)
Normalizes the given string and writes the result directly to the stream. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final int OPEN_TAG_INCREASE
public static final int CLOSE_TAG_DECREASE
public static final int INDENT_ONLY
public static final boolean CLOSE
public static final boolean OPEN
Constructor Detail |
---|
public XmlWriterSupport()
public XmlWriterSupport(TagDescription safeTags, java.lang.String indentString)
safeTags
- the tags that are safe for line breaks.indentString
- the indent string.public XmlWriterSupport(TagDescription safeTags, java.lang.String indentString, java.lang.String lineseparator)
safeTags
- the tags that are safe for line breaks.indentString
- the indent string.lineseparator
- the lineseparator that should be used for writing XML files.Method Detail |
---|
public boolean isHtmlCompatiblityMode()
public void setHtmlCompatiblityMode(boolean htmlCompatiblityMode)
htmlCompatiblityMode
- true, if the HTML compatiblity mode is enabled, false otherwise.public boolean isAlwaysAddNamespace()
public void setAlwaysAddNamespace(boolean alwaysAddNamespace)
alwaysAddNamespace
- set to true, if all attributes should be qualified, false otherwise.public int getAdditionalIndent()
public void setAdditionalIndent(int additionalIndent)
additionalIndent
- the indent level.public java.lang.String getLineSeparator()
public void writeTag(java.io.Writer w, java.lang.String namespaceUri, java.lang.String name) throws java.io.IOException
w
- the writer.namespaceUri
- the namespace URI for the element.name
- the tag name.
java.io.IOException
- if there is an I/O problem.public void writeCloseTag(java.io.Writer w) throws java.io.IOException
w
- the writer.
java.io.IOException
- if there is an I/O problem.public void writeNewLine(java.io.Writer writer) throws java.io.IOException
writer
- the writer.
java.io.IOException
- if there is a problem writing to the character stream.public boolean isLineEmpty()
public void setLineEmpty(boolean lineEmpty)
lineEmpty
- defines, whether the current line should be treated as empty line.public void writeTag(java.io.Writer w, java.lang.String namespace, java.lang.String name, java.lang.String attributeName, java.lang.String attributeValue, boolean close) throws java.io.IOException
w
- the writer.namespace
- the namespace URI for the elementname
- 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.public void addImpliedNamespace(java.lang.String uri, java.lang.String prefix)
uri
- the uri of the namespace.prefix
- the defined prefix.public void copyNamespaces(XmlWriterSupport writerSupport)
writerSupport
- the Xml-writer from where to copy the declared namespaces.public boolean isNamespaceDefined(java.lang.String uri)
uri
- the uri of the namespace.
public boolean isNamespacePrefixDefined(java.lang.String prefix)
prefix
- the namespace prefix.
public java.util.Properties getNamespaces()
public void writeTag(java.io.Writer w, java.lang.String namespaceUri, java.lang.String name, AttributeList attributes, boolean close) throws java.io.IOException
w
- the writer.namespaceUri
- the namespace uri for the element (can be null).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 java.lang.String normalizeLocal(java.lang.String s, boolean transformNewLine)
s
- the string that should be XML-Encoded.transformNewLine
- a flag controling whether to transform newlines into character-entities.
public void writeTextNormalized(java.io.Writer writer, java.lang.String s, boolean transformNewLine) throws java.io.IOException
writer
- the writer that should receive the normalized content.s
- the string that should be XML-Encoded.transformNewLine
- a flag controling whether to transform newlines into character-entities.
java.io.IOException
- if writing to the stream failed.public static java.lang.String normalize(java.lang.String s, boolean transformNewLine)
s
- the string.transformNewLine
- true, if a newline in the string should be converted into a character entity.
public void indent(java.io.Writer writer) throws java.io.IOException
writer
- the writer which should receive the indentention.
java.io.IOException
- if writing the stream failed.public void indentForClose(java.io.Writer writer) throws java.io.IOException
writer
- the writer which should receive the indentention.
java.io.IOException
- if writing the stream failed.public TagDescription getTagDescription()
public void writeComment(java.io.Writer writer, java.lang.String comment) throws java.io.IOException
writer
- the writer.comment
- the comment text
java.io.IOException
- if there is a problem writing to the character stream.public boolean isAssumeDefaultNamespace()
public void setAssumeDefaultNamespace(boolean assumeDefaultNamespace)
assumeDefaultNamespace
- true, if attributes in the element's namespace should be written without a prefix,
false to write all attributes with a prefix.public int getCurrentIndentLevel()
public void setWriteFinalLinebreak(boolean writeFinalLinebreak)
writeFinalLinebreak
- true, if an linebreak should be added at the
end of the file, false otherwise.public boolean isWriteFinalLinebreak()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |