Mercurial > dive4elements > river
comparison flys-artifacts/src/main/java/de/intevation/flys/exports/AbstractExporter.java @ 3270:4ac581062c40
Fix various documentation issues.
flys-artifacts/trunk@4913 c6561f87-3c4e-4783-a992-168aeb5c3f6f
| author | Felix Wolfsteller <felix.wolfsteller@intevation.de> |
|---|---|
| date | Tue, 10 Jul 2012 12:19:35 +0000 |
| parents | 282c9da923ab |
| children | 118fe1cc8cc8 |
comparison
equal
deleted
inserted
replaced
| 3269:b2ea89a665bc | 3270:4ac581062c40 |
|---|---|
| 53 public static final char DEFAULT_CSV_SEPARATOR = ','; | 53 public static final char DEFAULT_CSV_SEPARATOR = ','; |
| 54 | 54 |
| 55 /** XPath that points to the desired export facet. */ | 55 /** XPath that points to the desired export facet. */ |
| 56 public static final String XPATH_FACET = "/art:action/@art:type"; | 56 public static final String XPATH_FACET = "/art:action/@art:type"; |
| 57 | 57 |
| 58 | |
| 59 /** The document of the incoming out() request. */ | 58 /** The document of the incoming out() request. */ |
| 60 protected Document request; | 59 protected Document request; |
| 61 | 60 |
| 62 /** The output stream where the data should be written to. */ | 61 /** The output stream where the data should be written to. */ |
| 63 protected OutputStream out; | 62 protected OutputStream out; |
| 90 | 89 |
| 91 /** | 90 /** |
| 92 * This method enables concrete subclasses to collected its own special | 91 * This method enables concrete subclasses to collected its own special |
| 93 * data. | 92 * data. |
| 94 * | 93 * |
| 95 * @param artifacts The artifact that stores the data that has to be | 94 * @param data The artifact that stores the data that has to be |
| 96 * exported. | 95 * exported. |
| 97 */ | 96 */ |
| 98 protected abstract void addData(Object data); | 97 protected abstract void addData(Object data); |
| 98 | |
| 99 | 99 |
| 100 @Override | 100 @Override |
| 101 public void init(Document request, OutputStream out, CallContext context) { | 101 public void init(Document request, OutputStream out, CallContext context) { |
| 102 logger.debug("AbstractExporter.init"); | 102 logger.debug("AbstractExporter.init"); |
| 103 | 103 |
| 117 * This doOut() just collects the data of multiple artifacts. Therefore, it | 117 * This doOut() just collects the data of multiple artifacts. Therefore, it |
| 118 * makes use of the addData() method which enables concrete subclasses to | 118 * makes use of the addData() method which enables concrete subclasses to |
| 119 * store its data on its own. The real output creation takes place in the | 119 * store its data on its own. The real output creation takes place in the |
| 120 * concrete generate() methods. | 120 * concrete generate() methods. |
| 121 * | 121 * |
| 122 * @param artifact The artifact. | 122 * @param artifactFacet The artifact and facet. |
| 123 * @param facet The facet to add - NOTE: the facet needs to fit to the first | 123 * The facet to add - NOTE: the facet needs to fit to the first |
| 124 * facet inserted into this exporter. Otherwise this artifact/facet is | 124 * facet inserted into this exporter. Otherwise this artifact/facet is |
| 125 * skipped. | 125 * skipped. |
| 126 * @param attr The attr document. | 126 * @param attr The attr document. |
| 127 */ | 127 */ |
| 128 @Override | 128 @Override |