1 /*
2 * This file is part of *** M y C o R e ***
3 * See http://www.mycore.de/ for details.
4 *
5 * MyCoRe is free software: you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation, either version 3 of the License, or
8 * (at your option) any later version.
9 *
10 * MyCoRe is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
14 *
15 * You should have received a copy of the GNU General Public License
16 * along with MyCoRe. If not, see <http://www.gnu.org/licenses/>.
17 */
18
19 package org.mycore.frontend.xeditor;
20
21 import java.io.IOException;
22 import java.util.Map;
23
24 import org.jdom2.Document;
25 import org.jdom2.JDOMException;
26 import org.xml.sax.SAXException;
27
28 /**
29 * If you implement this interface then you should have a default constructor if you want it to use with.
30 * @author Sebastian Hofmann (mcrshofm)
31 */
32 public interface MCRXEditorPostProcessor {
33 /**
34 * Do the post processing.
35 * @param xml the document which has to be post processed
36 * @return the post processed document
37 * @throws IOException
38 * @throws JDOMException
39 * @throws SAXException
40 */
41 Document process(Document xml) throws IOException, JDOMException, SAXException;
42
43 /**
44 * Will be called before {@link #process(Document)}.
45 * @param attributeMap a map which contains the name(key) and value of attributes of the postprocessor element.
46 */
47 void setAttributes(Map<String, String> attributeMap);
48 }