1. Project Clover database Tue Dec 20 2016 21:24:09 CET
  2. Package org.xwiki.officeimporter.builder

File XDOMOfficeDocumentBuilder.java

 

Code metrics

0
0
0
1
64
14
0
-
-
0
-

Classes

Class Line # Actions
XDOMOfficeDocumentBuilder 38 0 - 0 0
-1.0 -
 

Contributing tests

No tests hitting this source file were found.

Source view

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    import org.xwiki.officeimporter.document.XHTMLOfficeDocument;
29   
30    /**
31    * Component responsible for building {@link XDOMOfficeDocument} objects from binary office files or
32    * {@link XHTMLOfficeDocument} objects.
33    *
34    * @version $Id: a0133489a2f2cd2e82ffbe1897e66b55470bbfce $
35    * @since 2.1M1
36    */
37    @Role
 
38    public interface XDOMOfficeDocumentBuilder
39    {
40    /**
41    * Builds a {@link XDOMOfficeDocument} corresponding to the given office document.
42    *
43    * @param officeFileStream {@link InputStream} corresponding to the office document
44    * @param officeFileName name of the office document (used to determine input document format)
45    * @param reference reference document w.r.t which HTML cleaning is performed. If the office file contains images or
46    * other binary artifacts, HTML cleaning will be performed assuming that those artifacts are present as
47    * attachments to the reference document
48    * @param filterStyles whether to filter CSS styles present in the HTML content produced by the office server
49    * @return an {@link XDOMOfficeDocument} corresponding to the office document
50    * @throws OfficeImporterException if an error occurs while performing the import operation
51    * @since 2.2M1
52    */
53    XDOMOfficeDocument build(InputStream officeFileStream, String officeFileName, DocumentReference reference,
54    boolean filterStyles) throws OfficeImporterException;
55   
56    /**
57    * Builds a {@link XDOMOfficeDocument} from the given {@link XHTMLOfficeDocument}.
58    *
59    * @param xhtmlOfficeDocument {@link XHTMLOfficeDocument} already built using {@link XHTMLOfficeDocumentBuilder}
60    * @return an {@link XDOMOfficeDocument} corresponding to the given {@link XHTMLOfficeDocument}
61    * @throws OfficeImporterException if an error occurs while parsing XHTML into XDOM
62    */
63    XDOMOfficeDocument build(XHTMLOfficeDocument xhtmlOfficeDocument) throws OfficeImporterException;
64    }