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.cms.data.RichText;
024import org.ametys.plugins.repository.AmetysRepositoryException;
025import org.ametys.plugins.repository.metadata.ModifiableRichText;
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 ModifiableRichText}.
034     * @param source the source.
035     * @param dest the {@link ModifiableRichText} to populate.
036     * @throws AmetysRepositoryException if an error occurs.
037     * @throws IOException if an error occurs.
038     * @deprecated use {@link #transform(String, RichText)} instead
039     */
040    @Deprecated
041    void transform(String source, ModifiableRichText dest) throws AmetysRepositoryException, IOException;
042    
043    /**
044     * Transform a {@link String} into a {@link RichText}.
045     * @param source the source.
046     * @param dest the {@link RichText} to populate.
047     * @throws AmetysRepositoryException if an error occurs.
048     * @throws IOException if an error occurs.
049     */
050    void transform (String source, RichText dest) throws AmetysRepositoryException, IOException;
051    
052    /**
053     * Transform a {@link ModifiableRichText} into a {@link StringBuilder}.
054     * @param source the source.
055     * @param dest the {@link StringBuilder} to populate.
056     * @throws AmetysRepositoryException if an error occurs.
057     * @throws IOException if an error occurs.
058     * @deprecated use {@link #transformForEditing(RichText, StringBuilder)} instead
059     */
060    @Deprecated
061    void transformForEditing(ModifiableRichText source, StringBuilder dest) throws AmetysRepositoryException, IOException;
062    
063    /**
064     * Transform a {@link RichText} into a {@link StringBuilder}.
065     * @param source the source.
066     * @param dest the {@link StringBuilder} to populate.
067     * @throws AmetysRepositoryException if an error occurs.
068     * @throws IOException if an error occurs.
069     */
070    void transformForEditing(RichText source, StringBuilder dest) throws AmetysRepositoryException, IOException;
071    
072    /**
073     * SAXes a {@link org.ametys.plugins.repository.metadata.RichText} into a {@link ContentHandler} for rendering purposes.
074     * @param source the source.
075     * @param handler the {@link StringBuilder} to populate.
076     * @throws AmetysRepositoryException if an error occurs.
077     * @throws SAXException if an error occurs.
078     * @throws IOException if an error occurs.
079     * @deprecated use {@link #transformForRendering(RichText, ContentHandler)} instead
080     */
081    @Deprecated
082    void transformForRendering(org.ametys.plugins.repository.metadata.RichText source, ContentHandler handler) throws AmetysRepositoryException, SAXException, IOException;
083    
084    /**
085     * SAXes a {@link RichText} into a {@link ContentHandler} for rendering purposes.
086     * @param source the source.
087     * @param handler the {@link StringBuilder} to populate.
088     * @throws AmetysRepositoryException if an error occurs.
089     * @throws SAXException if an error occurs.
090     * @throws IOException if an error occurs.
091     */
092    void transformForRendering(RichText source, ContentHandler handler) throws AmetysRepositoryException, SAXException, IOException;
093}