View Javadoc
1   /**
2    * Copyright 2005-2016 The Kuali Foundation
3    *
4    * Licensed under the Educational Community License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    *
8    * http://www.opensource.org/licenses/ecl2.php
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   */
16  package org.kuali.rice.core.api.criteria;
17  
18  import org.apache.commons.lang.StringUtils;
19  import org.kuali.rice.core.api.CoreConstants;
20  import org.w3c.dom.Element;
21  
22  import javax.xml.bind.annotation.XmlAccessType;
23  import javax.xml.bind.annotation.XmlAccessorType;
24  import javax.xml.bind.annotation.XmlAnyElement;
25  import javax.xml.bind.annotation.XmlAttribute;
26  import javax.xml.bind.annotation.XmlElement;
27  import javax.xml.bind.annotation.XmlElements;
28  import javax.xml.bind.annotation.XmlRootElement;
29  import javax.xml.bind.annotation.XmlType;
30  import java.util.Collection;
31  import java.util.Collections;
32  import java.util.HashSet;
33  import java.util.Set;
34  
35  /**
36   * An immutable predicate which represents a "not in" statement which is
37   * evaluated against a list of values.
38   * 
39   * @see PredicateFactory for a convenient way to construct this class.
40   * 
41   * @author Kuali Rice Team (rice.collab@kuali.org)
42   */
43  @XmlRootElement(name = NotInPredicate.Constants.ROOT_ELEMENT_NAME)
44  @XmlAccessorType(XmlAccessType.NONE)
45  @XmlType(name = NotInPredicate.Constants.TYPE_NAME, propOrder = {
46      CriteriaSupportUtils.PropertyConstants.VALUES,
47      CoreConstants.CommonElements.FUTURE_ELEMENTS
48  })
49  public final class NotInPredicate extends AbstractPredicate implements MultiValuedPredicate {
50  
51  	private static final long serialVersionUID = -7676442296587603655L;
52  	
53  	@XmlAttribute(name = CriteriaSupportUtils.PropertyConstants.PROPERTY_PATH)
54  	private final String propertyPath;
55  
56  	@XmlElements(value = {
57              @XmlElement(name = CriteriaStringValue.Constants.ROOT_ELEMENT_NAME, type = CriteriaStringValue.class, required = true),
58              @XmlElement(name = CriteriaDateTimeValue.Constants.ROOT_ELEMENT_NAME, type = CriteriaDateTimeValue.class, required = true),
59              @XmlElement(name = CriteriaIntegerValue.Constants.ROOT_ELEMENT_NAME, type = CriteriaIntegerValue.class, required = true),
60              @XmlElement(name = CriteriaKualiDecimalValue.Constants.ROOT_ELEMENT_NAME, type = CriteriaKualiDecimalValue.class, required = true),
61              @XmlElement(name = CriteriaKualiPercentValue.Constants.ROOT_ELEMENT_NAME, type = CriteriaKualiPercentValue.class, required = true),
62              @XmlElement(name = CriteriaDecimalValue.Constants.ROOT_ELEMENT_NAME, type = CriteriaDecimalValue.class, required = true)
63  	})
64  	private final Set<? extends CriteriaValue<?>> values;
65  
66      @SuppressWarnings("unused")
67      @XmlAnyElement
68      private final Collection<Element> _futureElements = null;
69  
70  	/**
71       * Should only be invoked by JAXB.
72       */
73      @SuppressWarnings("unused")
74      private NotInPredicate() {
75          this.propertyPath = null;
76          this.values = null;
77      }
78      
79      /**
80  	 * Constructs a NotInPredicate for the given propertyPath and list of criteria values.
81  	 * 
82  	 * @param propertyPath the property path for the predicate, must not be null or blank
83  	 * @param values the list of criteria values to use for this predicate, must be non-null,
84  	 * non-empty, and all CriteriaValues contained within must be of the same type.
85  	 * 
86  	 * @throws IllegalArgumentException if the propertyPath is null or blank
87  	 * @throws IllegalArgumentException if the list of values is null, empty, or contains {@link CriteriaValue} of different types
88  	 */
89      NotInPredicate(String propertyPath, Set<? extends CriteriaValue<?>> values) {
90      	if (StringUtils.isBlank(propertyPath)) {
91  			throw new IllegalArgumentException("Property path cannot be null or blank.");
92  		}
93      	CriteriaSupportUtils.validateValuesForMultiValuedPredicate(values);
94  		this.propertyPath = propertyPath;
95  
96          if (values == null) {
97              this.values = Collections.emptySet();
98          } else {
99              final Set<CriteriaValue<?>> temp = new HashSet<CriteriaValue<?>>();
100             for (CriteriaValue<?> value: values) {
101                 if (value != null) {
102                     temp.add(value);
103                 }
104             }
105             this.values = Collections.unmodifiableSet(temp);
106         }
107     }
108 
109     @Override
110     public String getPropertyPath() {
111     	return propertyPath;
112     }
113     
114     @Override
115     public Set<CriteriaValue<?>> getValues() {
116     	return Collections.unmodifiableSet(values);
117     }
118         
119 	/**
120      * Defines some internal constants used on this class.
121      */
122     static class Constants {
123         final static String ROOT_ELEMENT_NAME = "notIn";
124         final static String TYPE_NAME = "NotInType";
125     }
126 
127     @Override
128     public String toString() {
129         return CriteriaSupportUtils.toString(this);
130     }
131 }