| gvSIG desktop 1

package org.gvsig.fmap.data;

import java.util.Collection;

import java.util.Collections;

import java.util.HashMap;

import java.util.Iterator;

import java.util.Map;

import java.util.Set;

/* 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 IVER T.I. S.A.   {{Task}}

 */

/**

 *

 */

/**

 * @author jmvivo

 *

 */

public abstract class AbstractDataParameters implements DataParameters {

        private Map params;

        private Map defaultParams;

        public AbstractDataParameters() {

                this.params = new HashMap();

                this.defaultParams = this.createDefaultValuesMap();

                this.clear();

        }

        /**

         * Create a new map with defaultValues

         * 

         * @return Map

         */

        protected abstract Map createDefaultValuesMap();

        /* (non-Javadoc)

         * @see java.util.Map#containsKey(java.lang.Object)

         */

        public boolean containsKey(Object key) {

                return this.params.containsKey(key);

        }

        /* (non-Javadoc)

         * @see java.util.Map#containsValue(java.lang.Object)

         */

        public final boolean containsValue(Object value) {

                return this.params.containsValue(value);

        }

        /**

         * Unsupported

         *

         * @see java.util.Map#entrySet()

         *

         * @throws UnsupportedOperationException

         *

         */

        public final Set entrySet() {

                return Collections.unmodifiableSet(this.params.entrySet());

        }

        /**

         * @see java.util.Map#isEmpty()

         *

         * @return false

         */

        public boolean isEmpty() {

                return false;

        }

        /*

         * (non-Javadoc)

         * 

         * @see java.util.Map#size()

         */

        public final int size() {

                return this.params.size();

        }

        /**

         * Like {@link Map#keySet()} but read only

         *

         * @see java.util.Map#keySet()

         *

         * @return {@link java.util.Collections#unmodifiableSet(Set)}

         *

         */

        public final Set keySet() {

                return Collections.unmodifiableSet(this.params.keySet());

        }

        /**

         * Returs default values keyset like {@link AbstractDataParameters#keySet()}

         * 

         * @see java.util.Map#keySet()

         * 

         * @return {@link java.util.Collections#unmodifiableSet(Set)}

         * 

         */

        public final Set defaultValueskeySet() {

                return Collections.unmodifiableSet(this.defaultParams.keySet());

        }

        /*

         * (no javadoc)

         * 

         * @see java.util.Map#putAll(java.util.Map)

         */

        public final void putAll(Map t) {

                this.params.putAll(t);

        }

        /**

         * Puts only the values of the defaut entries.<br>

         * The others will be ignored

         * 

         * @see java.util.Map#putAll(java.util.Map)

         */

        public final void putAllDefaultValues(Map t) {

                Iterator iter = this.defaultParams.keySet().iterator();

                Object key;

                while (iter.hasNext()) {

                        key = iter.next();

                        if (t.containsKey(key)) {

                                this.params.put(key, t.get(key));

                        }

                }

        }

        /**

         * For standart entries resets to default value.<br>

         * The others entries will be removed.

         * 

         * @throws {@link UnsupportedOperationException} if key is in the standart

         *         entries

         * 

         * @see java.util.Map#remove(java.lang.Object)

         */

        public Object remove(Object key) {

                if (this.defaultParams.containsKey(key)) {

                        return this.params.put(key, this.defaultParams.get(key));

                }

                return this.params.remove(key);

        }

        /**

         * Like {@link Map#values()} but read only

         *

         * @see Map#values()

         *

         * @return {@link java.util.Collections#unmodifiableCollection(Collection))}

         *

         */

        public final Collection values() {

                return Collections.unmodifiableCollection(this.params.values());

        }

        /*

         * (non-Javadoc)

         * 

         * @see java.util.Map#get(java.lang.Object)

         */

        public final Object get(Object key) {

                return this.params.get(key);

        }

        public Object put(Object key, Object value) {

                return this.params.put(key, value);

        }

        public void clear() {

                params.clear();

                params.putAll(defaultParams);

        }

}