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.document;
029
030import org.opencms.json.JSONObject;
031import org.opencms.xml.xml2json.CmsJsonRequest;
032import org.opencms.xml.xml2json.handler.CmsJsonHandlerContext;
033
034/**
035 * Abstract class representing a JSON document.
036 */
037public abstract class A_CmsJsonDocument {
038
039    /** The related contents property */
040    protected static final String FIELD_LINKED_CONTENTS = "linkedContents";
041
042    /** The handler context. */
043    protected CmsJsonHandlerContext m_context;
044
045    /** The JSON document. */
046    protected JSONObject m_json = new JSONObject(true);
047
048    /** The JSON request. */
049    protected CmsJsonRequest m_jsonRequest;
050
051    /**
052     * Creates a new JSON document.<p>
053     *
054     * @param jsonRequest the JSON request
055     */
056    protected A_CmsJsonDocument(CmsJsonRequest jsonRequest) {
057
058        m_jsonRequest = jsonRequest;
059        m_context = jsonRequest.getContext();
060    }
061}