Coverage Report - org.kuali.rice.core.impl.criteria.CriteriaLookupServiceOjbImpl
 
Classes in this File Line Coverage Branch Coverage Complexity
CriteriaLookupServiceOjbImpl
6%
7/116
4%
3/74
4.125
CriteriaLookupServiceOjbImpl$1
0%
0/1
N/A
4.125
CriteriaLookupServiceOjbImpl$UnsupportedCountFlagException
0%
0/3
N/A
4.125
CriteriaLookupServiceOjbImpl$UnsupportedPredicateException
0%
0/3
N/A
4.125
 
 1  
 package org.kuali.rice.core.impl.criteria;
 2  
 
 3  
 import org.apache.ojb.broker.query.Criteria;
 4  
 import org.apache.ojb.broker.query.Query;
 5  
 import org.apache.ojb.broker.query.QueryFactory;
 6  
 import org.kuali.rice.core.api.criteria.AndPredicate;
 7  
 import org.kuali.rice.core.api.criteria.CompositePredicate;
 8  
 import org.kuali.rice.core.api.criteria.CountFlag;
 9  
 import org.kuali.rice.core.api.criteria.CriteriaLookupService;
 10  
 import org.kuali.rice.core.api.criteria.CriteriaValue;
 11  
 import org.kuali.rice.core.api.criteria.EqualIgnoreCasePredicate;
 12  
 import org.kuali.rice.core.api.criteria.EqualPredicate;
 13  
 import org.kuali.rice.core.api.criteria.GenericQueryResults;
 14  
 import org.kuali.rice.core.api.criteria.GreaterThanOrEqualPredicate;
 15  
 import org.kuali.rice.core.api.criteria.GreaterThanPredicate;
 16  
 import org.kuali.rice.core.api.criteria.InIgnoreCasePredicate;
 17  
 import org.kuali.rice.core.api.criteria.InPredicate;
 18  
 import org.kuali.rice.core.api.criteria.LessThanOrEqualPredicate;
 19  
 import org.kuali.rice.core.api.criteria.LessThanPredicate;
 20  
 import org.kuali.rice.core.api.criteria.LikePredicate;
 21  
 import org.kuali.rice.core.api.criteria.LookupCustomizer;
 22  
 import org.kuali.rice.core.api.criteria.MultiValuedPredicate;
 23  
 import org.kuali.rice.core.api.criteria.NotEqualIgnoreCasePredicate;
 24  
 import org.kuali.rice.core.api.criteria.NotEqualPredicate;
 25  
 import org.kuali.rice.core.api.criteria.NotInIgnoreCasePredicate;
 26  
 import org.kuali.rice.core.api.criteria.NotInPredicate;
 27  
 import org.kuali.rice.core.api.criteria.NotLikePredicate;
 28  
 import org.kuali.rice.core.api.criteria.NotNullPredicate;
 29  
 import org.kuali.rice.core.api.criteria.NullPredicate;
 30  
 import org.kuali.rice.core.api.criteria.OrPredicate;
 31  
 import org.kuali.rice.core.api.criteria.Predicate;
 32  
 import org.kuali.rice.core.api.criteria.PropertyPathPredicate;
 33  
 import org.kuali.rice.core.api.criteria.QueryByCriteria;
 34  
 import org.kuali.rice.core.api.criteria.SingleValuedPredicate;
 35  
 import org.kuali.rice.core.framework.persistence.ojb.dao.PlatformAwareDaoBaseOjb;
 36  
 
 37  
 import java.util.ArrayList;
 38  
 import java.util.HashSet;
 39  
 import java.util.List;
 40  
 import java.util.Set;
 41  
 
 42  2
 public class CriteriaLookupServiceOjbImpl extends PlatformAwareDaoBaseOjb implements CriteriaLookupService {
 43  
 
 44  
     @Override
 45  
     public <T> GenericQueryResults<T> lookup(final Class<T> queryClass, final QueryByCriteria criteria) {
 46  2
         return lookup(queryClass, criteria, LookupCustomizer.Builder.<T>create().build());
 47  
     }
 48  
 
 49  
     @Override
 50  
     public <T> GenericQueryResults<T> lookup(final Class<T> queryClass, final QueryByCriteria criteria, LookupCustomizer<T> customizer) {
 51  2
         if (queryClass == null) {
 52  1
             throw new IllegalArgumentException("queryClass is null");
 53  
         }
 54  
 
 55  1
         if (criteria == null) {
 56  1
             throw new IllegalArgumentException("criteria is null");
 57  
         }
 58  
 
 59  0
         if (customizer == null) {
 60  0
             throw new IllegalArgumentException("customizer is null");
 61  
         }
 62  
 
 63  0
         final Criteria parent = new Criteria();
 64  
 
 65  0
         if (criteria.getPredicate() != null) {
 66  0
             addPredicate(criteria.getPredicate(), parent, customizer.getPredicateTransform());
 67  
         }
 68  
 
 69  0
         switch (criteria.getCountFlag()) {
 70  
             case ONLY:
 71  0
                 return forCountOnly(queryClass, criteria, parent);
 72  
             case NONE:
 73  0
                 return forRowResults(queryClass, criteria, parent, criteria.getCountFlag(), customizer.getResultTransform());
 74  
             case INCLUDE:
 75  0
                 return forRowResults(queryClass, criteria, parent, criteria.getCountFlag(), customizer.getResultTransform());
 76  0
             default: throw new UnsupportedCountFlagException(criteria.getCountFlag());
 77  
         }
 78  
     }
 79  
 
 80  
     /** gets results where the actual rows are requested. */
 81  
     private <T> GenericQueryResults<T> forRowResults(final Class<T> queryClass, final QueryByCriteria criteria, final Criteria ojbCriteria, CountFlag flag, LookupCustomizer.Transform<T, T> transform) {
 82  0
         final Query ojbQuery = QueryFactory.newQuery(queryClass, ojbCriteria);
 83  0
         final GenericQueryResults.Builder<T> results = GenericQueryResults.Builder.<T>create();
 84  
 
 85  0
         if (flag == CountFlag.INCLUDE) {
 86  0
             results.setTotalRowCount(getPersistenceBrokerTemplate().getCount(ojbQuery));
 87  
         }
 88  
 
 89  
         //ojb's is 1 based, our query api is zero based
 90  0
         final int startAtIndex = criteria.getStartAtIndex() != null ? criteria.getStartAtIndex() + 1 : 1;
 91  0
         ojbQuery.setStartAtIndex(startAtIndex);
 92  
 
 93  0
         if (criteria.getMaxResults() != null) {
 94  
             //not subtracting one from MaxResults in order to retrieve
 95  
             //one extra row so that the MoreResultsAvailable field can be set
 96  0
             ojbQuery.setEndAtIndex(criteria.getMaxResults() + startAtIndex);
 97  
         }
 98  
 
 99  
         @SuppressWarnings("unchecked")
 100  0
         final List<T> rows = new ArrayList<T>(getPersistenceBrokerTemplate().getCollectionByQuery(ojbQuery));
 101  
 
 102  0
         if (criteria.getMaxResults() != null && rows.size() > criteria.getMaxResults()) {
 103  0
             results.setMoreResultsAvailable(true);
 104  
             //remove the extra row that was returned
 105  0
             rows.remove(criteria.getMaxResults().intValue());
 106  
         }
 107  
 
 108  0
         results.setResults(transformResults(rows, transform));
 109  0
         return results.build();
 110  
     }
 111  
 
 112  
     private static <T> List<T> transformResults(List<T> results, LookupCustomizer.Transform<T, T> transform) {
 113  0
         final List<T> list = new ArrayList<T>();
 114  0
         for (T r : results) {
 115  0
             list.add(transform.apply(r));
 116  
         }
 117  0
         return list;
 118  
     }
 119  
 
 120  
     /** gets results where only the count is requested. */
 121  
     private <T> GenericQueryResults<T> forCountOnly(final Class<T> queryClass, final QueryByCriteria criteria, final Criteria ojbCriteria) {
 122  0
         final Query ojbQuery = QueryFactory.newQuery(queryClass, ojbCriteria);
 123  0
         final GenericQueryResults.Builder<T> results = GenericQueryResults.Builder.<T>create();
 124  0
         results.setTotalRowCount(getPersistenceBrokerTemplate().getCount(ojbQuery));
 125  
 
 126  0
         return results.build();
 127  
     }
 128  
 
 129  
     /** adds a predicate to a Criteria.*/
 130  
     private void addPredicate(Predicate p, Criteria parent, LookupCustomizer.Transform<Predicate, Predicate> transform) {
 131  0
         p = transform.apply(p);
 132  
 
 133  0
         if (p instanceof PropertyPathPredicate) {
 134  0
             final String pp = ((PropertyPathPredicate) p).getPropertyPath();
 135  0
             if (p instanceof NotNullPredicate) {
 136  0
                 parent.addNotNull(pp);
 137  0
             } else if (p instanceof NullPredicate) {
 138  0
                 parent.addIsNull(pp);
 139  0
             } else if (p instanceof SingleValuedPredicate) {
 140  0
                 addSingleValuePredicate((SingleValuedPredicate) p, parent);
 141  0
             } else if (p instanceof MultiValuedPredicate) {
 142  0
                 addMultiValuePredicate((MultiValuedPredicate) p, parent);
 143  
             } else {
 144  0
                 throw new UnsupportedPredicateException(p);
 145  
             }
 146  0
         } else if (p instanceof CompositePredicate) {
 147  0
             addCompositePredicate((CompositePredicate) p, parent, transform);
 148  
         } else {
 149  0
             throw new UnsupportedPredicateException(p);
 150  
         }
 151  0
     }
 152  
 
 153  
     /** adds a single valued predicate to a Criteria. */
 154  
     private void addSingleValuePredicate(SingleValuedPredicate p, Criteria parent) {
 155  0
         final Object value = p.getValue().getValue();
 156  0
         final String pp = p.getPropertyPath();
 157  0
         if (p instanceof EqualPredicate) {
 158  0
             parent.addEqualTo(pp, value);
 159  0
         } else if (p instanceof EqualIgnoreCasePredicate) {
 160  0
             parent.addEqualTo(genUpperFunc(pp), ((String) value).toUpperCase());
 161  0
         } else if (p instanceof GreaterThanOrEqualPredicate) {
 162  0
             parent.addGreaterOrEqualThan(pp, value);
 163  0
         } else if (p instanceof GreaterThanPredicate) {
 164  0
             parent.addGreaterThan(pp, value);
 165  0
         } else if (p instanceof LessThanOrEqualPredicate) {
 166  0
             parent.addLessOrEqualThan(pp, value);
 167  0
         } else if (p instanceof LessThanPredicate) {
 168  0
             parent.addLessThan(pp, value);
 169  0
         } else if (p instanceof LikePredicate) {
 170  
             //no need to convert * or ? since ojb handles the conversion/escaping
 171  0
             parent.addLike(pp, value);
 172  0
         } else if (p instanceof NotEqualPredicate) {
 173  0
             parent.addNotEqualTo(pp, value);
 174  0
         } else if (p instanceof NotEqualIgnoreCasePredicate) {
 175  0
             parent.addNotEqualTo(genUpperFunc(pp), ((String) value).toUpperCase());
 176  0
         } else if (p instanceof NotLikePredicate) {
 177  0
             parent.addNotLike(pp, value);
 178  
         } else {
 179  0
             throw new UnsupportedPredicateException(p);
 180  
         }
 181  0
     }
 182  
 
 183  
     /** adds a multi valued predicate to a Criteria. */
 184  
     private void addMultiValuePredicate(MultiValuedPredicate p, Criteria parent) {
 185  0
         final String pp = p.getPropertyPath();
 186  0
         if (p instanceof InPredicate) {
 187  0
             final Set<?> values = getValsUnsafe(p.getValues());
 188  0
             parent.addIn(pp, values);
 189  0
         } else if (p instanceof InIgnoreCasePredicate) {
 190  0
             final Set<String> values = toUpper(getVals(((InIgnoreCasePredicate) p).getValues()));
 191  0
             parent.addIn(genUpperFunc(pp), values);
 192  0
         } else if (p instanceof NotInPredicate) {
 193  0
             final Set<?> values = getValsUnsafe(p.getValues());
 194  0
             parent.addNotIn(pp, values);
 195  0
         } else if (p instanceof NotInIgnoreCasePredicate) {
 196  0
             final Set<String> values = toUpper(getVals(((NotInIgnoreCasePredicate) p).getValues()));
 197  0
             parent.addNotIn(genUpperFunc(pp), values);
 198  0
         } else {
 199  0
             throw new UnsupportedPredicateException(p);
 200  
         }
 201  0
     }
 202  
 
 203  
     /** adds a composite predicate to a Criteria. */
 204  
     private void addCompositePredicate(final CompositePredicate p, final Criteria parent,  LookupCustomizer.Transform<Predicate, Predicate> transform) {
 205  0
         for (Predicate ip : p.getPredicates()) {
 206  0
             final Criteria inner = new Criteria();
 207  0
             addPredicate(ip, inner, transform);
 208  0
             if (p instanceof AndPredicate) {
 209  0
                 parent.addAndCriteria(inner);
 210  0
             } else if (p instanceof OrPredicate) {
 211  0
                 parent.addOrCriteria(inner);
 212  
             } else {
 213  0
                 throw new UnsupportedPredicateException(p);
 214  
             }
 215  0
         }
 216  0
     }
 217  
 
 218  
     @SuppressWarnings("unchecked")
 219  
     private static <T, U extends CriteriaValue<T>> Set<T> getVals(Set<? extends U> toConv) {
 220  0
         return (Set<T>) getValsUnsafe(toConv);
 221  
     }
 222  
 
 223  
     //FIXME: this method exists to make javac happy - to bad I didn't know how to fix this....
 224  
     private static Set<?> getValsUnsafe(Set<? extends CriteriaValue<?>> toConv) {
 225  0
         final Set<Object> values = new HashSet<Object>();
 226  0
         for (CriteriaValue<?> value : toConv) {
 227  0
             values.add(value.getValue());
 228  
         }
 229  0
         return values;
 230  
     }
 231  
 
 232  
     //eliding performance for function composition....
 233  
     private static Set<String> toUpper(Set<String> strs) {
 234  0
         final Set<String> values = new HashSet<String>();
 235  0
         for (String value : strs) {
 236  0
             values.add(value.toUpperCase());
 237  
         }
 238  0
         return values;
 239  
     }
 240  
 
 241  
     private String getUpperFunction() {
 242  0
         return getDbPlatform().getUpperCaseFunction();
 243  
     }
 244  
 
 245  
     private String genUpperFunc(String pp) {
 246  0
         return new StringBuilder(getUpperFunction()).append("(").append(pp).append(")").toString();
 247  
     }
 248  
 
 249  
     /** this is a fatal error since this implementation should support all known predicates. */
 250  0
     private static class UnsupportedPredicateException extends RuntimeException {
 251  
         private UnsupportedPredicateException(Predicate predicate) {
 252  0
             super("Unsupported predicate [" + String.valueOf(predicate) + "]");
 253  0
         }
 254  
     }
 255  
 
 256  
     /** this is a fatal error since this implementation should support all known count flags. */
 257  0
     private static class UnsupportedCountFlagException extends RuntimeException {
 258  
         private UnsupportedCountFlagException(CountFlag flag) {
 259  0
             super("Unsupported predicate [" + String.valueOf(flag) + "]");
 260  0
         }
 261  
     }
 262  
 }