Application: gvSIG desktop

package org.gvsig.gpe.kml.writer.features;

import java.io.IOException;

import org.gvsig.gpe.kml.KmlTags;

import org.gvsig.gpe.xml.writer.Writer;

/* gvSIG. Sistema de Informaci?n Geogr?fica de la Generalitat Valenciana

 *

 * Copyright (C) 2004 IVER T.I. and Generalitat Valenciana.

 *

 * This program is free software; you can redistribute it and/or

 * modify it under the terms of the GNU General Public License

 * as published by the Free Software Foundation; either version 2

 * of the License, or (at your option) any later version.

 *

 * This program is distributed in the hope that it will be useful,

 * but WITHOUT ANY WARRANTY; without even the implied warranty of

 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

 * GNU General Public License for more details.

 *

 * You should have received a copy of the GNU General Public License

 * along with this program; if not, write to the Free Software

 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307,USA.

 *

 * For more information, contact:

 *

 *  Generalitat Valenciana

 *   Conselleria d'Infraestructures i Transport

 *   Av. Blasco Ib??ez, 50

 *   46010 VALENCIA

 *   SPAIN

 *

 *      +34 963862235

 *   gvsig@gva.es

 *      www.gvsig.gva.es

 *

 *    or

 *

 *   IVER T.I. S.A

 *   Salamanca 50

 *   46005 Valencia

 *   Spain

 *

 *   +34 963163400

 *   dac@iver.es

 */

/* CVS MESSAGES:

 *

 * $Id: FolderWriter.java 11485 2007-05-08 08:22:37Z jorpiell $

 * $Log$

 * Revision 1.4  2007-05-08 08:22:37  jorpiell

 * Add comments to create javadocs

 *

 * Revision 1.3  2007/05/08 07:53:08  jorpiell

 * Add comments to the writers

 *

 * Revision 1.2  2007/04/20 08:38:59  jorpiell

 * Tests updating

 *

 * Revision 1.1  2007/04/14 16:08:07  jorpiell

 * Kml writing support added

 *

 *

 */

/**

 * This class writes a Folder kml tag. Example:

 * <p>

 * <pre>

 * <code>

 * <Folder>

 * <Placemark>

 * <name>CDATA example</name>

 * <description>Description example</description>

 * <Point>

 * <oordinates>102.595626,14.996729</coordinates>

 * </Point>

 * </Placemark>

 * </Folder>

 * </code>

 * </pre>

 * </p>

 * @author Jorge Piera LLodr? (jorge.piera@iver.es)

 * @see http://code.google.com/apis/kml/documentation/kml_tags_21.html#folder

 */

public class FolderWriter {

        /**

         * Writes a Folder init tag and its attributes

         * @param writer

         * Writer to write the labels

         * @param id

         * Folder id

         * @param name

         * Folder name

         * @param description

         * Folder description

         * @throws IOException

         */

        public static void start(Writer writer,String id, String name, String description) throws IOException{

                FeatureWriter.start(writer, id, KmlTags.FOLDER);

                if (name != null){

                        NameWriter.write(writer, name);

                }

                if (description != null){

                        DescriptionWriter.write(writer, description);

                }

        }

        /**

         * It writes the end Folder tag

         * @param writer

         * Writer to write the labels

         * @throws IOException

         */

        public static void end(Writer writer) throws IOException{

                FeatureWriter.end(writer, KmlTags.FOLDER);

        }

}