001/**
002 * Copyright 2005-2018 The Kuali Foundation
003 *
004 * Licensed under the Educational Community License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 * http://www.opensource.org/licenses/ecl2.php
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016package org.kuali.rice.krad.datadictionary.validation.processor;
017
018import org.apache.commons.lang.StringUtils;
019import org.kuali.rice.core.api.util.RiceKeyConstants;
020import org.kuali.rice.krad.datadictionary.exception.AttributeValidationException;
021import org.kuali.rice.krad.datadictionary.validation.AttributeValueReader;
022import org.kuali.rice.krad.datadictionary.validation.ErrorLevel;
023import org.kuali.rice.krad.datadictionary.validation.ValidationUtils;
024import org.kuali.rice.krad.datadictionary.validation.constraint.Constraint;
025import org.kuali.rice.krad.datadictionary.validation.constraint.MustOccurConstraint;
026import org.kuali.rice.krad.datadictionary.validation.constraint.PrerequisiteConstraint;
027import org.kuali.rice.krad.datadictionary.validation.result.ConstraintValidationResult;
028import org.kuali.rice.krad.datadictionary.validation.result.DictionaryValidationResult;
029import org.kuali.rice.krad.datadictionary.validation.result.ProcessorResult;
030import org.kuali.rice.krad.uif.UifConstants;
031
032import java.util.List;
033
034/**
035 * @author Kuali Rice Team (rice.collab@kuali.org)
036 */
037public class MustOccurConstraintProcessor extends BasePrerequisiteConstraintProcessor<MustOccurConstraint> {
038
039    private static final String CONSTRAINT_NAME = "must occur constraint";
040    private static final String FALLBACK_KEY = "mustoccursFallback";
041
042    /**
043     * @see org.kuali.rice.krad.datadictionary.validation.processor.ConstraintProcessor#process(org.kuali.rice.krad.datadictionary.validation.result.DictionaryValidationResult,
044     *      Object, org.kuali.rice.krad.datadictionary.validation.constraint.Constraint,
045     *      org.kuali.rice.krad.datadictionary.validation.AttributeValueReader)
046     */
047    @Override
048    public ProcessorResult process(DictionaryValidationResult result, Object value, MustOccurConstraint constraint,
049            AttributeValueReader attributeValueReader) throws AttributeValidationException {
050
051        if (ValidationUtils.isNullOrEmpty(value)) {
052            return new ProcessorResult(result.addSkipped(attributeValueReader, CONSTRAINT_NAME));
053        }
054
055        ConstraintValidationResult constraintValidationResult = new ConstraintValidationResult(CONSTRAINT_NAME);
056        if (StringUtils.isNotBlank(constraint.getMessageKey())) {
057            constraintValidationResult.setConstraintLabelKey(constraint.getMessageKey());
058        } else {
059            constraintValidationResult.setConstraintLabelKey(
060                    UifConstants.Messages.VALIDATION_MSG_KEY_PREFIX + FALLBACK_KEY);
061        }
062
063        constraintValidationResult.setErrorParameters(constraint.getValidationMessageParamsArray());
064
065        // If the processing of this constraint is not successful then it's an error
066        if (!processMustOccurConstraint(constraintValidationResult, constraint, attributeValueReader)) {
067            // if attributeName is null, use the entry name since we are processing a must occur constraint that may be referencing multiple attributes
068            if (attributeValueReader.getAttributeName() == null) {
069                constraintValidationResult.setAttributeName(attributeValueReader.getEntryName());
070            } else {
071                constraintValidationResult.setAttributeName(attributeValueReader.getAttributeName());
072                constraintValidationResult.setAttributePath(attributeValueReader.getPath());
073            }
074            constraintValidationResult.setError(RiceKeyConstants.ERROR_OCCURS);
075        }
076
077        // Store the label key (if one exists) for this constraint on the constraint validation result so it can be shown later
078
079        // Add it to the DictionaryValidationResult object
080        result.addConstraintValidationResult(attributeValueReader, constraintValidationResult);
081
082        return new ProcessorResult(constraintValidationResult);
083
084    }
085
086    @Override
087    public String getName() {
088        return CONSTRAINT_NAME;
089    }
090
091    /**
092     * @see org.kuali.rice.krad.datadictionary.validation.processor.ConstraintProcessor#getConstraintType()
093     */
094    @Override
095    public Class<? extends Constraint> getConstraintType() {
096        return MustOccurConstraint.class;
097    }
098
099    protected boolean processMustOccurConstraint(ConstraintValidationResult topLevelResult,
100            MustOccurConstraint constraint,
101            AttributeValueReader attributeValueReader) throws AttributeValidationException {
102
103        boolean isSuccessful = false;
104        int trueCount = 0;
105
106        List<PrerequisiteConstraint> prerequisiteConstraints = constraint.getPrerequisiteConstraints();
107        if (prerequisiteConstraints != null) {
108            for (PrerequisiteConstraint prerequisiteConstraint : prerequisiteConstraints) {
109                ConstraintValidationResult constraintValidationResult = processPrerequisiteConstraint(
110                        prerequisiteConstraint, attributeValueReader);
111                constraintValidationResult.setConstraintLabelKey(prerequisiteConstraint.getMessageKey());
112                constraintValidationResult.setErrorParameters(prerequisiteConstraint.getValidationMessageParamsArray());
113                // Add the result of each prerequisite constraint validation to the top level result object as a child
114                topLevelResult.addChild(constraintValidationResult);
115                trueCount += (constraintValidationResult.getStatus().getLevel() <= ErrorLevel.WARN.getLevel()) ? 1 : 0;
116            }
117        }
118
119        List<MustOccurConstraint> mustOccurConstraints = constraint.getMustOccurConstraints();
120        if (mustOccurConstraints != null) {
121            for (MustOccurConstraint mustOccurConstraint : mustOccurConstraints) {
122                // Create a new constraint validation result for this must occur constraint and make it child of the top-level constraint,
123                // then pass it in to the recursive call so that prerequisite constraints can be placed under it
124                ConstraintValidationResult constraintValidationResult = new ConstraintValidationResult(CONSTRAINT_NAME);
125                constraintValidationResult.setConstraintLabelKey(mustOccurConstraint.getMessageKey());
126                constraintValidationResult.setErrorParameters(mustOccurConstraint.getValidationMessageParamsArray());
127                topLevelResult.addChild(constraintValidationResult);
128                trueCount += (processMustOccurConstraint(constraintValidationResult, mustOccurConstraint,
129                        attributeValueReader)) ? 1 : 0;
130            }
131        }
132
133        int minimum = constraint.getMin() != null ? constraint.getMin().intValue() : 0;
134        int maximum = constraint.getMax() != null ? constraint.getMax().intValue() : 0;
135
136        isSuccessful = (trueCount >= minimum && trueCount <= maximum) ? true : false;
137
138        return isSuccessful;
139    }
140
141}