Java tutorial
/** * The software subject to this notice and license includes both human readable * source code form and machine readable, binary, object code form. The COPPA PO * Software was developed in conjunction with the National Cancer Institute * (NCI) by NCI employees and 5AM Solutions, Inc. (5AM). To the extent * government employees are authors, any rights in such works shall be subject * to Title 17 of the United States Code, section 105. * * This COPPA PO Software License (the License) is between NCI and You. You (or * Your) shall mean a person or an entity, and all other entities that control, * are controlled by, or are under common control with the entity. Control for * purposes of this definition means (i) the direct or indirect power to cause * the direction or management of such entity, whether by contract or otherwise, * or (ii) ownership of fifty percent (50%) or more of the outstanding shares, * or (iii) beneficial ownership of such entity. * * This License is granted provided that You agree to the conditions described * below. NCI grants You a non-exclusive, worldwide, perpetual, fully-paid-up, * no-charge, irrevocable, transferable and royalty-free right and license in * its rights in the COPPA PO Software to (i) use, install, access, operate, * execute, copy, modify, translate, market, publicly display, publicly perform, * and prepare derivative works of the COPPA PO Software; (ii) distribute and * have distributed to and by third parties the COPPA PO Software and any * modifications and derivative works thereof; and (iii) sublicense the * foregoing rights set out in (i) and (ii) to third parties, including the * right to license such rights to further third parties. For sake of clarity, * and not by way of limitation, NCI shall have no right of accounting or right * of payment from You or Your sub-licensees for the rights granted under this * License. This License is granted at no charge to You. * * Your redistributions of the source code for the Software must retain the * above copyright notice, this list of conditions and the disclaimer and * limitation of liability of Article 6, below. Your redistributions in object * code form must reproduce the above copyright notice, this list of conditions * and the disclaimer of Article 6 in the documentation and/or other materials * provided with the distribution, if any. * * Your end-user documentation included with the redistribution, if any, must * include the following acknowledgment: This product includes software * developed by 5AM and the National Cancer Institute. If You do not include * such end-user documentation, You shall include this acknowledgment in the * Software itself, wherever such third-party acknowledgments normally appear. * * You may not use the names "The National Cancer Institute", "NCI", or "5AM" * to endorse or promote products derived from this Software. This License does * not authorize You to use any trademarks, service marks, trade names, logos or * product names of either NCI or 5AM, except as required to comply with the * terms of this License. * * For sake of clarity, and not by way of limitation, You may incorporate this * Software into Your proprietary programs and into any third party proprietary * programs. However, if You incorporate the Software into third party * proprietary programs, You agree that You are solely responsible for obtaining * any permission from such third parties required to incorporate the Software * into such third party proprietary programs and for informing Your * sub-licensees, including without limitation Your end-users, of their * obligation to secure any required permissions from such third parties before * incorporating the Software into such third party proprietary software * programs. In the event that You fail to obtain such permissions, You agree * to indemnify NCI for any claims against NCI by such third parties, except to * the extent prohibited by law, resulting from Your failure to obtain such * permissions. * * For sake of clarity, and not by way of limitation, You may add Your own * copyright statement to Your modifications and to the derivative works, and * You may provide additional or different license terms and conditions in Your * sublicenses of modifications of the Software, or any derivative works of the * Software as a whole, provided Your use, reproduction, and distribution of the * Work otherwise complies with the conditions stated in this License. * * THIS SOFTWARE IS PROVIDED "AS IS," AND ANY EXPRESSED OR IMPLIED WARRANTIES, * (INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY, * NON-INFRINGEMENT AND FITNESS FOR A PARTICULAR PURPOSE) ARE DISCLAIMED. IN NO * EVENT SHALL THE NATIONAL CANCER INSTITUTE, 5AM SOLUTIONS, INC. OR THEIR * AFFILIATES BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ package com.fiveamsolutions.nci.commons.search; import java.lang.reflect.InvocationTargetException; import java.lang.reflect.Method; import java.util.Collection; import java.util.IdentityHashMap; import java.util.Map; import org.apache.commons.beanutils.PropertyUtils; import org.apache.commons.lang.ArrayUtils; import org.apache.commons.lang.StringUtils; import com.fiveamsolutions.nci.commons.data.persistent.PersistentObject; import com.fiveamsolutions.nci.commons.search.SearchableUtils.AnnotationCallback; /** * Callback used to validate a annotated search criteria to ensure that one criterion is specified. * @author Todd Parnell */ final class OneCriterionSpecifiedCallback implements AnnotationCallback { private boolean hasOneCriterion = false; // use == for comparisons, rather than equals() private final Map<Object, Object> nestedHistory = new IdentityHashMap<Object, Object>(); /** * {@inheritDoc} */ public void callback(Method m, Object result, String objectAlias) throws NoSuchMethodException, IllegalAccessException, InvocationTargetException { if (hasOneCriterion) { // previous method had a criteria, so no need to check this one return; } if (result != null) { checkFields(m, result); } } private void checkFields(Method m, Object result) throws NoSuchMethodException, IllegalAccessException, InvocationTargetException { String[] fields = m.getAnnotation(Searchable.class).fields(); boolean nested = m.getAnnotation(Searchable.class).nested(); if (result instanceof Collection<?>) { checkCollectionResultForCriteria((Collection<?>) result, fields, nested); } else if (!ArrayUtils.isEmpty(fields)) { checkSubFieldsForCriteria(result, fields); } else if (nested) { if (!nestedHistory.containsKey(result)) { nestedHistory.put(result, result); SearchableUtils.iterateAnnotatedMethods(result, this); } } else { // not a collection, and no subfields selected, so because it is non-null, a criterion was found if (isStringAndBlank(result)) { return; } hasOneCriterion = true; } } private void checkSubFieldsForCriteria(Object result, String[] fields) { for (String field : fields) { Object subPropValue = getSimpleProperty(result, field); if (subPropValue == null) { continue; } if (subPropValue instanceof PersistentObject) { if (((PersistentObject) subPropValue).getId() != null) { hasOneCriterion = true; return; } } else { if (isStringAndBlank(subPropValue)) { continue; } hasOneCriterion = true; return; } } } private boolean isStringAndBlank(Object value) { return value instanceof String && StringUtils.isBlank((String) value); } private Object getSimpleProperty(Object bean, String name) { Object propertyValue = null; try { propertyValue = PropertyUtils.getSimpleProperty(bean, name); } catch (Exception e) { throw new IllegalArgumentException( "Unable to process property with name:" + name + " " + bean.getClass(), e); } return propertyValue; } private void checkCollectionResultForCriteria(Collection<?> col, String[] fields, boolean nested) throws NoSuchMethodException, IllegalAccessException, InvocationTargetException { if (!col.isEmpty()) { if (!ArrayUtils.isEmpty(fields)) { processCollectionProperties(fields, col, col.iterator().next().getClass()); } else if (nested) { for (Object obj : col) { SearchableUtils.iterateAnnotatedMethods(obj, this); } } } } private void processCollectionProperties(String[] fields, Collection<?> col, Class<? extends Object> fieldClass) throws NoSuchMethodException, IllegalAccessException, InvocationTargetException { for (String propName : fields) { // get the collection of values into a nice collection Method m2 = fieldClass.getMethod("get" + StringUtils.capitalize(propName)); for (Object collectionObj : col.toArray()) { Object val = m2.invoke(collectionObj); if (val != null) { if (isStringAndBlank(val)) { continue; } hasOneCriterion = true; return; } } } } public Object getSavedState() { return hasOneCriterion; } }