    001    //$HeadURL: $
    002    /*----------------------------------------------------------------------------
    003     This file is part of deegree, http://deegree.org/
    004     Copyright (C) 2001-2009 by:
    005       Department of Geography, University of Bonn
    006     and
    007       lat/lon GmbH
    008
    009     This library is free software; you can redistribute it and/or modify it under
    010     the terms of the GNU Lesser General Public License as published by the Free
    011     Software Foundation; either version 2.1 of the License, or (at your option)
    012     any later version.
    013     This library is distributed in the hope that it will be useful, but WITHOUT
    014     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
    015     FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
    016     details.
    017     You should have received a copy of the GNU Lesser General Public License
    018     along with this library; if not, write to the Free Software Foundation, Inc.,
    019     59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
    020
    021     Contact information:
    022
    023     lat/lon GmbH
    024     Aennchenstr. 19, 53177 Bonn
    025     Germany
    026     http://lat-lon.de/
    027
    028     Department of Geography, University of Bonn
    029     Prof. Dr. Klaus Greve
    030     Postfach 1147, 53001 Bonn
    031     Germany
    032     http://www.geographie.uni-bonn.de/deegree/
    033
    034     e-mail: info@deegree.org
    035    ----------------------------------------------------------------------------*/
    036
    037    package org.deegree.tools.app3d;
    038
    039    import java.util.Map;
    040
    041    import javax.media.j3d.Group;
    042
    043    /**
    044     * The <code>J3DExporter</code> Inteface allows for easy access to some common the export methods.
    045     *
    046     * @author <a href="mailto:bezema@lat-lon.de">Rutger Bezema</a>
    047     *
    048     * @author last edited by: $Author:$
    049     *
    050     * @version $Revision:$, $Date:$
    051     *
    052     */
    053
    054    public interface J3DExporter {
    055
    056        /**
    057         * A method which can be called to export to the given format.
    058         *
    059         * @param result
    060         *            a reference to which the implementing class should write.
    061         * @param j3dScene
    062         *            the scene to be exported.
    063         */
    064        public void export( StringBuilder result, Group j3dScene );
    065
    066        /**
    067         * @return A Name which can be presented to a calling client;
    068         */
    069        public String getName();
    070
    071        /**
    072         * @return a simple description which describes the function of the implementing class.
    073         */
    074        public String getShortDescription();
    075
    076        /**
    077         * Should return a list of parameter names (keys) with their description (values) of all parameters this Exporter
    078         * supports. It is up to the requester to use the given parameters and call the required constructor with the map<String,
    079         * String>, containing the keys that have values.
    080         *
    081         * @return a map containing the parameter names (keys) and their description (values)
    082         */
    083        public Map<String, String> getParameterMap();
    084
    085    }