Aplicación gvSIG con fines educativos

/* gvSIG. Geographic Information System of the Valencian Government

 *

 * Copyright (C) 2007-2008 Infrastructures and Transports Department

 * of the Valencian Government (CIT)

 *

 * 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., 51 Franklin Street, Fifth Floor, Boston,

 * MA  02110-1301, USA.

 *

 */

package org.gvsig.educa.portableview.compilation;

/**

 * Process to generate a file which will contains a <i>Portable View</i>

 *

 * @author <a href="http://www.disid.com">DiSiD Technologies S.L.</a>

 * @version $Id$

 */

public interface PortableViewCompiler {

    /**

     * Gets temporal folder used by the process to prepare file

     *

     * @return

     */

    String getWorkFolder();

    /**

     * Sets temporal folder used by the process to prepare file

     *

     * @param folder

     * @throws IllegalArgumentException

     *             if folder not exists or is not writable

     */

    void setWorkFolder(String folder);

    /**

     * Gets folder used to deploy generated file

     *

     * @return

     */

    String getTargetFolder();

    /**

     * Sets folder where deploy generated file

     *

     * @throws IllegalArgumentException

     *             if folder not exists or is not writable

     */

    void setTargetFolder(String folder);

    /**

     * Set the process listener

     *

     * @param listener

     */

    void setCompilerListener(PortableViewCompilerListener listener);

    /**

     * <p>

     * Process compilation to generate a <i>Portable View</i>

     * </p>

     * <p>

     * <code>compilation</code> data will be update at the end of process if

     * it's success (build number, creation stamp).

     * </p>

     *

     * @param compilation

     * @return

     * @throws IllegalArgumentException

     *             if targetFolder or workFolder are not set

     */

    PortableViewCompilerStatus compile(PortableViewCompilation compilation);

}