Package org.mmbase.util.transformers

`Tranformers' define tranformations of Strings, byte arrays and streams.

See: Description

Interface Summary

Interface	Description
ByteToCharTransformer	Interface for transformations.
ByteTransformer	Interface for transformations.
CharTransformer	Interface for transformations.
ConfigurableTransformer	Interface for transformations.
ListParserConstants	Token literal values and constants.
ParameterizedTransformerFactory<T extends Transformer>	ParameterizedTransformerFactories, can create Transformer instances, but can do that 'parameterized'.
Transformer	Interface for transformations.

Class Summary

Class	Description
AbstractCommandStringTransformer	If you want to transform a Reader stream by the use of an external command, than you can extend this class.
Asciifier	Transforms strings to ascii strings.
Base64	Code taken from "http://www.source-code.biz/snippets/java/2.htm"
BeanTransformerFactory<T extends Transformer>	BeanTransformerFactory takes simple Transformers class-es and wraps them into parameterixed transformer factories.
BufferedReaderTransformer
BufferedReaderTransformer.Status
ByteArrayToCharTransformer	You need only to implement transform(byte[]) you have the simplest kind of transformer (which is not 'streamable').
ByteCharTransformer	A CharTransformer which wraps a ByteToCharTransformer.
ByteTransformerLink	A Runnable implementation to perform a ByteTransformation between an InputStream and an OutputStream.
Censor	Replaces certain 'forbidden' words by something more decent.
ChainedCharTransformer	A CharTransformer which wraps N other CharTransformers, and links them with N - 1 new Threads, effectively working as a 'chained' transformer.
CharTransformerLink	A Runnable implementation to perform a CharTransform between a Reader and a Writer.
ChecksumFactory	Creates ByteToCharTransformers, creating a 'checksum' string of a byte-arrays.
ChunkedTransformer<P>	A chunked transformer is a transformer that transforms on a 'chunk by chunk' base.
CodeSampleFactory	This TransformerFactory enables the use of two different escapers in one piece of text.
Config	Describes what encoding is configured.
ConfigurableReaderTransformer	Some Transformers implement more than one transformation.
ConfigurableStringTransformer	Some Transformers implement more than one transformation.
CopierFactory	A place holder factory, which only produces copiers and accepts every parameter for that.
CopyCharTransformer	This is the character transformer which does not actually transform anything, it just copies the reader to the writer.
CP1252Surrogator	Surrogates the Windows CP1252 characters which are not valid ISO-8859-1.
DiacriticsRemover	This transformer removes all diacritics from the characters of a string.
EncryptionTransformerFactory	This transformerfactory can encrypt and decrypt strings.
Figlet	An escaper based on the amusing 'figlet' tool, which is available on some system.
GoogleHighlighterFactory	An example for parameterized transformers.
Graphviz	Converts the tools of graphviz into an MMBase 'chartransformer'.
Hex	Encode a bytearray to a string by converting every byte to a hexadecimal (00 - FF) representation, and decode the other way around.
Identifier	Transforms strings to identifiers, replacing punctuation and whitespace with underscores.
InputStreamTransformer	Abstract implementation of ByteTransformer.
InverseCharTransformer	Turns a Transformer around.
Iso1	Provides the (unmodifiable) map 'iso2htmlMappings'
Javascript	Encodings related Javascript It can escape single quotes, by replacing them by \\', as is needed in document.write actions.
Latin3Surrogator	The ISO-8859-3 ('South European') unibyte encoding is used for languages like maltese and esperanto.
LinkFinder	Finds links in the Character String, and makes them 'clickable' for HTML (using a-tags).
ListParser
ListParserTokenManager	Token Manager.
LoggerCharTransformer	This is the character transformer is like CopyCharTransformer, but it logs everything that it sees too.
LowerCaser	Transforms to lowercase
MD5	Do MD5 encoding.
MD5.MD5Implementation
ParagraphTransformerFactory	Wraps a text in paragraph (p) tags, unless it is empty or that text starts with a p tag (in which case it is already wrapped).
Perl	And yet another rather idiotic type of Transformer.
ProcessorCharTransformer
RadixTransformer	This straight-forward transformer wraps Long.toString(long, int) and Long.parseLong(String, int).
ReaderTransformer	You need only to implement transform(Reader, Writer) you have the simplest kind of tranformer (which is 'streamable').
RegexpReplacer	Finds regexps in the Character String, and replaces them.
RegexpReplacer.PatternWatcher
RegexpReplacerFactory	Factories new instances of extensions of RegexpReplacer, for which the replace patterns are parameterized (using the 'patterns' parameter).
ResourceBundleReplacer
ResourceBundleReplacerFactory	Factories new chartransformer based on ResourceBundle.
RomanTransformer	Static utilities to deal with roman numbers, and non static functions to transform strings representing decimal numbers to roman numbers and back.
Rot13	Rot13 implementation.
Rot5	Rot5 implementation.
SimpleCharStream	An implementation of interface CharStream, where the stream is assumed to contain only ASCII characters (without unicode processing).
Sitestat	Transforms the input to the characters which are alowed in Sitestat keys for page statistics, being: "A-Z, a-z, 0-9, - .
SpaceReducer	Replace 1 or more spaces by 1 space, and 1 or more newlines by 1 newline.
SpaceReducer.SpaceReducerStatus
SpaceReducer.Tag	this is a helper class that can check if a tag was opened or closed in a line of text It first removes all bodyless versions of the tag from the line, and then counts all opening and closing occurrences of the tag.
SpaceRemover	Replace 1 or white space by 1 space, and all spaces on the begin and end.
SpaceSwallower	Swallows all spaces.
Sql	Encodings related to Sql.
StringTransformer	You need only to implement transform(String) you have the simplest kind of tranformer (which is not 'streamable').
SubstringFactory	Factories CharTransformer's which mirror the input, but only between 'from' and 'to' parameters.
Swallower	This tranformer is the equivalent of piping to /dev/null
TabToSpacesTransformer	Replace every tab by n spaces.
TagStripperFactory	Can be used to strip tags and attributes from HTML.
TagStripperFactory.ParserGetter
TagStripperFactory.TagCheck
TagStripperFactory.TagStripper
Token	Describes the input token stream.
Transformers	Utitilies related to the tranformers of this package.
TransformingOutputStream	A Filtering OutputStream based on ByteTransformers.
TransformingReader	A Filtering Reader based on CharTransformers.
TransformingWriter	A Filtering Writer based on CharTransformers.
Trimmer	Trims leading and trailing white space.
UnicodeEscaper	To escape from and to 'java' like unicode escaping.
UpperCaser	A 'hello world' for CharTransformers.
Url	Encodings related to URL's.
UrlEscaper	Escapes and Unescapes undesirable characters using % (URLEncoding) Contrary to java.net.URLEncoder, it does not encode '+'.
WordWrapperFactory	Word wrapping as a transformer factory.
Xml	Transformations related to escaping in XML.
XmlEntities	Any non-ASCII character will be replaced by an XML-entity.
XmlField	XMLFields in MMBase.
XmlField.ErrorHandler
XsltTransformer	A Transformer based on an XSLT.
YUICSSCompressor	CSS compressor based on http://yuilibrary.com/
YUIJavaScriptCompressor	Javascript compressor based on http://yuilibrary.com/

Enum Summary

Enum	Description
TagStripperFactory.State

Exception Summary

Exception	Description
ParseException	This exception is thrown when parse errors are encountered.
UnknownCodingException	Class UnknownCodingException
XmlField.FormatException

Error Summary

Error	Description
TokenMgrError	Token Manager Error.

Package org.mmbase.util.transformers Description

`Tranformers' define tranformations of Strings, byte arrays and streams.

Transformers are devided in three species. CharTransformers which transform some String to another String (or Reader to a Writer). Then there are transformation which take a byte array (or an InputStream) and transform that to a String (or a Writer), these are called ByteToCharTransformers. And the last type are are the ByteTranformers, which tranform a byte array to another byte array (or an InputStream to an OutputStream).

All Transformers can be specialized to 'ConfigurableTransformers'.

Several Abstract implemenations are present too. E.g. the 'ReaderTransformer' is nearly a complete CharTransformer, only the function wich pipes a Reader to a Writer is abstract. StringTranformer is a CharTransformer which' only abstract function is the one taking a String argument.