Package org.ametys.cms.transformation

Class AbstractRichTextTransformer

java.lang.Object

org.ametys.cms.transformation.AbstractRichTextTransformer

All Implemented Interfaces:

RichTextTransformer, Serviceable

Direct Known Subclasses:

DocbookTransformer, HTMLTransformer, HTMLTransformer

public abstract class AbstractRichTextTransformer
extends Object
implements RichTextTransformer, Serviceable

Abstract class for RichTextTransformers relying on Cocoon pipelines to actually transform HTML to RichText back and forth.

Constructor Summary

Constructors

Constructor	Description
AbstractRichTextTransformer()

Method Summary

Modifier and Type	Method	Description
protected abstract String	_getSourceUriForHTML2RichText()	Returns the internal Source URI used to process the HTML editor content.
protected abstract String	_getSourceUriForRichText2HTML()	Returns the internal Source URI used to process the RichText's InputStream.
void	service(ServiceManager manager)
void	transform(String source, RichText dest)	Transform a String into a RichText.
void	transform(String source, ModifiableRichText dest)	Deprecated.
void	transformForEditing(RichText source, DataContext dataContext, StringBuilder dest)	Transform a RichText into a StringBuilder.
void	transformForEditing(ModifiableRichText source, StringBuilder dest)	Deprecated.
void	transformForRendering(RichText source, ContentHandler handler)	SAXes a RichText into a ContentHandler for rendering purposes.
void	transformForRendering(RichText source, ContentHandler handler)	Deprecated.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractRichTextTransformer

public AbstractRichTextTransformer()

Method Detail

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

transform

@Deprecated
public void transform(String source,
                      ModifiableRichText dest)
               throws AmetysRepositoryException,
                      IOException

Deprecated.

Description copied from interface: RichTextTransformer

Transform a String into a ModifiableRichText.

Specified by:

transform in interface RichTextTransformer

Parameters:

source - the source.

dest - the ModifiableRichText to populate.

Throws:

AmetysRepositoryException - if an error occurs.

IOException - if an error occurs.

transform

public void transform(String source,
                      RichText dest)
               throws AmetysRepositoryException,
                      IOException

Description copied from interface: RichTextTransformer

Transform a String into a RichText.

Specified by:

transform in interface RichTextTransformer

Parameters:

source - the source.

dest - the RichText to populate.

Throws:

AmetysRepositoryException - if an error occurs.

IOException - if an error occurs.

_getSourceUriForHTML2RichText

protected abstract String _getSourceUriForHTML2RichText()

Returns the internal Source URI used to process the HTML editor content.

Returns:

the internal Source URI used to process the HTML editor content.

transformForEditing

@Deprecated
public void transformForEditing(ModifiableRichText source,
                                StringBuilder dest)
                         throws AmetysRepositoryException,
                                IOException

Deprecated.

Description copied from interface: RichTextTransformer

Transform a ModifiableRichText into a StringBuilder.

Specified by:

transformForEditing in interface RichTextTransformer

Parameters:

source - the source.

dest - the StringBuilder to populate.

Throws:

AmetysRepositoryException - if an error occurs.

IOException - if an error occurs.

transformForEditing

public void transformForEditing(RichText source,
                                DataContext dataContext,
                                StringBuilder dest)
                         throws AmetysRepositoryException,
                                IOException

Description copied from interface: RichTextTransformer

Transform a RichText into a StringBuilder.

Specified by:

transformForEditing in interface RichTextTransformer

Parameters:

source - the source.

dataContext - the context of the rich text

dest - the StringBuilder to populate.

Throws:

AmetysRepositoryException - if an error occurs.

IOException - if an error occurs.

_getSourceUriForRichText2HTML

protected abstract String _getSourceUriForRichText2HTML()

Returns the internal Source URI used to process the RichText's InputStream.

Returns:

the internal Source URI used to process the RichText's InputStream.

transformForRendering

@Deprecated
public void transformForRendering(RichText source,
                                  ContentHandler handler)
                           throws AmetysRepositoryException,
                                  SAXException,
                                  IOException

Deprecated.

Description copied from interface: RichTextTransformer

SAXes a RichText into a ContentHandler for rendering purposes.

Specified by:

transformForRendering in interface RichTextTransformer

Parameters:

source - the source.

handler - the StringBuilder to populate.

Throws:

AmetysRepositoryException - if an error occurs.

SAXException - if an error occurs.

IOException - if an error occurs.

transformForRendering

public void transformForRendering(RichText source,
                                  ContentHandler handler)
                           throws AmetysRepositoryException,
                                  SAXException,
                                  IOException

Description copied from interface: RichTextTransformer

SAXes a RichText into a ContentHandler for rendering purposes.

Specified by:

transformForRendering in interface RichTextTransformer

Parameters:

source - the source.

handler - the StringBuilder to populate.

Throws:

AmetysRepositoryException - if an error occurs.

SAXException - if an error occurs.

IOException - if an error occurs.