org.mmbase.util.transformers
Class XmlField

java.lang.Object
  |
  +--org.mmbase.util.transformers.AbstractTransformer
        |
        +--org.mmbase.util.transformers.XmlField

All Implemented Interfaces:

CharTransformer, Transformer

public class XmlField

extends AbstractTransformer

implements CharTransformer

XMLFields in MMBase. This class can encode such a field to several other formats.

Author:

Michiel Meeuwissen

Fields inherited from class org.mmbase.util.transformers.AbstractTransformer

to

Constructor Summary

XmlField()

Method Summary

static boolean	isXmlEncoded(java.lang.String s)
static java.lang.String	poorToXML(java.lang.String data)
static java.lang.String	poorToXML(java.lang.String data, boolean format) As richToXML but a little less rich.
static java.lang.String	richToXML(java.lang.String data)
static java.lang.String	richToXML(java.lang.String data, boolean format) Defines a kind of 'rich' text format.
java.io.Writer	transform(java.io.Reader r) Takes an object, normally a string
java.lang.String	transform(java.lang.String data)
java.io.Writer	transformBack(java.io.Reader r)
java.lang.String	transformBack(java.lang.String r)
java.util.HashMap	transformers() Returns which transformations can be done by an object of this class.

Methods inherited from class org.mmbase.util.transformers.AbstractTransformer

configure

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.mmbase.util.transformers.Transformer

configure

Constructor Detail

XmlField

public XmlField()

Method Detail

isXmlEncoded

public static final boolean isXmlEncoded(java.lang.String s)

richToXML

public static java.lang.String richToXML(java.lang.String data,
                                         boolean format)

Defines a kind of 'rich' text format. This is a way to easily type structured text in XML. The XML tags which can be produced by this are all HTML as well. This is a generalisation of the MMBase html() functions which do similar duties, but hopefully this one is better, and more powerfull too. The following things are recognized:

• Firstly, XMLEscape is called.
• A line starting with an asterix (*) will start an unnumberd list. The first new line not starting with a space or an other asterix will end the list
• Underscores are translated to the emphasize HTML-tag
• You can create a header tag by by starting a line with a dollar signs
• A paragraph can be begun (and ended) with an empty line.

Test with commandline: java org.mmbase.util.Encode RICH_TEXT (reads from STDIN)

Parameters:

data - text to convert

format - if the resulting XML must be nicely formatted (default: false)

Returns:

the converted text

richToXML

public static java.lang.String richToXML(java.lang.String data)

poorToXML

public static java.lang.String poorToXML(java.lang.String data,
                                         boolean format)

As richToXML but a little less rich. Which means that only one new line is non significant.

poorToXML

public static java.lang.String poorToXML(java.lang.String data)

transformers

public java.util.HashMap transformers()

Description copied from interface: Transformer

Returns which transformations can be done by an object of this class.

Specified by:

transformers in interface Transformer

Overrides:

transformers in class AbstractTransformer

Following copied from interface: org.mmbase.util.transformers.Transformer

Returns:

An HashMap with String Integer/Class pairs.

transform

public java.io.Writer transform(java.io.Reader r)

Takes an object, normally a string

Specified by:

transform in interface CharTransformer

transformBack

public java.io.Writer transformBack(java.io.Reader r)

Specified by:

transformBack in interface CharTransformer

transform

public java.lang.String transform(java.lang.String data)

Specified by:

transform in interface CharTransformer

transformBack

public java.lang.String transformBack(java.lang.String r)

Specified by:

transformBack in interface CharTransformer