001/*
002 *  Copyright 2010 Anyware Services
003 *
004 *  Licensed under the Apache License, Version 2.0 (the "License");
005 *  you may not use this file except in compliance with the License.
006 *  You may obtain a copy of the License at
007 *
008 *      http://www.apache.org/licenses/LICENSE-2.0
009 *
010 *  Unless required by applicable law or agreed to in writing, software
011 *  distributed under the License is distributed on an "AS IS" BASIS,
012 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 *  See the License for the specific language governing permissions and
014 *  limitations under the License.
015 */
016package org.ametys.cms.transformation;
017
018import java.io.IOException;
019
020import org.xml.sax.ContentHandler;
021import org.xml.sax.SAXException;
022
023import org.ametys.plugins.repository.AmetysRepositoryException;
024import org.ametys.plugins.repository.metadata.ModifiableRichText;
025import org.ametys.plugins.repository.metadata.RichText;
026
027/**
028 * Transform back and forth between a {@link String} and a {@link RichText}.
029 */
030public interface RichTextTransformer
031{
032    /**
033     * Transform a {@link String} into a {@link RichText}.
034     * @param source the source.
035     * @param dest the rich text to populate.
036     * @throws AmetysRepositoryException if an error occurs.
037     * @throws IOException if an error occurs.
038     */
039    void transform(String source, ModifiableRichText dest) throws AmetysRepositoryException, IOException;
040    
041    /**
042     * Transform a {@link RichText} into a {@link StringBuilder}.
043     * @param source the source.
044     * @param dest the {@link StringBuilder} to populate.
045     * @throws AmetysRepositoryException if an error occurs.
046     * @throws IOException if an error occurs.
047     */
048    void transformForEditing(ModifiableRichText source, StringBuilder dest) throws AmetysRepositoryException, IOException;
049    
050    /**
051     * SAXes a {@link RichText} into a {@link ContentHandler} for rendering purposes.
052     * @param source the source.
053     * @param handler the {@link StringBuilder} to populate.
054     * @throws AmetysRepositoryException if an error occurs.
055     * @throws SAXException if an error occurs.
056     * @throws IOException if an error occurs.
057     */
058    void transformForRendering(RichText source, ContentHandler handler) throws AmetysRepositoryException, SAXException, IOException;
059}