1 /*
2 * Copyright (c) 2003
3 * Information Desire GmbH
4 * All rights reserved.
5 */
6 package com.infodesire.infobit.external;
7
8 import com.infodesire.infobit.InfobitException;
9 import com.infodesire.infobit.InfobitManager;
10
11 import java.io.Writer;
12
13 import java.util.Collection;
14 import java.util.Properties;
15
16 /***
17 * Defines the protocol to convert a set of infobits into an external (XML)
18 * representation
19 *
20 * @author peter2
21 * @created August 26, 2003
22 * @version $Revision: 1.1 $
23 */
24 public interface InfobitExporter {
25
26 /***
27 * Defines the manager to work with.
28 *
29 * @param manager The manager to access infobits
30 */
31 void setManager(InfobitManager manager);
32
33
34 /***
35 * Gets the manager to work with.
36 *
37 * @return The manager to access infobits
38 */
39 InfobitManager getManager();
40
41
42 /***
43 * Prepares the instance to be used.
44 *
45 * @exception InfobitException Description of Exception
46 */
47 void init() throws InfobitException;
48
49
50 /***
51 * Converts the specified set of infobits into an XML representation.
52 *
53 * @param infobits The infobits to externalize. Infobits are
54 * externalized in the order obtained from than argument. Collection of
55 * {@link Infobit}.
56 * @param writer The destination where to write the XML
57 * representation of <code>infobits</code> to
58 * @exception InfobitException Unexpected error condition
59 */
60 void export(Collection infobits, Writer writer) throws InfobitException;
61
62 }
This page was automatically generated by Maven