FilterChain.java

package jav.gui.filter;

import jav.correctionBackend.Token;
import java.util.ArrayList;
import java.util.Iterator;


/**
 *Copyright (c) 2012, IMPACT working group at the Centrum für Informations- und Sprachverarbeitung, University of Munich.
 *All rights reserved.

 *Redistribution and use in source and binary forms, with or without
 *modification, are permitted provided that the following conditions are met:

 *Redistributions of source code must retain the above copyright
 *notice, this list of conditions and the following disclaimer.
 *Redistributions in binary form must reproduce the above copyright
 *notice, this list of conditions and the following disclaimer in the
 *documentation and/or other materials provided with the distribution.

 *THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
 *IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
 *TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
 *PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 *HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 *SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 *LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 *DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 *THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 *(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 *OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 * 
 * This file is part of the ocr-postcorrection tool developed
 * by the IMPACT working group at the Centrum für Informations- und Sprachverarbeitung, University of Munich.
 * For further information and contacts visit http://ocr.cis.uni-muenchen.de/
 * 
 * @author thorsten (thorsten.vobl@googlemail.com)
 */
public class FilterChain implements AbstractTokenFilter {

	private ArrayList<AbstractTokenFilter> filterList;
	private ArrayList<Token> tokRL;
	private ChainType ct;
        private String name;

	public FilterChain(ChainType c) {
		this.ct = c;
                this.name = "";
		filterList = new ArrayList<AbstractTokenFilter>();
	}

	public void setChainType(ChainType c) {
		this.ct = c;
	}

	public void addFilter(AbstractTokenFilter f) {
		filterList.add(f);
                this.name += " "+f.getName();
	}

    @Override
        public void setName( String n) {
            this.name = n;
        }

    @Override
        public String getName() {
            return this.name;
        }

	@Override
	public boolean applies(Token tok) {
		boolean retVal = false;
		for (AbstractTokenFilter af : filterList) {
			
			retVal = af.applies(tok);
			
			// if one filter fails, whole "and" chain fails
			if (this.ct == ChainType.AND && retVal == false) {
				break;
			}
			// if one filter succeeds, whole "or" chain succeeds
			if (this.ct == ChainType.OR && retVal == true) {
				break;
			}
		}
		return retVal;
	}

	@Override
	public ArrayList<Token> applyFilter(Iterator<Token> i) {
		tokRL = new ArrayList<Token>();
		while (i.hasNext()) {
			Token tok = i.next();
			if (this.applies(tok)) {
				tokRL.add(tok);
			}
		}
		return tokRL;
	}

	@Override
	public ArrayList<Token> applyFilter(ArrayList<Token> a) {
		tokRL = new ArrayList<Token>();
		for (Token tok : a) {
			if (this.applies(tok)) {
				tokRL.add(tok);
			}
		}
		return tokRL;
	}
}