de.tsl2.nano.bean.def.BeanValueConditionChecker Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of tsl2.nano.descriptor Show documentation

TSL2 Framework Descriptor (currency-handling, generic formatter, descriptors for beans, collections, actions and values)

There is a newer version: 2.5.1

Show newest version

/*
 * File: $HeadURL$
 * Id  : $Id$
 * 
 * created by: Thomas Schneider
 * created on: Oct 15, 2010
 * 
 * Copyright: (c) Thomas Schneider 2010, all rights reserved
 */
package de.tsl2.nano.bean.def;

import java.io.Serializable;
import java.util.Collection;
import java.util.LinkedHashMap;
import java.util.Map;

import de.tsl2.nano.core.ManagedException;

/**
 * condition checker.
 * is able to check given 'must have' and 'must not have' constraints.
 * 
 * Example: * 
 * first, create the constraints:
                    final BeanValueConditionChecker checker = new BeanValueConditionChecker();
                    final BeanValue name1Value = BeanValue.getBeanValue(searchBean, AktenSuchParameterConst.ATTR_NAME1);
                    final BeanValue name2Value = BeanValue.getBeanValue(searchBean, AktenSuchParameterConst.ATTR_NAME2);
                    checker.add(name2Value, Arrays.asList(name1Value), null);
 * means: if the attribute nam2 is filled, the attribute name1 must be filled, too.
 * 
 * now, we check that, perhaps in a save method:
 *                  checker.check();
 * if the check fails, a readable exception will be thrown.
 * 
 * @author Thomas Schneider
 * @version $Revision$
 */
public class BeanValueConditionChecker implements Serializable {
    /** serialVersionUID */
    private static final long serialVersionUID = -5150482606347127502L;
    
    Map> mustHave = new LinkedHashMap>();
    Map> mustNotHave = new LinkedHashMap>();

    /**
     * constructor to be serializable
     */
    public BeanValueConditionChecker() {
        super();
    }

    /**
     * add constraint
     * 
     * @param attribute attribute to constrain
     * @param mustHave must have (not null) constraints
     * @param mustNotHave must not have (null) constraints
     */
    public void add(BeanValue attribute, Collection mustHave, Collection mustNotHave) {
        this.mustHave.put(attribute, mustHave);
        this.mustNotHave.put(attribute, mustNotHave);
    }

    /**
     * checks all given conditions and throws exception on constraint failure.
     */
    public void check() {
        //Must Have
        final Collection mustHaveKeys = mustHave.keySet();
        for (final BeanValue beanValue : mustHaveKeys) {
            if (beanValue.getValue() != null) {
                final Collection mustHaveValues = mustHave.get(beanValue);
                if (mustHaveValues != null) {
                    for (final BeanValue mhValue : mustHaveValues) {
                        if (mhValue.getValue() == null) {
                            throw new ManagedException("tsl2nano.musthavefailure",
                                new Object[] { beanValue.getName(), mhValue.getName() });
                        }
                    }
                }
            }
        }
        //Must Not Have
        final Collection mustNotHaveKeys = mustNotHave.keySet();
        for (final BeanValue beanValue : mustNotHaveKeys) {
            if (beanValue.getValue() != null) {
                final Collection mustNotHaveValues = mustNotHave.get(beanValue);
                if (mustNotHaveValues != null) {
                    for (final BeanValue mnhValue : mustNotHaveValues) {
                        if (mnhValue.getValue() != null) {
                            throw new ManagedException("tsl2nano.mustnothavefailure",
                                new Object[] { beanValue.getName(), mnhValue.getName() });
                        }
                    }
                }
            }
        }
    }
}