/*
    * Copyright (c) 2005 Regents of the University of California (Regents). Created
    * by TELS, Graduate School of Education, University of California at Berkeley.
    *
    * This software is distributed under the GNU Lesser General Public License, v2.
    *
    * Permission is hereby granted, without written agreement and without license
    * or royalty fees, to use, copy, modify, and distribute this software and its
    * documentation for any purpose, provided that the above copyright notice and
   * the following two paragraphs appear in all copies of this software.
   *
   * REGENTS SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
   * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
   * PURPOSE. THE SOFTWAREAND ACCOMPANYING DOCUMENTATION, IF ANY, PROVIDED
   * HEREUNDER IS PROVIDED "AS IS". REGENTS HAS NO OBLIGATION TO PROVIDE
   * MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
   *
   * IN NO EVENT SHALL REGENTS BE LIABLE TO ANY PARTY FOR DIRECT, INDIRECT,
   * SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES, INCLUDING LOST PROFITS,
   * ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF
   * REGENTS HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
   */
  package net.sf.sail.core.beans;
  
  import java.net.MalformedURLException;
  import java.net.URL;
  import java.util.Collection;
  import java.util.HashMap;
  import java.util.HashSet;
  import java.util.Iterator;
  import java.util.LinkedList;
  import java.util.List;
  import java.util.Map;
  import java.util.Set;
  import java.util.logging.Level;
  import java.util.logging.Logger;
  
  import net.sf.sail.core.activity.model.ScriptBeanContext;
  import net.sf.sail.core.beans.assembly.Assignment;
  import net.sf.sail.core.beans.assembly.PodRegistry;
  import net.sf.sail.core.beans.assembly.PropertyRef;
  import net.sf.sail.core.util.SailBeanUtils;
  import net.sf.sail.core.uuid.PodUuid;
  
  /***
   * Bean representing the reusable Pod container.
   * 
   * @author turadg
   */
  public class Pod extends ScriptBeanContext {
  	/***
  	 * 
  	 */
  	private static final long serialVersionUID = 7881255006647471835L;
  
  	/***
  	 * Make this a constant so other classes can use this property name
  	 */
  	public static final String PROPERTY_POD_ID = "podId";
  
  	/***
  	 * Logger for this class
  	 */
  	private static final Logger logger = Logger.getLogger(Pod.class.getName());
  
  	// property
  	PodUuid podId;
  
  	public PodUuid getPodId() {
  		return podId;
  	}
  
  	public void setPodId(PodUuid podId) {
  		if (podId == null)
  			throw new NullPointerException("podId argument was null");
  		this.podId = podId;
  		// firePropertyChange(PROPERTY_POD_ID, old, podId);
  		// property change listener won't do because the pod may have never had
  		// a podId (and thus not fit yet in the registry)
  		PodRegistry.getRegistry().reregister(this);
  	}
  
  	// property
  	Map<String,PropertyRef> vars = new HashMap<String,PropertyRef>();
  
  	public Map getVars() {
  		return vars;
  	}
  
  	public void setVars(Map<String,PropertyRef> vars) {
  		this.vars = vars;
  	}
  
  	public void bind(String varName, PropertyRef propertyRef,
  			boolean isTransient) {
  		vars.put(varName, propertyRef);
  		if (isTransient)
  			transientRefs.add(propertyRef);
  	}
 
 	public Object resolve(String varName) {
 		Object value = null;
 		try {
 			value = ((PropertyRef) vars.get(varName)).getCurrentValue();
 		} catch (Exception e) {
 			logger.warning("exception: " + e);
 		}
 		return value;
 	}
 
 	// property
 	Set<PropertyRef> transientRefs = new HashSet<PropertyRef>();
 
 	public Set getTransientRefs() {
 		return transientRefs;
 	}
 
 	public void setTransientRefs(Set<PropertyRef> transientRefs) {
 		this.transientRefs = transientRefs;
 	}
 
 	// property
 	List assemblyCalls = new LinkedList();
 
 	public List getAssemblyCalls() {
 		return assemblyCalls;
 	}
 
 	public void setAssemblyCalls(List assemblyCalls) {
 		Object old = this.assemblyCalls;
 		this.assemblyCalls = assemblyCalls;
 		firePropertyChange("assemblyCalls", old, assemblyCalls);
 	}
 
 	protected Pod childWithId(PodUuid podId) {
 		Collection podChildren = SailBeanUtils.childrenOfType(this, Pod.class);
 		for (Iterator iter = podChildren.iterator(); iter.hasNext();) {
 			Pod pod = (Pod) iter.next();
 			if (pod.getPodId().equals(podId))
 				return pod;
 		}
 		return null;
 	}
 
 	public URL getPodArchive() {
 		try {
 			return new URL("podar:" + podId);
 		} catch (MalformedURLException e) {
 			throw new RuntimeException("impossible error", e);
 		}
 	}
 
 	// TODO make this throw a checked exception for failed assignments
 	public void assemble() {
 		assembleChildren();
 		PodRegistry registry = PodRegistry.getRegistry();
 		registry.register(this);
 		for (Iterator iter = assemblyCalls.iterator(); iter.hasNext();) {
 			Assignment assignment = (Assignment) iter.next();
 			try {
 				assignment.execute();
 			} catch (Exception e) {
 				logger.warning("exception: " + e);
 				throw new RuntimeException("error assembling", e);
 			}
 		}
 	}
 
 	// TODO give some way to remove a child pod for good
 	// TODO write delegate that persists this without exposing it
 	Set<PodUuid> childPodIds = new HashSet<PodUuid>();
 
 	@Override
 	public boolean add(Object targetChild) {
 		boolean success = super.add(targetChild);
 		if (logger.isLoggable(Level.FINE)) {
 			logger.fine(this + " added " + targetChild + " success:" + success);
 		}
 		if (success && targetChild instanceof Pod) {
 			Pod pod = (Pod) targetChild;
 			childPodIds.add(pod.getPodId());
 		}
 
 		return success;
 	}
 
 	private void assembleChildren() {
 		for (Iterator iter = childPodIds.iterator(); iter.hasNext();) {
 			PodUuid podId = (PodUuid) iter.next();
 			Pod pod = PodRegistry.getRegistry().getPod(podId);
 			add(pod);
 			pod.assemble();
 		}
 	}
 
 	public Set getChildPodIds() {
 		return childPodIds;
 	}
 
 	public void setChildPodIds(Set<PodUuid> childPodIds) {
 		this.childPodIds = childPodIds;
 	}
 
 	/***
 	 * Returns whether the value is the same as a podvar that is transient.
 	 * (i.e. should not be marshalled) Assumes instances of Pod cannot be
 	 * imported.
 	 * 
 	 * @param value
 	 * @return true iff the value matches the current value of one of the refs
 	 *         in this pod marked transient
 	 */
 	public boolean isTransient(Object value) {
 		if (value instanceof Pod)
 			return false;
 		for (Iterator iter = transientRefs.iterator(); iter.hasNext();) {
 			PropertyRef ref = (PropertyRef) iter.next();
 			Object importedValue = null;
 			try {
 				importedValue = ref.getCurrentValue();
 			} catch (Exception e) {
 				logger.warning("exception: " + e);
 			}
 			if (value == importedValue)
 				return true;
 		}
 		return false;
 	}
 
 	@Override
 	public String toString() {
 		return "Pod@" + podId;
 	}
 
 	// TODO implement this properly with check against BeanContext facilities. a
 	// unit test even!
 	@Override
 	public int hashCode() {
 		return super.hashCode();
 		// the code below breaks the BeanContext children facilities
 		// return new HashCodeBuilder(29, 3).append(podId).append(childPodIds)
 		// .append(children).append(vars).append(transientRefs).append(
 		// transientRefs).toHashCode();
 	}
 
 }