| gvSIG desktop 1

/* 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.

 * 

 */

/*

 * AUTHORS (In addition to CIT):

 * 2008 Prodevelop S.L. main development

 */

package org.gvsig.geocoding.pattern.impl;

import java.io.File;

import java.io.FileInputStream;

import java.io.FileNotFoundException;

import java.io.FileOutputStream;

import java.io.IOException;

import java.io.InputStream;

import java.io.InputStreamReader;

import java.io.OutputStream;

import java.io.OutputStreamWriter;

import java.io.UnsupportedEncodingException;

import org.exolab.castor.xml.MarshalException;

import org.exolab.castor.xml.Marshaller;

import org.exolab.castor.xml.ValidationException;

import org.gvsig.geocoding.GeocodingTags;

import org.gvsig.geocoding.pattern.GeocodingPattern;

import org.gvsig.geocoding.pattern.GeocodingSettings;

import org.gvsig.geocoding.pattern.GeocodingSource;

import org.gvsig.utils.XMLEntity;

import org.gvsig.utils.XMLException;

import org.gvsig.utils.xml.XMLEncodingUtils;

import org.gvsig.utils.xmlEntity.generate.XmlTag;

import org.slf4j.Logger;

import org.slf4j.LoggerFactory;

/**

 * Patterngeocoding class implementation.

 * 

 * This class is the geocoding pattern. This pattern has your name (name), the

 * settings (settings) and the data source (source)

 * 

 * @author <a href="mailto:jsanz@prodevelop.es"> Jorge Gaspar Sanz Salinas</a>

 * @author <a href="mailto:vsanjaime@prodevelop.es"> Vicent Sanjaime Calvet</a>

 */

public class DefaultGeocodingPattern implements GeocodingPattern {

        @SuppressWarnings("unused")

        private static final Logger log = LoggerFactory

                        .getLogger(DefaultGeocodingPattern.class);        

        private String name;

        private GeocodingSettings settings;

        private GeocodingSource source;

        /**

         * Default constructor

         */

        public DefaultGeocodingPattern() {

                this.setSource(new DefaultGeocodingSource());

                this.setSettings(new DefaultGeocodingSettings());

        }

        /**

         * Constructor with parameters

         */

        public DefaultGeocodingPattern(GeocodingSource source,

                        GeocodingSettings settings) {

                this.setSource(source);

                this.setSettings(settings);

        }

        /**

         * Constructor with pattern name

         * 

         * @param name

         */

        public DefaultGeocodingPattern(String name) {

                this();

                this.setPatternName(name);

        }

        /**

         * Get pattern name

         * @return name

         */

        public String getPatternName() {

                return this.name;

        }

        /**

         * Get pattern settings

         * @return settings

         */

        public GeocodingSettings getSettings() {

                return this.settings;

        }

        /**

         * Get data source

         * @return source.

         */

        public GeocodingSource getDataSource() {

                return this.source;

        }

        /**

         * Set pattern settings

         * @param settings

         */

        public void setSettings(GeocodingSettings settings) {

                this.settings = settings;

        }

        /**

         * Set pattern name

         * @param name

         * 

         */

        public void setPatternName(String name) {

                this.name = name;

        }

        /**

         * Set data source

         * @param source

         */

        public void setSource(GeocodingSource source) {

                this.source = source;

        }

        /**

         * Save the pattern to XML file

         * 

         * @param file

         * @throws XMLException

         * @throws IOException

         * @throws ValidationException

         * @throws MarshalException

         */

        public void saveToXML(File file) throws XMLException, IOException,

                        MarshalException, ValidationException {

                OutputStream fos = new FileOutputStream(file.getAbsolutePath());

                OutputStreamWriter writer = new OutputStreamWriter(fos, GeocodingTags.PROJECTENCODING);

                Marshaller m = new Marshaller(writer);

                m.setEncoding(GeocodingTags.PROJECTENCODING);

                XMLEntity xml = this.getXMLEntity();

                xml.putProperty("followHeaderEncoding", true);

                m.marshal(xml.getXmlTag());

        }

        /**

         * Load the pattern from XML file

         * 

         * @param reader

         * @throws FileNotFoundException

         * @throws UnsupportedEncodingException

         * @throws ValidationException

         * @throws MarshalException

         * @throws XMLException

         */

        public void loadFromXML(File file) throws FileNotFoundException,

                        UnsupportedEncodingException, MarshalException,

                        ValidationException, XMLException {

                InputStream inStr = new FileInputStream(file);

                String encoding = XMLEncodingUtils.getEncoding(inStr);

                InputStreamReader reader = new InputStreamReader(inStr, encoding);

                XmlTag tag = (XmlTag) XmlTag.unmarshal(reader);

                XMLEntity xml = new XMLEntity(tag);

                this.setXMLEntity(xml);

        }

        /**

         * Save pattern

         * 

         * @return

         * @throws XMLException

         */

        public XMLEntity getXMLEntity() throws XMLException {

                XMLEntity xml = new XMLEntity();

                xml.setName(GeocodingTags.GPATTERN);

                xml.putProperty(GeocodingTags.PATTERNNAME, this.name);

                xml.addChild(this.source.getXMLEntity());

                xml.addChild(this.settings.getXMLEntity());

                return xml;

        }

        /**

         * Load pattern

         * 

         * @param xml

         * @throws XMLException

         */

        public void setXMLEntity(XMLEntity xml) throws XMLException {

                this.name = xml.getStringProperty(GeocodingTags.PATTERNNAME);

                this.source.setXMLEntity(xml.getChild(0));

                this.settings.setXMLEntity(xml.getChild(1));

        }

        /**

         * Get this class name

         * 

         * @return

         */

        public String getClassName() {

                return this.getClass().getName();

        }

}