com.uwyn.rife.cmf.transform
Interface TextContentTransformer

All Superinterfaces:

ContentTransformer<String>

public interface TextContentTransformer
extends ContentTransformer<String>

This interface defines the API that has to be implemented by classes that are capable of transforming text content data after it's initially loaded.

The content attributes are provided to the transform method and can be used to provide hints for the transformation.

Since:

1.0

Version:

$Revision: 3634 $

Author:

Geert Bevin (gbevin[remove] at uwyn dot com)

See Also:

ContentTransformer

Method Summary

String

transform(String data, Map<String,String> attributes) Transforms the text content data and returns the transformed data as text.

Method Detail

transform

String transform(String data,
                 Map<String,String> attributes)
                 throws ContentManagerException

Transforms the text content data and returns the transformed data as text.

Specified by:

transform in interface ContentTransformer<String>

Parameters:

data - the text that has to be transformed

attributes - a map of content attributes that can be used to provide hints or parameters for the transformation

Returns:

the transformed text

Throws:

ContentManagerException

Since:

1.0