Class | Line # | Actions | |||||
---|---|---|---|---|---|---|---|
PresentationBuilder | 38 | 0 | - | 0 | 0 |
1 | /* | |
2 | * See the NOTICE file distributed with this work for additional | |
3 | * information regarding copyright ownership. | |
4 | * | |
5 | * This is free software; you can redistribute it and/or modify it | |
6 | * under the terms of the GNU Lesser General Public License as | |
7 | * published by the Free Software Foundation; either version 2.1 of | |
8 | * the License, or (at your option) any later version. | |
9 | * | |
10 | * This software 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 GNU | |
13 | * Lesser General Public License for more details. | |
14 | * | |
15 | * You should have received a copy of the GNU Lesser General Public | |
16 | * License along with this software; if not, write to the Free | |
17 | * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA | |
18 | * 02110-1301 USA, or see the FSF site: http://www.fsf.org. | |
19 | */ | |
20 | package org.xwiki.officeimporter.builder; | |
21 | ||
22 | import java.io.InputStream; | |
23 | ||
24 | import org.xwiki.component.annotation.Role; | |
25 | import org.xwiki.model.reference.DocumentReference; | |
26 | import org.xwiki.officeimporter.OfficeImporterException; | |
27 | import org.xwiki.officeimporter.document.XDOMOfficeDocument; | |
28 | ||
29 | /** | |
30 | * Component responsible for building {@link XDOMOfficeDocument} objects from binary (presentation) office files. This | |
31 | * component builds {@link XDOMOfficeDocument} objects which when rendered produces a slid-show like feeling on the wiki | |
32 | * page. | |
33 | * | |
34 | * @version $Id: 236add599482131ea20e5069c91b4f5a80fd368d $ | |
35 | * @since 2.1M1 | |
36 | */ | |
37 | @Role | |
38 | public interface PresentationBuilder | |
39 | { | |
40 | /** | |
41 | * Builds a (slide-show) {@link XDOMOfficeDocument} corresponding to the given office presentation. | |
42 | * | |
43 | * @param officeFileStream {@link InputStream} corresponding to the office presentation. | |
44 | * @param officeFileName name of the office document (used to determine input document format). | |
45 | * @param reference reference document w.r.t which the presentation is built. | |
46 | * @return {@link XDOMOfficeDocument} corresponding to the given office presentation. | |
47 | * @throws OfficeImporterException if an error occurs while performing the import operation. | |
48 | */ | |
49 | XDOMOfficeDocument build(InputStream officeFileStream, String officeFileName, DocumentReference reference) | |
50 | throws OfficeImporterException; | |
51 | } |