01: // htmlFilterTransformer.java
02: // ---------------------------
03: // (C) by Michael Peter Christen; mc@anomic.de
04: // first published on http://www.anomic.de
05: // Frankfurt, Germany, 2004
06: // last major change: 18.02.2004
07: //
08: // This program is free software; you can redistribute it and/or modify
09: // it under the terms of the GNU General Public License as published by
10: // the Free Software Foundation; either version 2 of the License, or
11: // (at your option) any later version.
12: //
13: // This program is distributed in the hope that it will be useful,
14: // but WITHOUT ANY WARRANTY; without even the implied warranty of
15: // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16: // GNU General Public License for more details.
17: //
18: // You should have received a copy of the GNU General Public License
19: // along with this program; if not, write to the Free Software
20: // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
21: //
22: // Using this software in any meaning (reading, learning, copying, compiling,
23: // running) means that you agree that the Author(s) is (are) not responsible
24: // for cost, loss of data or any harm that may be caused directly or indirectly
25: // by usage of this softare or this documentation. The usage of this software
26: // is on your own risk. The installation and usage (starting/running) of this
27: // software may allow other people or application to access your computer and
28: // any attached devices and is highly dependent on the configuration of the
29: // software which must be done by the user of the software; the author(s) is
30: // (are) also not responsible for proper configuration and usage of the
31: // software, even if provoked by documentation provided together with
32: // the software.
33: //
34: // Any changes to this file according to the GPL as documented in the file
35: // gpl.txt aside this file in the shipment you received can be done to the
36: // lines that follows this copyright notice here, but changes must not be
37: // done inside the copyright notive above. A re-distribution must contain
38: // the intact and unchanged copyright notice.
39: // Contributions and changes to the program code must be marked as such.
40:
41: package de.anomic.htmlFilter;
42:
43: import java.util.Properties;
44:
45: public interface htmlFilterTransformer {
46:
47: // the init method is used to initialize the transformer with some values
48: // i.e. the initarg - String can be the name of a file which may contain
49: // more specific transformation rules
50: public void init(String initarg);
51:
52: // ask if this transformer will do any transformation whatsoever
53: // this may return true if the initialization resulted in a status
54: // that does not allow any transformation
55: public boolean isIdentityTransformer();
56:
57: // tests, if a given body-less tag (i.e. <br> shall be supervised)
58: // only tags that are defined here will be cached and not streamed
59: public boolean isTag0(String tag);
60:
61: // tests if a given tag that may have a body (i.e. <tt> ..body.. </tt>)
62: // shall be supervised
63: public boolean isTag1(String tag);
64:
65: // method that is called with any text between tags
66: // the returned text replaces the given text
67: // if the text shall not be changed, it must be returned as called
68: public char[] transformText(char[] text);
69:
70: // method that is called when a body-less tag occurs
71: public char[] transformTag0(String tagname, Properties tagopts,
72: char quotechar);
73:
74: // method that is called when a body-containing text occurs
75: public char[] transformTag1(String tagname, Properties tagopts,
76: char[] text, char quotechar);
77:
78: public void close();
79: }
|