Package org.xwiki.officeimporter.script

Class LegacyOfficeImporterScriptService

java.lang.Object

org.xwiki.officeimporter.script.OfficeImporterScriptService

org.xwiki.officeimporter.script.LegacyOfficeImporterScriptService

All Implemented Interfaces:

org.xwiki.script.service.ScriptService

@Component
@Named("officeimporter")
@Singleton
public class LegacyOfficeImporterScriptService
extends OfficeImporterScriptService

Legacy version of OfficeImporterScriptService, holding deprecated methods.

Since:

14.10.2, 15.0RC1

Version:

$Id: 3f0a0057d6ff4065603dbcce3625e4d74345c2f5 $

Field Summary

Fields inherited from class org.xwiki.officeimporter.script.OfficeImporterScriptService

OFFICE_IMPORTER_ERROR

Constructor Summary

Constructors

Constructor	Description
LegacyOfficeImporterScriptService()

Method Summary

Modifier and Type	Method	Description
XDOMOfficeDocument	officeToXDOM(InputStream officeFileStream, String officeFileName, String referenceDocument, boolean filterStyles)	Deprecated. use OfficeImporterScriptService.officeToXDOM(InputStream, String, DocumentReference, boolean) instead
XHTMLOfficeDocument	officeToXHTML(InputStream officeFileStream, String officeFileName, String referenceDocument, boolean filterStyles)	Deprecated. use OfficeImporterScriptService.officeToXHTML(InputStream, String, DocumentReference, boolean) instead
boolean	save(XDOMOfficeDocument doc, String target, String syntaxId, String parent, String title, boolean append)	Deprecated. use OfficeImporterScriptService.save(XDOMOfficeDocument, DocumentReference, String, DocumentReference, String, boolean) instead
Map<TargetDocumentDescriptor,XDOMOfficeDocument>	split(XDOMOfficeDocument xdomDocument, String[] headingLevels, String namingCriterionHint, String rootDocumentName)	Deprecated. use OfficeImporterScriptService.split(XDOMOfficeDocument, String[], String, DocumentReference) instead

Methods inherited from class org.xwiki.officeimporter.script.OfficeImporterScriptService

getErrorMessage, officeToXDOM, officeToXHTML, save, save, save, split, split, xhtmlToXDOM

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LegacyOfficeImporterScriptService

public LegacyOfficeImporterScriptService()

Method Detail

officeToXHTML

public XHTMLOfficeDocument officeToXHTML(InputStream officeFileStream,
                                         String officeFileName,
                                         String referenceDocument,
                                         boolean filterStyles)

Deprecated.

use OfficeImporterScriptService.officeToXHTML(InputStream, String, DocumentReference, boolean) instead

Imports the given office document into an XHTMLOfficeDocument.

Parameters:

officeFileStream - binary data stream corresponding to input office document

officeFileName - name of the input office document, this argument is mainly used for determining input document format where necessary

referenceDocument - reference wiki document w.r.t which import process is carried out; this argument affects the attachment URLs generated during the import process where all references to attachments will be calculated assuming that the attachments are contained on the reference document

filterStyles - whether to filter styling information associated with the office document's content or not

Returns:

XHTMLOfficeDocument containing xhtml result of the import operation or null if an error occurs

Since:

2.2M1

officeToXDOM

public XDOMOfficeDocument officeToXDOM(InputStream officeFileStream,
                                       String officeFileName,
                                       String referenceDocument,
                                       boolean filterStyles)

Deprecated.

use OfficeImporterScriptService.officeToXDOM(InputStream, String, DocumentReference, boolean) instead

Imports the given office document into an XDOMOfficeDocument.

Parameters:

officeFileStream - binary data stream corresponding to input office document

officeFileName - name of the input office document, this argument is mainly is used for determining input document format where necessary

referenceDocument - reference wiki document w.r.t which import process is carried out; this srgument affects the attachment URLs generated during the import process where all references to attachments will be calculated assuming that the attachments are contained on the reference document

filterStyles - whether to filter styling information associated with the office document's content or not

Returns:

XDOMOfficeDocument containing XDOM result of the import operation or null if an error occurs

save

public boolean save(XDOMOfficeDocument doc,
                    String target,
                    String syntaxId,
                    String parent,
                    String title,
                    boolean append)

Deprecated.

use OfficeImporterScriptService.save(XDOMOfficeDocument, DocumentReference, String, DocumentReference, String, boolean) instead

Attempts to save the given XDOMOfficeDocument into the target wiki page specified by arguments.

Parameters:

doc - XDOMOfficeDocument to be saved

target - name of the target wiki page

syntaxId - syntax of the target wiki page

parent - name of the parent wiki page or null

title - title of the target wiki page or null

append - whether to append content if the target wiki page exists

Returns:

true if the operation completes successfully, false otherwise

split

public Map<TargetDocumentDescriptor,XDOMOfficeDocument> split(XDOMOfficeDocument xdomDocument,
                                                                    String[] headingLevels,
                                                                    String namingCriterionHint,
                                                                    String rootDocumentName)

Deprecated.

use OfficeImporterScriptService.split(XDOMOfficeDocument, String[], String, DocumentReference) instead

Splits the given XDOMOfficeDocument into multiple XDOMOfficeDocument instances according to the specified criterion. This method is useful when a single office document has to be imported and split into multiple wiki pages. An auto generated TOC structure will be returned associated to rootDocumentName TargetDocumentDescriptor entry.

Parameters:

xdomDocument - XDOMOfficeDocument to be split

headingLevels - heading levels defining the split points on the original document

namingCriterionHint - hint indicating the child pages naming criterion

rootDocumentName - name of the root document w.r.t which splitting will occur; in the results set the entry corresponding to rootDocumentName TargetDocumentDescriptor will hold an auto-generated TOC structure

Returns:

a map holding XDOMOfficeDocument fragments against corresponding TargetDocumentDescriptor instances or null if an error occurs