package org.kuali.rice.krms.api.repository;
   
   import java.io.Serializable;
   import java.util.Arrays;
   import java.util.Collection;
   import java.util.Collections;
   
   import javax.xml.bind.annotation.XmlAccessType;
   import javax.xml.bind.annotation.XmlAccessorType;
  import javax.xml.bind.annotation.XmlAnyElement;
  import javax.xml.bind.annotation.XmlElement;
  import javax.xml.bind.annotation.XmlRootElement;
  import javax.xml.bind.annotation.XmlType;
  
  import org.apache.commons.lang.StringUtils;
  import org.apache.commons.lang.builder.EqualsBuilder;
  import org.apache.commons.lang.builder.HashCodeBuilder;
  import org.apache.commons.lang.builder.ToStringBuilder;
  import org.kuali.rice.core.api.CoreConstants;
  import org.kuali.rice.core.api.mo.ModelBuilder;
  import org.kuali.rice.core.api.mo.ModelObjectComplete;
  
  /**
   * Concrete model object implementation of KRMS Proposition Parameter 
   * immutable. 
   * Instances of PropositionParameter can be (un)marshalled to and from XML.
   *
   * @see PropositionParameterContract
   */
  @XmlRootElement(name = PropositionParameter.Constants.ROOT_ELEMENT_NAME)
  @XmlAccessorType(XmlAccessType.NONE)
  @XmlType(name = PropositionParameter.Constants.TYPE_NAME, propOrder = {
  		PropositionParameter.Elements.ID,
  		PropositionParameter.Elements.PROP_ID,
  		PropositionParameter.Elements.VALUE,
  		PropositionParameter.Elements.PARM_TYPE,
  		PropositionParameter.Elements.SEQUENCE,
  		CoreConstants.CommonElements.FUTURE_ELEMENTS
  })
  public final class PropositionParameter implements PropositionParameterContract, ModelObjectComplete{
  	private static final long serialVersionUID = 2783959459503209577L;
  
  	@XmlElement(name = Elements.ID, required=true)
  	private String id;
  	@XmlElement(name = Elements.PROP_ID, required=true)
  	private String propId;
  	@XmlElement(name = Elements.VALUE, required=true)
  	private String value;
  	@XmlElement(name = Elements.PARM_TYPE, required=true)
  	private String parameterType;
  	@XmlElement(name = Elements.SEQUENCE, required=true)
  	private Integer sequenceNumber;
  	
  	@SuppressWarnings("unused")
      @XmlAnyElement
      private final Collection<org.w3c.dom.Element> _futureElements = null;
  	
  	 /** 
       * This constructor should never be called.  
       * It is only present for use during JAXB unmarshalling. 
       */
      private PropositionParameter() {
      	this.id = null;
      	this.propId = null;
      	this.value = null;
      	this.parameterType = null;
      	this.sequenceNumber = null;
      }
      
      /**
  	 * Constructs a PropositionParameter from the given builder.  
  	 * This constructor is private and should only ever be invoked from the builder.
  	 * 
  	 * @param builder the Builder from which to construct the PropositionParameter
  	 */
      private PropositionParameter(Builder builder) {
          this.id = builder.getId();
          this.propId = builder.getPropId();
          this.value = builder.getValue();
          this.parameterType = builder.getParameterType();
          this.sequenceNumber = builder.getSequenceNumber();
      }
      
  	@Override
  	public String getId() {
  		return this.id;
  	}
  	
  	@Override
  	public String getPropId() {
  		return this.propId;
  	}
  
  	@Override
  	public String getValue() {
  		return this.value;
  	}
  
  	@Override
 	public String getParameterType() {
 		return this.parameterType;
 	}
 	@Override
 	public Integer getSequenceNumber() {
 		return this.sequenceNumber; 
 	}
 
 	/**
      * This builder is used to construct instances of PropositionParameter.  
      * It enforces the constraints of the {@link PropositionParameterContract}.
      */
     public static class Builder implements PropositionParameterContract, ModelBuilder, Serializable {
     	private static final long serialVersionUID = -6889320709850568900L;
 		
 		private String id;
         private String propId;
         private String value;
         private String parameterType;
         private Integer sequenceNumber;
 
 		/**
 		 * Private constructor for creating a builder with all of it's required attributes.
 		 */
         private Builder(String id, String propId, String value, String parameterType, Integer sequenceNumber) {
             setId(id);
             setPropId(propId);
             setValue(value);
             setParameterType(parameterType);
 			setSequenceNumber(sequenceNumber);
         }
 
         public static Builder create(String id, String propId, String value, String parameterType, Integer sequenceNumber) {
         	return new Builder(id, propId, value, parameterType, sequenceNumber);
         }
 
         /**
          * Creates a builder by populating it with data from the given {@link PropositionParameterContract}.
          * 
          * @param contract the contract from which to populate this builder
          * @return an instance of the builder populated with data from the contract
          */
         public static Builder create(PropositionParameterContract contract) {
         	if (contract == null) {
                 throw new IllegalArgumentException("contract is null");
             }
             Builder builder =  new Builder(contract.getId(), contract.getPropId(), contract.getValue(), contract.getParameterType(), contract.getSequenceNumber());
             return builder;
         }
 
 		/**
 		 * Sets the value of the id on this builder to the given value.
 		 * 
 		 * @param id the id value to set, must not be null or blank
 		 * @throws IllegalArgumentException if the id is null or blank
 		 */
         public void setId(String id) {
             if (StringUtils.isBlank(id)) {
                 throw new IllegalArgumentException("id is blank");
             }
             this.id = id;
         }
 
 		public void setPropId(String propId) {
             if (StringUtils.isBlank(propId)) {
                 throw new IllegalArgumentException("propId is blank");
             }
 			this.propId = propId;
 		}
 
 		public void setValue(String value) {
 			// TODO:  isBlank  or is null ???
             if (StringUtils.isBlank(value)) {
                 throw new IllegalArgumentException("value is blank");
             }
 			this.value = value;
 		}
 		
 		public void setParameterType(String parameterType) {
 			if (StringUtils.isBlank(parameterType)){
 	                throw new IllegalArgumentException("parameter type is null or blank");
 			}
 			if (!PropositionParameter.ParameterTypes.VALID_TYPE_CODES.contains(parameterType)){
                 throw new IllegalArgumentException("parameter type is invalid");				
 			}
 			// TODO: check against valid values
 			this.parameterType = parameterType;
 		}
 		
 		public void setSequenceNumber(Integer sequenceNumber) {
 			if (sequenceNumber == null) {
                 throw new IllegalArgumentException("parameter type is blank");				
 			}
 			this.sequenceNumber = sequenceNumber;
 		}
 
 		@Override
 		public String getId() {
 			return id;
 		}
 
 		@Override
 		public String getPropId() {
 			return propId;
 		}
 
 		@Override
 		public String getValue() {
 			return value;
 		}
 
 		@Override
 		public String getParameterType() {
 			return parameterType;
 		}
 
 		@Override
 		public Integer getSequenceNumber() {
 			return sequenceNumber;
 		}
 
 		/**
 		 * Builds an instance of a PropositionParameter based on the current state of the builder.
 		 * 
 		 * @return the fully-constructed PropositionParameter
 		 */
         @Override
         public PropositionParameter build() {
             return new PropositionParameter(this);
         }
 		
     }
 	@Override
 	public int hashCode() {
 		return HashCodeBuilder.reflectionHashCode(this, Constants.HASH_CODE_EQUALS_EXCLUDE);
 	}
 
 	@Override
 	public boolean equals(Object obj) {
 		return EqualsBuilder.reflectionEquals(obj, this, Constants.HASH_CODE_EQUALS_EXCLUDE);
 	}
 
 	@Override
 	public String toString() {
 		return ToStringBuilder.reflectionToString(this);
 	}
 	
 	/**
 	 * Defines some internal constants used on this class.
 	 */
 	static class Constants {
 		final static String ROOT_ELEMENT_NAME = "PropositionParameter";
 		final static String TYPE_NAME = "PropositionParameterType";
 		final static String[] HASH_CODE_EQUALS_EXCLUDE = { CoreConstants.CommonElements.FUTURE_ELEMENTS };
 	}
 	
 	/**
 	 * A private class which exposes constants which define the XML element names to use
 	 * when this object is marshalled to XML.
 	 */
 	public static class Elements {
 		final static String ID = "id";
 		final static String PROP_ID = "propId";
 		final static String VALUE = "value";
 		final static String PARM_TYPE = "parameterType";
 		final static String SEQUENCE = "sequenceNumber";
 	}
 	
 	/**
 	 * This enumeration identifies the valid PropositionParameter parameter type codes 
 	 */
 	public enum ParameterTypes {
 		CONSTANT("C"),
 		TERM("T"),
 		FUNCTION("F");
 		
 		private final String code;
 		private ParameterTypes(String code){
 			this.code = code;
 		}
 		public static final Collection<PropositionParameter.ParameterTypes> VALID_TYPES =
 			Collections.unmodifiableCollection(Arrays.asList(CONSTANT, TERM, FUNCTION));
 			
 		public static final Collection<String> VALID_TYPE_CODES =
 			Collections.unmodifiableCollection(Arrays.asList(CONSTANT.code(), TERM.code(), FUNCTION.code()));
 			
 		public String code(){
 			return code;
 		}
 		@Override
 		public String toString() {
 			return code;
 		}		
 	}
 }