/**
    * Copyright 2008 Bryan Ray
    * 
    * Licensed under the Apache License, Version 2.0 (the "License"); 
    * you may not use this file except in compliance with the License.
    * You may obtain a copy of the License at 
    * 
    * http://www.apache.org/licenses/LICENSE-2.0 
    * 
   * Unless required by applicable law or agreed to in writing, software 
   * distributed under the License is distributed on an "AS IS" BASIS,
   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 
   * See the License for the specific language governing permissions and 
   * limitations under the License. 
   */
  package uk.org.bryanray.testtoys.generator;
  
  import java.util.ArrayList;
  import java.util.Collection;
  import java.util.HashSet;
  import java.util.Iterator;
  import java.util.Map;
  import java.util.Set;
  
  import uk.org.bryanray.testtoys.generator.sequencegenerators.SequenceGenerator;
  
  /**
   * <DL>
   * <DT><B>Project:</B></DT>
   * <DD>TestDataLoader</DD>
   * <DT><B>Filename:</B></DT>
   * <DD>SequenceMapAdapter.java</DD>
   * <DT><B>Creation Date:</B></DT>
   * <DD>26 May 2008</DD>
   * </DL>
   * 
   * Wraps a {@link Map<String,SequenceGenerator>} so that it can be used to
   * populate a template. This class does not implement all methods. The map
   * values will appear to change as the objects in the target map appear to
   * change.
   * 
   * @author Bryan Ray
   */
  public class SequenceMapAdapter implements Map<String, String> {
  
  	// TODO This class could be parameterised by using a functor that calls the
  	// appropriate method on the object.
  	
  	private Map<String, SequenceGenerator> map;
  
  	/**
  	 * @param sequenceMap The map to wrap.
  	 * */
  	public SequenceMapAdapter(Map<String, SequenceGenerator> sequenceMap) {
  		map = sequenceMap;
  	}
  
  	/**
  	 * {@inheritDoc}
  	 */
  	public void clear() {
  		map.clear();
  	}
  
  	/**
  	 * {@inheritDoc}
  	 */
  	public boolean containsKey(Object key) {
  		return map.containsKey(key);
  	}
  
  	/**
  	 * {@inheritDoc}
  	 */
  	public boolean containsValue(Object value) {
  		if (null != value) {
  			for (Iterator<SequenceGenerator> i = map.values().iterator(); i
  					.hasNext();) {
  				SequenceGenerator sequenceGenerator = i.next();
  				if (sequenceGenerator.value().equals(value)) {
  					return true;
  				}
  			}
  		}
  		return false;
  	}
  
  	/**
  	 * {@inheritDoc}
  	 */
  	public Set<Entry<String, String>> entrySet() {
  		Set<Entry<String, String>> set = new HashSet<Entry<String, String>>();
  		for (Iterator<Entry<String, SequenceGenerator>> i = map.entrySet()
  				.iterator(); i.hasNext();) {
  			Entry<String, SequenceGenerator> e = i.next();
  			set.add(new AdapterEntry(e.getKey(), e.getValue().value()));
  		}
  		return set;
  
 	}
 
 	/**
 	 * {@inheritDoc}
 	 */
 	public String get(Object key) {
 		return map.get(key).value();
 	}
 
 	/**
 	 * {@inheritDoc}
 	 */
 	public boolean isEmpty() {
 		return map.isEmpty();
 	}
 
 	/**
 	 * {@inheritDoc}
 	 */
 	public Set<String> keySet() {
 		return map.keySet();
 	}
 
 	/**
 	 * This method is not supported.
 	 * 
 	 * {@inheritDoc}
 	 */
 	public String put(String key, String value) {
 		throw new UnsupportedOperationException();
 	}
 
 	/**
 	 * This method is not supported.
 	 * 
 	 * {@inheritDoc}
 	 */
 	public void putAll(Map<? extends String, ? extends String> t) {
 		throw new UnsupportedOperationException();
 	}
 
 	/**
 	 * {@inheritDoc}
 	 */
 	public String remove(Object key) {
 		return map.remove(key).value();
 	}
 
 	/**
 	 * {@inheritDoc}
 	 */
 	public int size() {
 		return map.size();
 	}
 
 	/**
 	 * {@inheritDoc}
 	 */
 	public Collection<String> values() {
 		Collection<String> result = new ArrayList<String>();
 		for (Iterator<SequenceGenerator> i = map.values().iterator(); i
 				.hasNext();) {
 			SequenceGenerator sequenceGenerator = i.next();
 			result.add(sequenceGenerator.value());
 		}
 		return result;
 	}
 
 	/**
 	 * A class that implements the {@link Entry} in a {@link SequenceMapAdapter}.
 	 */
 	private class AdapterEntry implements Entry<String, String> {
 
 		private String key;
 		private String value;
 
 		public AdapterEntry(String key, String value) {
 			this.key = key;
 			this.value = value;
 		}
 
 		/**
 		 * {@inheritDoc}
 		 */
 		public String getKey() {
 			return key;
 		}
 
 		/**
 		 * {@inheritDoc}
 		 */
 		public String getValue() {
 			return value;
 		}
 
 		/**
 		 * {@inheritDoc}
 		 */
 		public String setValue(String value) {
 			String oldValue = this.value;
 			this.value = value;
 			return oldValue;
 		}
 	}
 }