View Javadoc

1   /*
2    * Copyright (C) 2004 Christian Siefkes <christian@siefkes.net>.
3    * Development of this software is supported by the German Research Society,
4    * Berlin-Brandenburg Graduate School in Distributed Information Systems
5    * (DFG grant no. GRK 316).
6    *
7    * This library is free software; you can redistribute it and/or
8    * modify it under the terms of the GNU Lesser General Public
9    * License as published by the Free Software Foundation; either
10   * version 2.1 of the License, or (at your option) any later version.
11   *
12   * This library is distributed in the hope that it will be useful,
13   * but WITHOUT ANY WARRANTY; without even the implied warranty of
14   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15   * Lesser General Public License for more details.
16   *
17   * You should have received a copy of the GNU Lesser General Public
18   * License along with this library; if not, visit
19   * http://www.gnu.org/licenses/lgpl.html or write to the Free Software
20   * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.
21   */
22  package de.fu_berlin.ties.filter;
23  
24  import org.dom4j.Element;
25  
26  import de.fu_berlin.ties.ProcessingException;
27  
28  /***
29   * An oracle decides whether {@link de.fu_berlin.ties.filter.ElementFilter}s
30   * should match elements. They can be used to train
31   * {@link de.fu_berlin.ties.filter.TrainableFilter}s.
32   *
33   * @author Christian Siefkes
34   * @version $Revision: 1.1 $, $Date: 2004/08/23 17:10:10 $, $Author: siefkes $
35   */
36  public interface Oracle {
37  
38      /***
39       * Decides whether an element should be accepted by filters.
40       *
41       * @param element the element to test
42       * @return <code>true</code> if filters should accept the element;
43       * <code>false</code> otherwise
44       * @throws ProcessingException if an error occurs during filtering
45       */
46      boolean shouldMatch(final Element element) throws ProcessingException;
47  
48  }