1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
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 import de.fu_berlin.ties.text.TokenDetails;
31
32 /***
33 * Interface for a processor that operates on tokens in XML documents.
34 *
35 * @author Christian Siefkes
36 * @version $Revision: 1.3 $, $Date: 2004/11/19 14:05:09 $, $Author: siefkes $
37 */
38 public interface TokenProcessor {
39
40 /***
41 * Processes a token in an XML element, optionally modifying the
42 * element or the document it is part of.
43 *
44 * @param element the element containing the token
45 * @param left the textual contents of the element to the left of the
46 * <code>token</code> (in case of mixed contents, only up to the last
47 * preceding child element, if any)
48 * @param details details about the token to process
49 * @param right the textual contents of the element to the right of the
50 * <code>token</code> (in case of mixed contents, only up to the next
51 * following child element, if any)
52 * @param context a map of objects that are made available for processing
53 * @throws IOException if an I/O error occurs
54 * @throws ProcessingException if an error occurs during processing
55 */
56 void processToken(final Element element, final String left,
57 final TokenDetails details, final String right,
58 final ContextMap context) throws IOException, ProcessingException;
59
60 }