View Javadoc

1   /*
2    * Copyright (C) 2005-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.filter;
23  
24  import java.io.File;
25  import java.io.IOException;
26  
27  import org.dom4j.Document;
28  
29  import de.fu_berlin.ties.ProcessingException;
30  
31  /***
32   * An interface for classes that rewrite documents, for example for adding
33   * semantic information. Document rewriters <strong>must not</strong> modify
34   * the textual content of a document, they may only modify XML elements and
35   * attributes.
36   *
37   * @author Christian Siefkes
38   * @version $Revision: 1.3 $, $Date: 2006/10/21 16:04:19 $, $Author: siefkes $
39   */
40  public interface DocumentRewriter {
41  
42      /***
43       * Rewrites a document.
44       *
45       * @param doc the document to modify
46       * @param filename the name of the document
47       * @return the modified document; this object may or may not be identical
48       * to the <code>document</code> passed it
49       * @throws IOException if an I/O error occurs
50       * @throws ProcessingException if an error occurs during rewriting
51       */
52      Document rewrite(final Document doc, final File filename)
53      throws IOException, ProcessingException;
54  
55  }