nz.co.senanque.rules.decisiontable.XMLDecisionTable Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of madura-rules Show documentation

This is a plugin to Madura Objects. It provides a rules/constraint engine to assist with validation, deriving new values from user inputs (eg total of invoices entered on this customer) an manipulating metadata (eg because the amount is above X we make some field readonly). Note that the Java that is using the monitored objects is quite unaware of the rules layer implemented here. That means you can change rules without having to go back to your Java code, and it also means you don't have to wonder if everything implemented the same rules. Anything using that Java object has the rules (unless you turn them all off).

There is a newer version: 3.3.5

Show newest version

/*******************************************************************************
 * Copyright (c)2014 Prometheus Consulting
 *
 * Licensed under the Apache 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.apache.org/licenses/LICENSE-2.0
 *
 * 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 nz.co.senanque.rules.decisiontable;

import java.util.List;
import java.util.Map;

import nz.co.senanque.rules.FieldReference;
import nz.co.senanque.rules.RuleSession;
import nz.co.senanque.rules.RulesPlugin;
import nz.co.senanque.rules.factories.DecisionTableFactory;
import nz.co.senanque.validationengine.ValidationObject;

import org.jdom.Element;

/**
 * 
 * Derive a decision table from the XML passed
 * 
 * @author Roger Parkinson
 * @version $Revision: 1.5 $
 */
public class XMLDecisionTable extends AbstractDecisionTable
{
	private static final long serialVersionUID = 1L;
	private transient final String m_ruleName;
    private transient final String m_message;
    private transient final String m_typeName;
    private transient final FieldReference[] m_listeners;
    private transient final Class m_clazz;

    public XMLDecisionTable(final Element tableElement, Map factoryMap, RulesPlugin rulesPlugin)
    {
        m_ruleName = tableElement.getAttributeValue("name");
        final String type = tableElement.getAttributeValue("scope");
        m_typeName = type;
        // this will not handle inherited rules (but doesn't need to here)
        m_clazz = rulesPlugin.getClassReferenceMap().get(type).getClazz();
        m_message = tableElement.getAttributeValue("message");
        @SuppressWarnings("unchecked")
		final List columNameElements = (List)tableElement.getChild("ColumnNames").getChildren("ColumnName");
        String[] columnNames = new String[columNameElements.size()];
        m_listeners = new FieldReference[columNameElements.size()];
        boolean autoAssign[] = new boolean[columNameElements.size()];
        int index = 0;
        for (Element columnNameElement:columNameElements)
        {
            final String autoAssignValue = columnNameElement.getAttributeValue("autoAssign");
            if (autoAssignValue != null)
            {
                autoAssign[index] = new Boolean(autoAssignValue).booleanValue();
            }
            columnNames[index] = columnNameElement.getTextTrim();
            m_listeners[index] = new FieldReference(type,columnNames[index]);
            index++;
        }
        DecisionTableFactory dtf = factoryMap.get(m_ruleName);
        if (dtf == null)
        {
            @SuppressWarnings("unchecked")
			final List rowElements = (List)tableElement.getChild("Rows").getChildren("Row");
            Row[] rows = new Row[rowElements.size()];
            int rowIindex = 0;
            for (Element rowElement:rowElements)
            {
                @SuppressWarnings("unchecked")
				final List columnElements = (List)rowElement.getChildren("Column");
                Column[] columns = new Column[columnElements.size()];
                int columnIindex = 0;
                for (Element columnElement:columnElements)
                {
                    columns[columnIindex++] = new Column(columnElement.getTextTrim());
                }
                rows[rowIindex++] = new Row(columns);
            }
            setRows(rows);
        }
        else
        {
            setRows(dtf.getRows(m_ruleName));
        }
        setColumnNames(columnNames);
        setAutoAssign(autoAssign);
    }
    
    @SuppressWarnings("unused")
	private Class getClazz(String name)
    {
        return null;
//        try
//        {
//            return Class.forName(m_typeName);
//        }
//        catch (ClassNotFoundException e)
//        {
//            throw new RuntimeException(e);
//        }        
    }

    public String getRuleName()
    {
        return m_ruleName;
    }

    public FieldReference[] listeners()
    {
        return m_listeners.clone();
    }
   public String getMessage(RuleSession session, ValidationObject object)
    {
        return m_message;
    }
   public String toString()
   {
       return getRuleName();
   }

   public String getClassName()
   {
//       return m_clazz.getSimpleName();
       return m_typeName;
   }
   public Class getScope()
   {
       return m_clazz;
   }

}