1 /*
2 * Copyright 2015 Data Archiving and Networked Services (an institute of
3 * Koninklijke Nederlandse Akademie van Wetenschappen), King's College London,
4 * Georg-August-Universitaet Goettingen Stiftung Oeffentlichen Rechts
5 *
6 * Licensed under the EUPL, Version 1.1 or – as soon they will be approved by
7 * the European Commission - subsequent versions of the EUPL (the "Licence");
8 * You may not use this work except in compliance with the Licence.
9 * You may obtain a copy of the Licence at:
10 *
11 * https://joinup.ec.europa.eu/software/page/eupl
12 *
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the Licence is distributed on an "AS IS" basis,
15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the Licence for the specific language governing
17 * permissions and limitations under the Licence.
18 */
19
20 package eu.ehri.project.exporters.eac;
21
22 import eu.ehri.project.exporters.xml.XmlExporter;
23 import eu.ehri.project.models.HistoricalAgent;
24 import org.w3c.dom.Document;
25
26 import javax.xml.transform.TransformerException;
27 import java.io.IOException;
28 import java.io.OutputStream;
29
30 /**
31 * Encoded Archive Context (EAC) export.
32 */
33 public interface EacExporter extends XmlExporter<HistoricalAgent> {
34
35 /**
36 * Export a historical agent as an EAC document.
37 *
38 * @param agent the historical agent
39 * @param outputStream the output stream to write to.
40 * @param langCode the preferred language code when multiple
41 * descriptions are available
42 */
43 void export(HistoricalAgent agent,
44 OutputStream outputStream, String langCode) throws IOException, TransformerException;
45
46 /**
47 * Export a historical agent as an EAC document.
48 *
49 * @param agent the historical agent
50 * @param langCode the preferred language code when multiple
51 * descriptions are available
52 * @return a DOM document
53 */
54 Document export(HistoricalAgent agent, String langCode) throws IOException;
55 }