RELEASE_2_1_13/src/blocks/forms/java/org/apache/cocoon/forms/formmodel/algorithms/AbstractBaseAlgorithm.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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 org.apache.cocoon.forms.formmodel.algorithms;

import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;

import org.apache.avalon.framework.context.Context;
import org.apache.avalon.framework.context.ContextException;
import org.apache.avalon.framework.context.Contextualizable;
import org.apache.avalon.framework.logger.LogEnabled;
import org.apache.avalon.framework.logger.Logger;
import org.apache.cocoon.forms.formmodel.CalculatedFieldAlgorithm;

/**
 * Abstract base class for algorithms. 
 * 
 * <p> This class implements the getTriggerWidgets method and holds the triggers list. It also implements
 * Contextualizable and LogEnabled to give the algorithms access to the cocoon's ObjectModel and Loggers.
 * </p>
 * 
 * @version $Id$
 */
public abstract class AbstractBaseAlgorithm implements CalculatedFieldAlgorithm, LogEnabled, Contextualizable {

    protected List triggers = new ArrayList();
    private Logger logger = null;
    private Context context = null;
    
    public Iterator getTriggerWidgets() {
        return triggers.iterator();
    }
    
    public void addTrigger(String widget) {
        this.triggers.add(widget);
    }

    public void enableLogging(Logger logger) {
        this.logger = logger;
    }
    
    protected Logger getLogger() {
        return this.logger;
    }

    public void contextualize(Context context) throws ContextException {
        this.context = context;
    }
    
    protected Context getContext() {
        return this.context;
    }

    public void clearTriggers() {
        this.triggers.clear();
    }

}