001/*
002 * This library is part of OpenCms -
003 * the Open Source Content Management System
004 *
005 * Copyright (c) Alkacon Software GmbH & Co. KG (http://www.alkacon.com)
006 *
007 * This library is free software; you can redistribute it and/or
008 * modify it under the terms of the GNU Lesser General Public
009 * License as published by the Free Software Foundation; either
010 * version 2.1 of the License, or (at your option) any later version.
011 *
012 * This library is distributed in the hope that it will be useful,
013 * but WITHOUT ANY WARRANTY; without even the implied warranty of
014 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
015 * Lesser General Public License for more details.
016 *
017 * For further information about Alkacon Software, please see the
018 * company website: http://www.alkacon.com
019 *
020 * For further information about OpenCms, please see the
021 * project website: http://www.opencms.org
022 *
023 * You should have received a copy of the GNU Lesser General Public
024 * License along with this library; if not, write to the Free Software
025 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
026 */
027
028package org.opencms.xml.xml2json.renderer;
029
030import org.opencms.configuration.I_CmsConfigurationParameterHandler;
031import org.opencms.file.CmsObject;
032import org.opencms.json.JSONException;
033import org.opencms.main.CmsException;
034import org.opencms.xml.content.CmsXmlContent;
035import org.opencms.xml.xml2json.handler.CmsJsonHandlerContext;
036
037import java.util.Locale;
038
039/**
040 * Renders a single-locale content tree as JSON.
041 */
042public interface I_CmsJsonRendererXmlContent extends I_CmsConfigurationParameterHandler {
043
044    /**
045     * Initializes the context for the renderer.
046     *
047     * @param context the context to set
048     * @throws CmsException if something goes wrong
049     */
050    void initialize(CmsJsonHandlerContext context) throws CmsException;
051
052    /**
053     * Initializes the context for the renderer.
054     *
055     * @param cms the CMS object to set
056     * @throws CmsException if something goes wrong
057     */
058    void initialize(CmsObject cms) throws CmsException;
059
060    /**
061     * Converts the XML content for a single locale to a JSON object
062     *
063     * @param content the content
064     * @param locale the locale
065     * @return the JSON object
066     *
067     * @throws JSONException if something goes wrong
068     */
069    Object render(CmsXmlContent content, Locale locale) throws JSONException;
070
071}