/***
    * Copyright (C) 2006 Philipp Mpalampanis
    *
    * License: MPL 1.1/GPL 2.0/LGPL 2.1
    *
    * The contents of this file are subject to the Mozilla Public License Version
    * 1.1 (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.mozilla.org/MPL/
   *
   * Software distributed under the License is distributed on an "AS IS" basis,
   * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
   * for the specific language governing rights and limitations under the
   * License.
   *
   * Alternatively, the contents of this file may be used under the terms of
   * either the GNU General Public License Version 2 or later (the "GPL"), or
   * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
   * in which case the provisions of the GPL or the LGPL are applicable instead
   * of those above. If you wish to allow use of your version of this file only
   * under the terms of either the GPL or the LGPL, and not to allow others to
   * use your version of this file under the terms of the MPL, indicate your
   * decision by deleting the provisions above and replace them with the notice
   * and other provisions required by the GPL or the LGPL. If you do not delete
   * the provisions above, a recipient may use your version of this file under
   * the terms of any one of the MPL, the GPL or the LGPL.
   */
  package net.sf.echobinding.binding;
  
  import java.beans.*;
  import java.io.Serializable;
  import java.util.*;
  
  import net.sf.echobinding.BoundControl;
  import net.sf.echobinding.decorator.Decorator;
  import net.sf.echobinding.format.Format;
  import net.sf.echobinding.model.PresentationModel;
  
  /***
   *
   */
  public abstract class AbstractBindingContext implements BindingContext, Serializable {
  
  	private BindingContext _parent;
  	private Set<BindingContext> _childs;
  	protected HashMap<String, PropertyAdapter> _adapters = new HashMap<String, PropertyAdapter>();
  	private HashMap<String, BoundControl> _controls;
  	protected PropertyChangeSupport _changes = new PropertyChangeSupport(this);
  
  	private PresentationModel _presentationModel;
  	
  	/*
  	 * (non-Javadoc)
  	 * 
  	 * @see echobinding.BindingContext#add(java.lang.String,
  	 *      echobinding.Binding)
  	 */
  	public BindingContext add(String id, PropertyAdapter binding) {
  		binding.setId(id);
  		_adapters.put(id, binding);
  		return this;
  	}
  	
  	/*
  	 * (non-Javadoc)
  	 * 
  	 * @see echobinding.BindingContext#remove(java.lang.String)
  	 */
  	public PropertyAdapter remove(String id) {
  		return _adapters.remove(id);
  	}
  
  	
  	/***
  	 * Adds a child to the set of child contexts.
  	 * 
  	 * @param child
  	 */
  	public void addChild(BindingContext child) {
  		getChilds().add(child);
  	}
  
  	/***
  	 * @return Returns the childs.
  	 */
  	public Set<BindingContext> getChilds() {
  		if( _childs == null)
  			_childs = new HashSet<BindingContext>();
  		return _childs;
  	}
  
  	/***
  	 * Sets the child contexts.
  	 * 
  	 * @param childs The childs to set.
  	 */
  	public void setChilds(Set<BindingContext> childs) {
  		_childs = childs;
  	}
 
 	/***
 	 * @return Returns the parent binding context.
 	 */
 	public BindingContext getParent() {
 		return _parent;
 	}
 
 	/***
 	 * Sets the parent binding context.
 	 * 
 	 * @param parent The parent binding context to set.
 	 */
 	public void setParent(BindingContext parent) {
 		_parent = parent;
 	}
 
 	public List<PropertyAdapter> getPropertyAdapters() {
 		ArrayList<PropertyAdapter> list = new ArrayList<PropertyAdapter>();
 		for (String bindingId : _adapters.keySet()) {
 			list.add(_adapters.get(bindingId));
 		}
 		return list;
 	}
 
 	public Decorator getDecorator(String id) {
 		return getAdapter(id).getDecorator();
 	}
 
 	public Format getFormat(String id) {
 		return getAdapter(id).getFormat();
 	}
 
 	/***
 	 * Adds a control to the list of registered controls and registers the
 	 * control as PropertyChangeListener at this context.
 	 */
 	public void registerControl(String id, BoundControl control) {
 		if( _controls == null )
 			_controls = new HashMap<String,BoundControl>();
 		
 		addPropertyChangeListener(id, control);
 		
 		_controls.put(id, control);
 	}
 	
 	public void removeControl(BoundControl control) {
 		if( _controls != null )
 			_controls.remove(control);
 	}
 
 
 	public BoundControl getControl(String id) {
 		if( _controls == null )
 			return null;
 		return _controls.get(id);
 	}
 
 	public Set<BoundControl> getControls() {
 		if(_controls == null)
 			return new HashSet<BoundControl>(); 
 		return new HashSet<BoundControl>( _controls.values() );
 	}
 
 	
 	
 	/***
 	 * 
 	 * @param bindingId
 	 * @param oldValue
 	 * @param newValue
 	 * @throws BindingException
 	 */
 	protected void firePropertyChange(String bindingId, Object oldValue, Object newValue) throws BindingException {
 
 		PropertyChangeEvent event = new PropertyChangeEvent(this, bindingId,
 				getValue(bindingId), newValue);
 
 		
 		firePropertyChange(event);
 	}
 
 	protected void firePropertyChange(PropertyChangeEvent event) throws BindingException {
 		
 		notifyPropertyChangeListener(event);
 		
 		notifyParentContext( event );
 		
 		notifiyChildContexts( event );
 	}
 	
 	
 
 	/***
 	 * Sends a property change event to all child contexts.
 	 * 
 	 * @param event
 	 */
 	private void notifiyChildContexts(PropertyChangeEvent event) {
 		Object source = event.getSource();
 		
 		PropertyChangeEvent newEvent = replaceSender( event );
 		
 		// notify all child contexts
 		for( BindingContext child : getChilds() ) {
 			if( ! (source==null || source.equals(child)))
 				child.propertyChange(newEvent);
 		}
 	}
 
 	/***
 	 * Sends a property change event to the parent context.
 	 *  
 	 * @param event
 	 */
 	private void notifyParentContext(PropertyChangeEvent event) {
 		
 		Object source = event.getSource();
 		
 		PropertyChangeEvent newEvent = replaceSender( event );
 		
 		// notify parent context
 		if( ! ( getParent()==null || source.equals(getParent())) )
 			getParent().propertyChange(newEvent);
 	}
 
 	/***
 	 * @param event
 	 * @return
 	 */
 	private PropertyChangeEvent replaceSender(PropertyChangeEvent event) {
 		if(event.getSource().equals(this))
 			return event;
 		PropertyChangeEvent newEvent = new PropertyChangeEvent(this, event.getPropertyName(), event.getOldValue(), event.getNewValue());
 		return newEvent;
 	}
 
 	
 	/***
 	 * 
 	 */
 	public void propertyChange(PropertyChangeEvent event) {
 		
 		notifyPropertyChangeListener( event );
 		
 		notifiyChildContexts(event);
 		
 		notifyParentContext(event);
 	}
 
 	/***
 	 *  
 	 */
 	private void notifyPropertyChangeListener(PropertyChangeEvent event) {
 		PropertyChangeEvent newEvent = replaceSender(event);
 		
 		// TODO: refactor change notification
 		for (PropertyChangeListener listener : _changes.getPropertyChangeListeners(event.getPropertyName()) ) {
 			if (!listener.equals(event.getSource()))	// do not propagate events back to origin
 				listener.propertyChange(newEvent);
 		}
 
 		for (PropertyChangeListener listener : _changes.getPropertyChangeListeners() ) {
 			if (!listener.equals(event.getSource()))	// do not propagate events back to origin
 				listener.propertyChange(newEvent);
 		}
 		
 		
 	}
 
 
 	
 	/***
 	 * 
 	 */
 	public void addPropertyChangeListener(PropertyChangeListener listener) {
 		_changes.addPropertyChangeListener(listener);
 	}
 
 	/***
 	 * Add listener for the specified property name.
 	 * 
 	 * @param propertyName
 	 * @param listener
 	 */
 	public void addPropertyChangeListener(String propertyName, PropertyChangeListener listener) {
 		_changes.addPropertyChangeListener(propertyName, listener);
 	}
 
 	/***
 	 * 
 	 */
 	public void removePropertyChangeListener(PropertyChangeListener listener) {
 		_changes.removePropertyChangeListener(listener);
 	}
 
 	/***
 	 * Remove listeners for the given property name. 
 	 * 
 	 * @param propertyName
 	 * @param listener
 	 */
 	public void removePropertyChangeListener(String propertyName, PropertyChangeListener listener) {
 		_changes.removePropertyChangeListener(propertyName, listener);
 	}
 
 	/* (non-Javadoc)
 	 * @see echobinding.binding.BindingContext#synchronize()
 	 */
 	public void synchronize() {
 		// synchronize this context
 		for(BoundControl widget: getControls()) {
 			widget.save();
 		}
 		// .. and all its childs
 		for(BindingContext child: getChilds()) {
 			child.synchronize();
 		}
 	}
 
 	/* (non-Javadoc)
 	 * @see echobinding.binding.BindingContext#isValid()
 	 */
 	public boolean isValid() {
 		
 		// check this context 
 		for(BoundControl widget: getControls()) {
 			if( ! widget.isValid() )
 				return false;
 		}
 		// .. and all its childs
 		for(BindingContext child: getChilds()) {
 			if( ! child.isValid() )
 				return false;
 		}
 		return true;
 	}
 	
 	
 	/* (non-Javadoc)
 	 * @see echobinding.binding.BindingContext#isDirty()
 	 */
 	public boolean isDirty() {
 		// check this context 
 		for(BoundControl widget: getControls()) {
 			if( widget.isDirty() )
 				return true;
 		}
 		// .. and all its child contexts
 		for(BindingContext child: getChilds()) {
 			if( child.isDirty() )
 				return true;
 		}
 		return false;
 	}
 	
 	/* (non-Javadoc)
 	 * @see echobinding.binding.BindingContext#reload()
 	 */
 	public void update() {
 		// reset the widget's state 
 		for(BoundControl widget: getControls()) {
 			widget.update();
 		}
 		// .. reset child contexts
 		for(BindingContext child: getChilds()) {
 			child.update();
 		}
 	}
 	
 	
 
 	/* (non-Javadoc)
 	 * @see echobinding.binding.BindingContext#validate()
 	 */
 	public void validate() {
 		// validate this context 
 		for(BoundControl widget: getControls()) {
 			widget.validateInput();
 		}
 		// .. and all its childs
 		for(BindingContext child: getChilds()) {
 			child.validate();
 		}
 	}
 
 	public boolean removeChild(BindingContext context) {
 		return _childs.remove(context);
 	}
 
 	/***
 	 * @return Returns the presentationModel.
 	 */
 	public PresentationModel getPresentationModel() {
 		return _presentationModel;
 	}
 
 	/***
 	 * @param presentationModel The presentationModel to set.
 	 */
 	public void setPresentationModel(PresentationModel presentationModel) {
 		_presentationModel = presentationModel;
 		_presentationModel.setContext(this);
 	}
 
 	
 }