Coverage Report

Coverage Report - org.kuali.rice.kew.docsearch.SearchAttributeCriteriaComponent

Classes in this File

Line Coverage

Branch Coverage

Complexity

SearchAttributeCriteriaComponent

0/69

0/10

1.129

 /*
  * Copyright 2005-2008 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.kew.docsearch;
 
 import java.io.Serializable;
 import java.util.List;
 
 import org.apache.commons.lang.StringUtils;
 import org.kuali.rice.kew.util.Utilities;
 
 
 /**
  *
  * @author Kuali Rice Team (rice.collab@kuali.org)
  */
 public class SearchAttributeCriteriaComponent implements Serializable {
     private static final org.apache.log4j.Logger LOG = org.apache.log4j.Logger.getLogger(SearchAttributeCriteriaComponent.class);
         
         private static final long serialVersionUID = -5927435567057306529L;
 
         private String formKey;  // this if the field that is used in the UI for the form
     private String value;
     private List<String> values;
     private String lookupableFieldType;
     private boolean caseSensitive = false;
     private boolean searchInclusive = true;  // not just for ranges... used by single date searches
     private SearchableAttributeValue searchableAttributeValue;
     private boolean searchable = true;
     private boolean canHoldMultipleValues = false;
     
     // range properties
     private boolean rangeSearch = false;
     private boolean allowInlineRange = false;
     // this is the field that is saved to the database
     private String savedKey;
 
         /**
          * @param formKey key value associated with the search form
          * @param value value the user is searching on
          * @param savedKey key value associated with the value saved in the database
          */
         public SearchAttributeCriteriaComponent(String formKey, String value, boolean rangeSearch) {
                 super();
                 this.formKey = formKey;
                 this.value = value;
                 this.rangeSearch = rangeSearch;
                 if (!rangeSearch) {
                         this.savedKey = formKey;
                 }
         }
         
         /**
          * @param formKey key value associated with the search form
          * @param value value the user is searching on
          * @param savedKey key value associated with the value saved in the database
          */
         public SearchAttributeCriteriaComponent(String formKey, String value, String savedKey) {
                 super();
                 this.formKey = formKey;
                 this.value = value;
                 this.savedKey = savedKey;
         }
         
         /**
          * @param formKey key value associated with the search form
          * @param value value the user is searching on
          * @param savedKey key value associated with the value saved in the database
          * @param searchableAttributeValue
          */
         public SearchAttributeCriteriaComponent(String formKey, String value, String savedKey, SearchableAttributeValue searchableAttributeValue) {
                 super();
                 this.formKey = formKey;
                 this.value = value;
                 this.savedKey = savedKey;
                 this.searchableAttributeValue = searchableAttributeValue;
         }
         
         public boolean isComponentLowerBoundValue() {
                 return isComponentGivenBoundValue(SearchableAttribute.RANGE_LOWER_BOUND_PROPERTY_PREFIX);
         }
         
         public boolean isComponentUpperBoundValue() {
                 return isComponentGivenBoundValue(SearchableAttribute.RANGE_UPPER_BOUND_PROPERTY_PREFIX);
         }
         
         private boolean isComponentGivenBoundValue(String boundKeyPrefix) {
                 if (!isRangeSearch()) {
                         String errorMsg = "Criteria Component with formKey value '" + formKey + "' is not part of a range search";
                         LOG.error("isComponentGivenBoundValue() " + errorMsg);
                         throw new RuntimeException(errorMsg);
                 }
                 return formKey.indexOf(boundKeyPrefix) == 0;
         }
     
     public boolean isNonBlankValueGiven() {
         return ( (StringUtils.isNotBlank(getValue())) || (!Utilities.isEmpty(getValues())) );
     }
 
         /**
      * @return the canHoldMultipleValues
      */
     public boolean isCanHoldMultipleValues() {
         return canHoldMultipleValues;
     }
 
     /**
      * @param canHoldMultipleValues the canHoldMultipleValues to set
      */
     public void setCanHoldMultipleValues(boolean canHoldMultipleValues) {
         this.canHoldMultipleValues = canHoldMultipleValues;
     }
 
     /**
      * @return the searchable
      */
     public boolean isSearchable() {
         return searchable;
     }
 
     /**
      * @param searchable the searchable to set
      */
     public void setSearchable(boolean searchable) {
         this.searchable = searchable;
     }
 
         /**
          * @return the caseSensitive
          */
         public boolean isCaseSensitive() {
                 return caseSensitive;
         }
 
         /**
          * @param caseSensitive the caseSensitive to set
          */
         public void setCaseSensitive(boolean caseSensitive) {
                 this.caseSensitive = caseSensitive;
         }
 
         /**
          * @return the formKey
          */
         public String getFormKey() {
                 return formKey;
         }
 
         /**
          * @param formKey the formKey to set
          */
         public void setFormKey(String formKey) {
                 this.formKey = formKey;
         }
 
         /**
          * @return the rangeSearch
          */
         public boolean isRangeSearch() {
                 return rangeSearch;
         }
 
         /**
          * @param rangeSearch the rangeSearch to set
          */
         public void setRangeSearch(boolean rangeSearch) {
                 this.rangeSearch = rangeSearch;
         }
 
         /**
          * @return the savedKey
          */
         public String getSavedKey() {
                 return savedKey;
         }
 
         /**
          * @param savedKey the savedKey to set
          */
         public void setSavedKey(String savedKey) {
                 this.savedKey = savedKey;
         }
 
         /**
          * @return the searchableAttributeValue
          */
         public SearchableAttributeValue getSearchableAttributeValue() {
                 return searchableAttributeValue;
         }
 
         /**
          * @param searchableAttributeValue the searchableAttributeValue to set
          */
         public void setSearchableAttributeValue(
                         SearchableAttributeValue searchableAttributeValue) {
                 this.searchableAttributeValue = searchableAttributeValue;
         }
 
         /**
          * @return the searchInclusive
          */
         public boolean isSearchInclusive() {
                 return searchInclusive;
         }
 
         /**
          * @param searchInclusive the searchInclusive to set
          */
         public void setSearchInclusive(boolean searchInclusive) {
                 this.searchInclusive = searchInclusive;
         }
 
         /**
          * @return the value
          */
         public String getValue() {
                 return value;
         }
 
         /**
          * @param value the value to set
          */
         public void setValue(String value) {
                 this.value = value;
         }
 
     /**
      * @return the values
      */
     public List<String> getValues() {
         return values;
     }
 
     /**
      * @param values the values to set
      */
     public void setValues(List<String> values) {
         this.values = values;
     }
 
     /**
      * @return the lookupableFieldType
      */
     public String getLookupableFieldType() {
         return lookupableFieldType;
     }
 
     /**
      * @param lookupableFieldType the lookupableFieldType to set
      */
     public void setLookupableFieldType(String lookupableFieldType) {
         this.lookupableFieldType = lookupableFieldType;
     }
 
         /**
          * @return the allowInlineRange
          */
         public boolean isAllowInlineRange() {
                 return this.allowInlineRange;
         }
 
         /**
          * @param allowInlineRange the allowInlineRange to set
          */
         public void setAllowInlineRange(boolean allowInlineRange) {
                 this.allowInlineRange = allowInlineRange;
         }
 
 }

1		/*
2		* Copyright 2005-2008 The Kuali Foundation
3		*
4		*
5		* Licensed under the Educational Community License, Version 2.0 (the "License");
6		* you may not use this file except in compliance with the License.
7		* You may obtain a copy of the License at
8		*
9		* http://www.opensource.org/licenses/ecl2.php
10		*
11		* Unless required by applicable law or agreed to in writing, software
12		* distributed under the License is distributed on an "AS IS" BASIS,
13		* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14		* See the License for the specific language governing permissions and
15		* limitations under the License.
16		*/
17		package org.kuali.rice.kew.docsearch;
18
19		import java.io.Serializable;
20		import java.util.List;
21
22		import org.apache.commons.lang.StringUtils;
23		import org.kuali.rice.kew.util.Utilities;
24
25
26		/**
27		*
28		* @author Kuali Rice Team (rice.collab@kuali.org)
29		*/
30		public class SearchAttributeCriteriaComponent implements Serializable {
31	0	private static final org.apache.log4j.Logger LOG = org.apache.log4j.Logger.getLogger(SearchAttributeCriteriaComponent.class);
32
33		private static final long serialVersionUID = -5927435567057306529L;
34
35		private String formKey; // this if the field that is used in the UI for the form
36		private String value;
37		private List<String> values;
38		private String lookupableFieldType;
39	0	private boolean caseSensitive = false;
40	0	private boolean searchInclusive = true; // not just for ranges... used by single date searches
41		private SearchableAttributeValue searchableAttributeValue;
42	0	private boolean searchable = true;
43	0	private boolean canHoldMultipleValues = false;
44
45		// range properties
46	0	private boolean rangeSearch = false;
47	0	private boolean allowInlineRange = false;
48		// this is the field that is saved to the database
49		private String savedKey;
50
51		/**
52		* @param formKey key value associated with the search form
53		* @param value value the user is searching on
54		* @param savedKey key value associated with the value saved in the database
55		*/
56		public SearchAttributeCriteriaComponent(String formKey, String value, boolean rangeSearch) {
57	0	super();
58	0	this.formKey = formKey;
59	0	this.value = value;
60	0	this.rangeSearch = rangeSearch;
61	0	if (!rangeSearch) {
62	0	this.savedKey = formKey;
63		}
64	0	}
65
66		/**
67		* @param formKey key value associated with the search form
68		* @param value value the user is searching on
69		* @param savedKey key value associated with the value saved in the database
70		*/
71		public SearchAttributeCriteriaComponent(String formKey, String value, String savedKey) {
72	0	super();
73	0	this.formKey = formKey;
74	0	this.value = value;
75	0	this.savedKey = savedKey;
76	0	}
77
78		/**
79		* @param formKey key value associated with the search form
80		* @param value value the user is searching on
81		* @param savedKey key value associated with the value saved in the database
82		* @param searchableAttributeValue
83		*/
84		public SearchAttributeCriteriaComponent(String formKey, String value, String savedKey, SearchableAttributeValue searchableAttributeValue) {
85	0	super();
86	0	this.formKey = formKey;
87	0	this.value = value;
88	0	this.savedKey = savedKey;
89	0	this.searchableAttributeValue = searchableAttributeValue;
90	0	}
91
92		public boolean isComponentLowerBoundValue() {
93	0	return isComponentGivenBoundValue(SearchableAttribute.RANGE_LOWER_BOUND_PROPERTY_PREFIX);
94		}
95
96		public boolean isComponentUpperBoundValue() {
97	0	return isComponentGivenBoundValue(SearchableAttribute.RANGE_UPPER_BOUND_PROPERTY_PREFIX);
98		}
99
100		private boolean isComponentGivenBoundValue(String boundKeyPrefix) {
101	0	if (!isRangeSearch()) {
102	0	String errorMsg = "Criteria Component with formKey value '" + formKey + "' is not part of a range search";
103	0	LOG.error("isComponentGivenBoundValue() " + errorMsg);
104	0	throw new RuntimeException(errorMsg);
105		}
106	0	return formKey.indexOf(boundKeyPrefix) == 0;
107		}
108
109		public boolean isNonBlankValueGiven() {
110	0	return ( (StringUtils.isNotBlank(getValue())) \|\| (!Utilities.isEmpty(getValues())) );
111		}
112
113		/**
114		* @return the canHoldMultipleValues
115		*/
116		public boolean isCanHoldMultipleValues() {
117	0	return canHoldMultipleValues;
118		}
119
120		/**
121		* @param canHoldMultipleValues the canHoldMultipleValues to set
122		*/
123		public void setCanHoldMultipleValues(boolean canHoldMultipleValues) {
124	0	this.canHoldMultipleValues = canHoldMultipleValues;
125	0	}
126
127		/**
128		* @return the searchable
129		*/
130		public boolean isSearchable() {
131	0	return searchable;
132		}
133
134		/**
135		* @param searchable the searchable to set
136		*/
137		public void setSearchable(boolean searchable) {
138	0	this.searchable = searchable;
139	0	}
140
141		/**
142		* @return the caseSensitive
143		*/
144		public boolean isCaseSensitive() {
145	0	return caseSensitive;
146		}
147
148		/**
149		* @param caseSensitive the caseSensitive to set
150		*/
151		public void setCaseSensitive(boolean caseSensitive) {
152	0	this.caseSensitive = caseSensitive;
153	0	}
154
155		/**
156		* @return the formKey
157		*/
158		public String getFormKey() {
159	0	return formKey;
160		}
161
162		/**
163		* @param formKey the formKey to set
164		*/
165		public void setFormKey(String formKey) {
166	0	this.formKey = formKey;
167	0	}
168
169		/**
170		* @return the rangeSearch
171		*/
172		public boolean isRangeSearch() {
173	0	return rangeSearch;
174		}
175
176		/**
177		* @param rangeSearch the rangeSearch to set
178		*/
179		public void setRangeSearch(boolean rangeSearch) {
180	0	this.rangeSearch = rangeSearch;
181	0	}
182
183		/**
184		* @return the savedKey
185		*/
186		public String getSavedKey() {
187	0	return savedKey;
188		}
189
190		/**
191		* @param savedKey the savedKey to set
192		*/
193		public void setSavedKey(String savedKey) {
194	0	this.savedKey = savedKey;
195	0	}
196
197		/**
198		* @return the searchableAttributeValue
199		*/
200		public SearchableAttributeValue getSearchableAttributeValue() {
201	0	return searchableAttributeValue;
202		}
203
204		/**
205		* @param searchableAttributeValue the searchableAttributeValue to set
206		*/
207		public void setSearchableAttributeValue(
208		SearchableAttributeValue searchableAttributeValue) {
209	0	this.searchableAttributeValue = searchableAttributeValue;
210	0	}
211
212		/**
213		* @return the searchInclusive
214		*/
215		public boolean isSearchInclusive() {
216	0	return searchInclusive;
217		}
218
219		/**
220		* @param searchInclusive the searchInclusive to set
221		*/
222		public void setSearchInclusive(boolean searchInclusive) {
223	0	this.searchInclusive = searchInclusive;
224	0	}
225
226		/**
227		* @return the value
228		*/
229		public String getValue() {
230	0	return value;
231		}
232
233		/**
234		* @param value the value to set
235		*/
236		public void setValue(String value) {
237	0	this.value = value;
238	0	}
239
240		/**
241		* @return the values
242		*/
243		public List<String> getValues() {
244	0	return values;
245		}
246
247		/**
248		* @param values the values to set
249		*/
250		public void setValues(List<String> values) {
251	0	this.values = values;
252	0	}
253
254		/**
255		* @return the lookupableFieldType
256		*/
257		public String getLookupableFieldType() {
258	0	return lookupableFieldType;
259		}
260
261		/**
262		* @param lookupableFieldType the lookupableFieldType to set
263		*/
264		public void setLookupableFieldType(String lookupableFieldType) {
265	0	this.lookupableFieldType = lookupableFieldType;
266	0	}
267
268		/**
269		* @return the allowInlineRange
270		*/
271		public boolean isAllowInlineRange() {
272	0	return this.allowInlineRange;
273		}
274
275		/**
276		* @param allowInlineRange the allowInlineRange to set
277		*/
278		public void setAllowInlineRange(boolean allowInlineRange) {
279	0	this.allowInlineRange = allowInlineRange;
280	0	}
281
282		}