/**
    * Copyright 2005-2011 The Kuali Foundation
    *
    * Licensed under the Educational Community 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.opensource.org/licenses/ecl2.php
    *
   * 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.kuali.rice.core.api.criteria;
  
  import org.kuali.rice.core.api.CoreConstants;
  import org.w3c.dom.Element;
  
  import javax.xml.bind.annotation.XmlAccessType;
  import javax.xml.bind.annotation.XmlAccessorType;
  import javax.xml.bind.annotation.XmlAnyElement;
  import javax.xml.bind.annotation.XmlAttribute;
  import javax.xml.bind.annotation.XmlElement;
  import javax.xml.bind.annotation.XmlElements;
  import javax.xml.bind.annotation.XmlRootElement;
  import javax.xml.bind.annotation.XmlType;
  import java.util.Collection;
  
  /**
   * An immutable predicate which represents a "not equal" statement which is
   * evaluated the {@link CriteriaValue} of this predicate.
   * 
   * @see PredicateFactory for a convenient way to construct this class.
   * 
   * @author Kuali Rice Team (rice.collab@kuali.org)
   *
   */
  @XmlRootElement(name = NotEqualPredicate.Constants.ROOT_ELEMENT_NAME)
  @XmlAccessorType(XmlAccessType.NONE)
  @XmlType(name = NotEqualPredicate.Constants.TYPE_NAME, propOrder = {
      CriteriaSupportUtils.PropertyConstants.VALUE,
      CoreConstants.CommonElements.FUTURE_ELEMENTS
  })
  public final class NotEqualPredicate extends AbstractPredicate implements SingleValuedPredicate {
  	
  	private static final long serialVersionUID = 7159459561133496549L;
  	
  	@XmlAttribute(name = CriteriaSupportUtils.PropertyConstants.PROPERTY_PATH)
  	private final String propertyPath;
  
  	@XmlElements(value = {
      		@XmlElement(name = CriteriaStringValue.Constants.ROOT_ELEMENT_NAME, type = CriteriaStringValue.class, required = true),
      		@XmlElement(name = CriteriaDateTimeValue.Constants.ROOT_ELEMENT_NAME, type = CriteriaDateTimeValue.class, required = true),
      		@XmlElement(name = CriteriaDecimalValue.Constants.ROOT_ELEMENT_NAME, type = CriteriaDecimalValue.class, required = true),
      		@XmlElement(name = CriteriaIntegerValue.Constants.ROOT_ELEMENT_NAME, type = CriteriaIntegerValue.class, required = true)
      })
  	private final CriteriaValue<?> value;
  
      @SuppressWarnings("unused")
      @XmlAnyElement
      private final Collection<Element> _futureElements = null;
  
      /**
       * Should only be invoked by JAXB.
       */
      @SuppressWarnings("unused")
      private NotEqualPredicate() {
          this.propertyPath = null;
          this.value = null;
      }
      
      /**
  	 * Constructs a NotEqualPredicate for the given path and value.  NotEqualPredicate supports the following {@link CriteriaValue}:
  	 * 
  	 * <ul>
  	 *   <li>{@link CriteriaStringValue}</li>
  	 *   <li>{@link CriteriaDateTimeValue}</li>
  	 *   <li>{@link CriteriaDecimalValue}</li>
  	 *   <li>{@link CriteriaIntegerValue}</li>
  	 * </ul>
  	 * 
  	 * @param propertyPath the property path for the predicate, must not be null or blank
  	 * @param value the value to evaluation the path against, must not be null.
  	 * 
  	 * @throws IllegalArgumentException if the propertyPath is null or blank
  	 * @throws IllegalArgumentException if the value is null
  	 * @throws IllegalArgumentException if this predicate does not support the given type of {@link CriteriaValue}
  	 */
      NotEqualPredicate(String propertyPath, CriteriaValue<?> value) {
      	CriteriaSupportUtils.validateValuedConstruction(getClass(), propertyPath, value);
  		this.propertyPath = propertyPath;
  		this.value = value;
      }
          
      @Override
      public String getPropertyPath() {
      	return propertyPath;
     }
     
 	@Override
 	public CriteriaValue<?> getValue() {
 		return value;
 	}
     
 	/**
      * Defines some internal constants used on this class.
      */
     static class Constants {
         final static String ROOT_ELEMENT_NAME = "notEqual";
         final static String TYPE_NAME = "NotEqualType";
     }
 
     @Override
     public String toString() {
         return CriteriaSupportUtils.toString(this);
     }
 }