root/tools/routingservice/trunk/src/jp/co/orkney/restlet/util/Format.java

package jp.co.orkney.restlet.util;

import org.antlr.stringtemplate.StringTemplate;
import org.antlr.stringtemplate.StringTemplateGroup;
import org.jdom.Element;

/**
 * Copyright (c) 2007 Orkney, Inc. <http://www.orkney.co.jp/>
 * 
 * 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 3 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, see <http://www.gnu.org/licenses/>.
 */


/**
 * <b>Format is a class which represents a data format (Geojson, Gml, Html, ...) .</b>
 * <p>
 * Format object is characterized by the following information:
 * <ul>
 * <li>A name</li>
 * <li>A srid (usually this variable is empty)</li>
 * <li>A boolean to enable or disable the format for input data</li>
 * <li>A boolean to enable or disable the format for output data</li>
 * </ul>
 * </p>
 * 
 * @author Matthieu Bilbille - Orkney Inc.
 * @version 1.0
 */
public class Format
{
        private String name;
        private String srid;
        private boolean enableInput;
        private boolean enableOutput;
        private StringTemplate template;

        /**
         * Constructor Format.
         * <p>
         * Creates a new format with empty name and empty srid; "enableInput" and
         * "enableOutput" are initialized with FALSE value. Srid is only needed for
         * format using specific data projection (like KML)
         * </p>
         */
        public Format()
        {
                name = "";
                srid = "";
                enableInput = false;
                enableOutput = false;
        }

        /**
         * Constructor Format.
         * <p>
         * Creates a new format with the specified data
         * (name,enableInput,enableOutput).
         * </p>
         * 
         * @param name
         *            format name
         *     @param srid
         *            format specific srid (If there is not specific srid for this format, srid is null or empty)
         * @param enableInput
         *            boolean to enable or disable the format for input data
         * @param enableOutput
         *            boolean to enable or disable the format for output data
         */
        public Format(String name, String srid, boolean enableInput, boolean enableOutput)
        {
                this.name = name;
                this.srid = srid;
                this.enableInput = enableInput;
                this.enableOutput = enableOutput;
        }

        public Format(String name, String srid, boolean enableInput, boolean enableOutput, String template)
        {
            this.name = name;
            this.srid = srid;
            this.enableInput = enableInput;
            this.enableOutput = enableOutput;

            StringTemplateGroup group = new StringTemplateGroup("formatGroup", "templates");
            this.template = group.getInstanceOf(template);
        }
        
        public Format(Element format)
        {
            this.name = format.getAttributeValue("name");
            this.srid = format.getAttributeValue("srid");
            this.enableInput = new Boolean(format.getAttributeValue("input"));
            this.enableOutput = new Boolean(format.getAttributeValue("output"));

            try
            {
                String path = format.getAttributeValue("path");
                if(path != null)
                        path ="templates/"+path;
                else
                        path = "templates";
                        
                StringTemplateGroup group = new StringTemplateGroup("formatGroup", path);
                this.template = group.getInstanceOf(format.getAttributeValue("template"));
            }
            catch (NullPointerException e)
            {
                //Format has no template.
                //Do nothing
            }

        }       

        /**
         * Gets the name of the format
         * 
         * @return this format's name
         */
        public String getName()
        {
                return name;
        }

        /**
         * Sets the name of the format to the specified string.
         * 
         * @param name
         *            the string that is to be this format's name
         */
        public void setName(String name)
        {
                this.name = name;
        }

        /**
         * Gets the srid of the format
         * 
         * @return this format's srid
         */
        public String getSrid()
        {
                return srid;
        }

        /**
         * Sets the srid of the format to the specified string.
         * 
         * @param srid
         *            the string that is to be this format's srid
         */
        public void setSrid(String srid)
        {
                this.srid = srid;
        }

        /**
         * Determines whether this format is enabled for input data. A format may be
         * enabled or disabled by calling its setEnableInput method.
         * 
         * @return true if the format is enabled for input data, false otherwise
         */
        public boolean isEnableInput()
        {
                return enableInput;
        }

        /**
         * Enables or disables this format for input data. Parameters are disabled
         * initially by default.
         * 
         * @param enableInput
         *            if true, this format is enabled for input data; otherwise this
         *            format is disabled for input data
         */
        public void setEnableInput(boolean enableInput)
        {
                this.enableInput = enableInput;
        }

        /**
         * Determines whether this format is enabled for output data. A format may
         * be enabled or disabled by calling its setEnableOutput method.
         * 
         * @return true if the format is enabled for output data, false otherwise
         */
        public boolean isEnableOutput()
        {
                return enableOutput;
        }

        /**
         * Enables or disables this format for output data. Parameters are disabled
         * initially by default.
         * 
         * @param enableOutput
         *            if true, this format is enabled for output data; otherwise
         *            this format is disabled for output data
         */
        public void setEnableOutput(boolean enableOutput)
        {
                this.enableOutput = enableOutput;
        }
        
        public StringTemplate getTemplate()
        {
            return template;
        }       
}