org.kuali.rice.kew.impl.document.lookup.DocumentLookupCriteriaTranslatorImpl.java Source code

Introduction

Here is the source code for org.kuali.rice.kew.impl.document.lookup.DocumentLookupCriteriaTranslatorImpl.java

Source

/*
 * Copyright 2007-2009 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.impl.document.lookup;

import org.apache.commons.beanutils.PropertyUtils;
import org.apache.commons.lang.StringUtils;
import org.apache.log4j.Logger;
import org.joda.time.DateTime;
import org.kuali.rice.kew.api.document.DocumentStatus;
import org.kuali.rice.kew.api.document.DocumentStatusCategory;
import org.kuali.rice.kew.api.document.lookup.DocumentLookupCriteria;
import org.kuali.rice.kew.api.document.lookup.RouteNodeLookupLogic;
import org.kuali.rice.kew.docsearch.DocumentLookupInternalUtils;
import org.kuali.rice.kew.util.KEWConstants;

import java.util.Arrays;
import java.util.HashSet;
import java.util.Map;
import java.util.Set;

/**
 * Reference implementation of {@code DocumentLookupCriteriaTranslator}.
 *
 * @author Kuali Rice Team (rice.collab@kuali.org)
 */
public class DocumentLookupCriteriaTranslatorImpl implements DocumentLookupCriteriaTranslator {

    private static final Logger LOG = Logger.getLogger(DocumentLookupCriteriaTranslatorImpl.class);

    private static final String DOCUMENT_STATUSES = "documentStatuses";
    private static final String ROUTE_NODE_LOOKUP_LOGIC = "routeNodeLookupLogic";

    /**
     * Fields which translate directory from criteria strings to properties on the DocumentLookupCriteria.
     */
    private static final String[] DIRECT_TRANSLATE_FIELD_NAMES = { "documentId", "applicationDocumentId",
            "applicationDocumentStatus", "initiatorPrincipalName", "viewerPrincipalName", "approverPrincipalName",
            "routeNodeName", "documentTypeName", "saveName" };
    private static final Set<String> DIRECT_TRANSLATE_FIELD_NAMES_SET = new HashSet<String>(
            Arrays.asList(DIRECT_TRANSLATE_FIELD_NAMES));

    private static final String[] DATE_RANGE_TRANSLATE_FIELD_NAMES = { "dateCreated", "dateLastModified",
            "dateApproved", "dateFinalized" };
    private static final Set<String> DATE_RANGE_TRANSLATE_FIELD_NAMES_SET = new HashSet<String>(
            Arrays.asList(DATE_RANGE_TRANSLATE_FIELD_NAMES));

    @Override
    public DocumentLookupCriteria translate(Map<String, String> fieldValues) {

        DocumentLookupCriteria.Builder criteria = DocumentLookupCriteria.Builder.create();
        for (Map.Entry<String, String> field : fieldValues.entrySet()) {
            try {
                if (StringUtils.isNotBlank(field.getValue())) {
                    if (DIRECT_TRANSLATE_FIELD_NAMES_SET.contains(field.getKey())) {
                        PropertyUtils.setNestedProperty(criteria, field.getKey(), field.getValue());
                    } else if (DATE_RANGE_TRANSLATE_FIELD_NAMES_SET.contains(field.getKey())) {
                        applyDateRangeField(criteria, field.getKey(), field.getValue());
                    } else if (field.getKey().startsWith(KEWConstants.DOCUMENT_ATTRIBUTE_FIELD_PREFIX)) {
                        String documentAttributeName = field.getKey()
                                .substring(KEWConstants.DOCUMENT_ATTRIBUTE_FIELD_PREFIX.length());
                        applyDocumentAttribute(criteria, documentAttributeName, field.getValue());
                    }

                }
            } catch (Exception e) {
                throw new IllegalStateException("Failed to set document lookup criteria field: " + field.getKey(),
                        e);
            }
        }

        String routeNodeLookupLogic = fieldValues.get(ROUTE_NODE_LOOKUP_LOGIC);
        if (StringUtils.isNotBlank(routeNodeLookupLogic)) {
            criteria.setRouteNodeLookupLogic(RouteNodeLookupLogic.valueOf(routeNodeLookupLogic));
        }

        String documentStatusesValue = fieldValues.get(DOCUMENT_STATUSES);
        if (StringUtils.isNotBlank(documentStatusesValue)) {
            String[] documentStatuses = documentStatusesValue.split(",");
            for (String documentStatus : documentStatuses) {
                if (documentStatus.startsWith("category:")) {
                    String categoryCode = StringUtils.remove(documentStatus, "category:");
                    criteria.getDocumentStatusCategories().add(DocumentStatusCategory.fromCode(categoryCode));
                } else {
                    criteria.getDocumentStatuses().add(DocumentStatus.fromCode(documentStatus));
                }
            }
        }

        return criteria.build();
    }

    protected void applyDateRangeField(DocumentLookupCriteria.Builder criteria, String fieldName, String fieldValue)
            throws Exception {
        DateTime lowerDateTime = DocumentLookupInternalUtils.getLowerDateTimeBound(fieldValue);
        DateTime upperDateTime = DocumentLookupInternalUtils.getUpperDateTimeBound(fieldValue);
        if (lowerDateTime != null) {
            PropertyUtils.setNestedProperty(criteria, fieldName + "From", lowerDateTime);
        }
        if (upperDateTime != null) {
            PropertyUtils.setNestedProperty(criteria, fieldName + "To", upperDateTime);
        }
    }

    protected void applyDocumentAttribute(DocumentLookupCriteria.Builder criteria, String documentAttributeName,
            String attributeValue) {
        criteria.addDocumentAttributeValue(documentAttributeName, attributeValue);
    }

}