KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > alfresco > service > cmr > view > ExporterService


1 /*
2  * Copyright (C) 2005 Alfresco, Inc.
3  *
4  * Licensed under the Mozilla Public License version 1.1
5  * with a permitted attribution clause. You may obtain a
6  * copy of the License at
7  *
8  * http://www.alfresco.org/legal/license.txt
9  *
10  * Unless required by applicable law or agreed to in writing,
11  * software distributed under the License is distributed on an
12  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
13  * either express or implied. See the License for the specific
14  * language governing permissions and limitations under the
15  * License.
16  */
17 package org.alfresco.service.cmr.view;
18
19 import java.io.OutputStream JavaDoc;
20
21
22 /**
23  * Exporter Service
24  *
25  * @author David Caruana
26  */
27 public interface ExporterService
28 {
29     /**
30      * Export a view of the Repository using the default xml view schema.
31      *
32      * All repository information is exported to the single output stream. This means that any
33      * content properties are base64 encoded.
34      *
35      * @param viewWriter the output stream to export to
36      * @param parameters export parameters
37      * @param progress exporter callback for tracking progress of export
38      */
39     public void exportView(OutputStream JavaDoc viewWriter, ExporterCrawlerParameters parameters, Exporter progress)
40         throws ExporterException;
41
42     /**
43      * Export a view of the Repository using the default xml view schema.
44      *
45      * This export supports the custom handling of content properties.
46      *
47      * @param exportHandler the custom export handler for content properties
48      * @param parameters export parameters
49      * @param progress exporter callback for tracking progress of export
50      */
51     public void exportView(ExportPackageHandler exportHandler, ExporterCrawlerParameters parameters, Exporter progress)
52         throws ExporterException;
53
54     
55     /**
56      * Export a view of the Repository using a custom crawler and exporter.
57      *
58      * @param exporter custom exporter
59      * @param parameters export parameters
60      * @param progress exporter callback for tracking progress of export
61      */
62     public void exportView(Exporter exporter, ExporterCrawlerParameters parameters, Exporter progress);
63     
64 }
65
Popular Tags