View Javadoc

1   /*
2    * Copyright (C) 2003-2006 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 program is free software; you can redistribute it and/or modify
8    * it under the terms of the GNU General Public License as published by
9    * the Free Software Foundation; either version 2 of the License, or
10   * (at your option) any later version.
11   *
12   * This program 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
15   * GNU General Public License for more details.
16   *
17   * You should have received a copy of the GNU General Public License
18   * along with this program; if not, visit
19   * http://www.gnu.org/licenses/gpl.html or write to the Free Software
20   * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
21   */
22  package de.fu_berlin.ties.xml.dom;
23  
24  import java.io.IOException;
25  
26  import org.dom4j.Element;
27  
28  import de.fu_berlin.ties.ContextMap;
29  import de.fu_berlin.ties.ProcessingException;
30  
31  import de.fu_berlin.ties.text.TokenContainer;
32  
33  /***
34   * Interface for a processor that operates on elements in XML documents.
35   *
36   * @author Christian Siefkes
37   * @version $Revision: 1.5 $, $Date: 2006/10/21 16:04:33 $, $Author: siefkes $
38   */
39  public interface ElementProcessor {
40  
41      /***
42       * Processes an element in an XML document, optionally modifying the
43       * element or the document it is part of.
44       *
45       * @param element the element to process
46       * @param tokenContainer a container storing all tokens seen in the
47       * document so far; {@link TokenContainer#getLast()} contains the textual
48       * content of the element and its child elements
49       * @param context a map of objects that are made available for processing
50       * @throws IOException if an I/O error occurs
51       * @throws ProcessingException if an error occurs during processing
52       */
53      void processElement(final Element element,
54              final TokenContainer tokenContainer, final ContextMap context)
55              throws IOException, ProcessingException;
56  
57  }