/*
    * Copyright 2006 Outsource Cafe, Inc.
    *
    * 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 org.javagen.agile.core.model;
  
  import java.io.Serializable;
  import java.util.ArrayList;
  import java.util.List;
  import java.util.Map;
  
  import javax.xml.bind.annotation.XmlAttribute;
  import javax.xml.bind.annotation.XmlElement;
  import javax.xml.bind.annotation.XmlElementRef;
  import javax.xml.bind.annotation.XmlID;
  import javax.xml.bind.annotation.XmlTransient;
  import javax.xml.bind.annotation.adapters.XmlJavaTypeAdapter;
  
  import org.javagen.agile.core.context.ContextHolder;
  import org.javagen.agile.core.context.DefaultContext;
  import org.javagen.agile.core.util.ModelUtil;
  import org.javagen.agile.core.util.StringUtil;
  import org.javagen.agile.core.xml.jaxb.ContextTypeAdapter;
  
  /***
   * Generic implementation of Model interface.  See <code>Model</code> for documentation.
   * Xml binding annotations are defined to support serialization of subclasses of AbstractModel.
   * 
   * @author Richard Easterling
   */
  public abstract class AbstractModel implements  Model, ContextHolder, Serializable {
  
  	protected String name;
  	protected String id;
  	protected String modelType;
  	protected Map<String, Object> context;
  	protected Model parentModel;
  	protected List<Model> childModels;
      
      public AbstractModel() { }
      
      public AbstractModel(String name) {
          setName(name);
      }
  	
      @XmlAttribute
  	public String getName() {
  		return name;
  	}
  
  	public void setName(String name) {
  		this.name = name;
  	}
  
      @XmlAttribute @XmlID
  	public String getId() {
  		return id;
  	}
  
  	public void setId(String id) {
  		this.id = id;
  	}
  	
      @XmlAttribute
      public String getModelType() {
          return modelType;
      }
  
      public void setModelType(String modelType) {
          this.modelType = modelType;
      }
          
      ////////////////////////////////////////////////////////////////////////////
      // misc methods:
      ////////////////////////////////////////////////////////////////////////////
      
      @Override
      public String toString() {
          StringBuilder sb = new StringBuilder();
          sb.append(StringUtil.lastToken(this.getClass().getName(), '.'));
          sb.append("[name=").append(getName());
          if (getId()!=null)
              sb.append(", id=").append(getId());
          if (this.getModelType()!=null)
              sb.append(", modelType=").append(getModelType());
          sb.append("]");
          return sb.toString();
      }
 
     @Override
     public boolean equals(Object obj) {
         if ( ! (obj instanceof Model) )
             return false;
         Model other = (Model)obj;
         if ((name!=null && !name.equals(other.getName())) || other.getName()!=null)
             return false;
         if ((id!=null && !id.equals(other.getId())) || other.getId()!=null)
             return false;
         if ((modelType!=null && !modelType.equals(other.getModelType())) || other.getModelType()!=null)
             return false;
 //        if ( (childModels==null ? 0 : childModels.size()) != (other.getChildModels()==null ? 0 : other.getChildModels().size()))
 //            return false;
         return true;
     }
 
 	////////////////////////////////////////////////////////////////////////////
 	// Model tree creation and navigation:
 	////////////////////////////////////////////////////////////////////////////
 	
     //@XmlIDREF
     //@XmlElement(type=AbstractModel.class)
     @XmlTransient
 	public Model getParentModel() {
 		return parentModel;
 	}
 	
 	public void setParentModel(Model parentModel) { 
 		this.parentModel = parentModel;
 	}
 	
     /***
      * @return the assigned List or if null an immutable empty list constant.
      */
     @XmlElementRef(type=AbstractModel.class)
     public List<Model> getChildModels() {
         if (childModels==null)
             childModels = new ArrayList<Model>();
 		return childModels;
 	}
 	
     /***
      * Set child models, making sure the parent is set.
      */
 	public void setChildModels(List<Model> childModels) {
         this.childModels = childModels;
         if (childModels!=null) {
             for(Model child : this.childModels)
                 child.setParentModel(this);
         }
 	}
 
     /***
      * Add child model, making sure the parent is set.
      */
 	public void addChildModel(Model child) {
 		if (childModels == null)
 			childModels = new ArrayList<Model>();
 		childModels.add(child);
 		child.setParentModel(this);
 	}
 	
 	public Model lookupChildByName(String name) {
 		return ModelUtil.lookupChildByName(this, name, false);
 	}
 
     public List<Model> allOwnedModels() {
         return getChildModels();
     }
     
 	////////////////////////////////////////////////////////////////////////////
 	// Model context:
 	////////////////////////////////////////////////////////////////////////////
 	
     public Object get(String key) {
         return context == null ? null : context.get(key);
     }
 
     public void put(String key, Object value) {
         if (context == null) {
             context = new DefaultContext();
         }
         context.put(key, value);
 
     }
 
     @XmlElement 
     @XmlJavaTypeAdapter(ContextTypeAdapter.class)
 	public Map<String,Object> getContext() {
 		return context;
 	}
 
 	public void setContext(Map<String,Object> context) {
 		this.context = context;
 	}
 
 	////////////////////////////////////////////////////////////////////////////
 	// template customization method:
 	////////////////////////////////////////////////////////////////////////////
 	
 	public void copyTo(Model target) {
 		if (target==null)
 			throw new IllegalArgumentException("target can not be null");
         if (this.getName()!=null && (target.getName()==null || !this.getName().equals(target.getName())))
             target.setName(this.getName());
         if (this.getId()!=null && target.getId()==null) //id should normally be set explicitly
             target.setId(this.getId());
         if (this.getModelType()!=null && target.getModelType()==null) //has a default value which we usually don't want
             target.setModelType(this.getModelType());
         if (this.getContext()!=null) {
             for(String key : this.getContext().keySet()) {
                 Object value = this.getContext().get(key);
                 target.put(key, value);
             }
         }
 	}
     
 }