org.pentaho.reporting.libraries.xmlns.writer
public class XmlWriterSupport extends Object
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, String indentString)
Creates a new support instance.
| |
XmlWriterSupport(TagDescription safeTags, String indentString, String lineseparator)
Create a new XmlWriterSupport instance.
|
Method Summary | |
---|---|
void | addImpliedNamespace(String uri, String prefix)
Adds an implied namespace to the document. |
protected DeclaredNamespaces | computeNamespaces()
Computes the current collection of defined namespaces.
|
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.
|
String | getLineSeparator()
Returns the line separator.
|
Properties | getNamespaces()
Returns all namespaces as properties-collection. |
TagDescription | getTagDescription()
Returns the list of safe tags.
|
void | indent(Writer writer)
Indent the line. |
void | indentForClose(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(String uri)
Checks, whether the given URI is defined as valid namespace.
|
boolean | isNamespacePrefixDefined(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 String | normalize(String s, boolean transformNewLine)
Normalises a string, replacing certain characters with their escape sequences so that the XML text is not
corrupted.
|
String | normalizeLocal(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(Writer w)
Writes a closing XML tag.
|
void | writeComment(Writer writer, String comment)
Writes a comment into the generated xml file.
|
void | writeNewLine(Writer writer)
Writes a linebreak to the writer.
|
void | writeTag(Writer w, String namespaceUri, String name)
Writes an opening XML tag that has no attributes.
|
void | writeTag(Writer w, String namespace, String name, String attributeName, String attributeValue, boolean close)
Writes an opening XML tag with an attribute/value pair.
|
void | writeTag(Writer w, String namespaceUri, String name, AttributeList attributes, boolean close)
Writes an opening XML tag along with a list of attribute/value pairs.
|
void | writeTextNormalized(Writer writer, String s, boolean transformNewLine)
Normalizes the given string and writes the result directly to the stream.
|
Parameters: safeTags the tags that are safe for line breaks. indentString the indent string.
Parameters: safeTags the tags that are safe for line breaks. indentString the indent string. lineseparator the lineseparator that should be used for writing XML files.
Parameters: uri the uri of the namespace. prefix the defined prefix.
Returns: the namespaces declared at this writing position.
Parameters: writerSupport the Xml-writer from where to copy the declared namespaces.
Returns: the indent level.
Returns: the indention level.
Returns: the line separator.
Returns: the defined namespaces.
Returns: The list.
Parameters: writer the writer which should receive the indentention.
Throws: java.io.IOException if writing the stream failed.
Parameters: writer the writer which should receive the indentention.
Throws: java.io.IOException if writing the stream failed.
Returns: true, if all attributes should be qualified, false otherwise.
Returns: true, if attributes in the element's namespace should be written without a prefix, false to write all attributes with a prefix.
Returns: true, if the HTML compatiblity mode is enabled, false otherwise.
Returns: true, if the line is empty, false otherwise.
Parameters: uri the uri of the namespace.
Returns: true, if there's a namespace defined, false otherwise.
Parameters: prefix the namespace prefix.
Returns: true, if the prefix is defined, false otherwise.
Returns: true, if an linebreak should be added at the end of the file, false otherwise.
Parameters: s the string. transformNewLine true, if a newline in the string should be converted into a character entity.
Returns: the normalised string.
Parameters: s the string that should be XML-Encoded. transformNewLine a flag controling whether to transform newlines into character-entities.
Returns: the transformed string.
Parameters: additionalIndent the indent level.
Parameters: alwaysAddNamespace set to true, if all attributes should be qualified, false otherwise.
Parameters: assumeDefaultNamespace true, if attributes in the element's namespace should be written without a prefix, false to write all attributes with a prefix.
Parameters: htmlCompatiblityMode true, if the HTML compatiblity mode is enabled, false otherwise.
Parameters: lineEmpty defines, whether the current line should be treated as empty line.
Parameters: writeFinalLinebreak true, if an linebreak should be added at the end of the file, false otherwise.
Parameters: w the writer.
Throws: java.io.IOException if there is an I/O problem.
Parameters: writer the writer. comment the comment text
Throws: IOException if there is a problem writing to the character stream.
Parameters: writer the writer.
Throws: IOException if there is a problem writing to the character stream.
Parameters: w the writer. namespaceUri the namespace URI for the element. name the tag name.
Throws: java.io.IOException if there is an I/O problem.
Parameters: w the writer. namespace the namespace URI for the element name the tag name. attributeName the attribute name. attributeValue the attribute value. close controls whether the tag is closed.
Throws: java.io.IOException if there is an I/O problem.
Parameters: 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.
Throws: java.io.IOException if there is an I/O problem.
Parameters: 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.
Throws: IOException if writing to the stream failed.