JMLWriter.java

/*
 * JMLWriter.java
 *
 * Created on July 12, 2002, 3:00 PM
 */
/*
 * The Unified Mapping Platform (JUMP) is an extensible, interactive GUI 
 * for visualizing and manipulating spatial features with geometry and attributes.
 *
 * Copyright (C) 2003 Vivid Solutions
 * 
 * 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:
 *
 * Vivid Solutions
 * Suite #1A
 * 2328 Government Street
 * Victoria BC  V8T 5G5
 * Canada
 *
 * (250)385-6040
 * www.vividsolutions.com
 */

package com.vividsolutions.jump.io;

import com.vividsolutions.jump.feature.FeatureCollection;


/**
 * JMLWriter is a {@link JUMPWriter} specialized to write JML.
 *
 * <p>
 * This is a simple class that passes the work off to the {@link GMLWriter} class that
 * knows how to auto-generate a JML compatible {@link GMLOutputTemplate}.
 * </p>
 *
 * <p>
 * DataProperties for the JMLWriter write(DataProperties) interface:<br><br>
 * </p>
 *
 * <p>
 * <table border='1' cellspacing='0' cellpadding='4'>
 *   <tr>
 *     <th>Parameter</th>
 *     <th>Meaning</th>
 *   </tr>
 *   <tr>
 *     <td>OutputFile or DefaultValue</td>
 *     <td>File name for the output JML file</td>
 *   </tr>
 * </table><br>
 * </p>
 */
public class JMLWriter implements JUMPWriter {
    /** Creates new JMLWriter */
    public JMLWriter() {
    }

    /**
     *  Writes the feature collection to the specified file in JML format.
     * @param featureCollection features to write
     * @param dp 'OutputFile' or 'DefaultValue' to specify what file to write.
     */
    public void write(FeatureCollection featureCollection, DriverProperties dp)
        throws IllegalParametersException, Exception {
        GMLWriter gmlWriter;
        String outputFname;

        outputFname = dp.getProperty("File");

        if (outputFname == null) {
            outputFname = dp.getProperty("DefaultValue");
        }

        if (outputFname == null) {
            throw new IllegalParametersException(
                "call to JMLWriter.write() has DataProperties w/o a OutputFile specified");
        }

        gmlWriter = new GMLWriter();

        gmlWriter.write(featureCollection, dp);
    }
}