LibreOffice Module xmerge (master) 1
Public Member Functions | List of all members
org.openoffice.xmerge.converter.xml.sxc.SxcPluginFactory Class Referenceabstract

General implementation of the PluginFactory interface for SXC Document objects. More...

Inheritance diagram for org.openoffice.xmerge.converter.xml.sxc.SxcPluginFactory:
[legend]
Collaboration diagram for org.openoffice.xmerge.converter.xml.sxc.SxcPluginFactory:
[legend]

Public Member Functions

 SxcPluginFactory (ConverterInfo ci)
 Constructor that caches the ConvertInfo that corresponds to the registry information for this plug-in. More...
 
Document createOfficeDocument (String name, InputStream is) throws IOException
 Create a Document object that corresponds to the Office data passed in via the InputStream object. More...
 
Document createOfficeDocument (String name, InputStream is, boolean isZip) throws IOException
 Create a Document object that corresponds to the Office data passed in via the InputStream object. More...
 
- Public Member Functions inherited from org.openoffice.xmerge.PluginFactory
 PluginFactory (ConverterInfo ci)
 Constructor that caches the ConvertInfo that corresponds to the registry information for this plug-in. More...
 
ConverterInfo getConverterInfo ()
 Returns the ConvertInfo that corresponds to this plug-in. More...
 
abstract Document createOfficeDocument (String name, InputStream is) throws IOException
 Create a Document object that corresponds to the Office data passed in via the InputStream object. More...
 
abstract Document createOfficeDocument (String name, InputStream is, boolean isZip) throws IOException
 Create a Document object that corresponds to the Office data passed in via the InputStream object. More...
 
abstract Document createDeviceDocument (String name, InputStream is) throws IOException
 Create a Document object that corresponds to the device data passed in via the InputStream object. More...
 
- Public Member Functions inherited from org.openoffice.xmerge.DocumentMergerFactory
DocumentMerger createDocumentMerger (Document doc)
 Create a DocumentMerger object given a Document object. More...
 

Detailed Description

General implementation of the PluginFactory interface for SXC Document objects.

See also
org.openoffice.xmerge.DocumentDeserializer
org.openoffice.xmerge.DocumentMerger
org.openoffice.xmerge.DocumentSerializer

Definition at line 37 of file SxcPluginFactory.java.

Constructor & Destructor Documentation

◆ SxcPluginFactory()

org.openoffice.xmerge.converter.xml.sxc.SxcPluginFactory.SxcPluginFactory ( ConverterInfo  ci)
inline

Constructor that caches the ConvertInfo that corresponds to the registry information for this plug-in.

Parameters
ciConvertInfo object.

Definition at line 46 of file SxcPluginFactory.java.

Member Function Documentation

◆ createOfficeDocument() [1/2]

Document org.openoffice.xmerge.converter.xml.sxc.SxcPluginFactory.createOfficeDocument ( String  name,
InputStream  is 
) throws IOException
inline

Create a Document object that corresponds to the Office data passed in via the InputStream object.

This abstract method must be implemented for each plug-in.

This method will read from the given InputStream object. The returned Document object will contain the necessary data for the other objects created by the PluginFactory to process, like a DocumentSerializer object and a DocumentMerger object.

Parameters
nameThe Document name.
isInputStream object corresponding to the Document.
Returns
A Document object representing the particular Document format for the PluginFactory.
Exceptions
IOExceptionIf any I/O error occurs.

Reimplemented from org.openoffice.xmerge.PluginFactory.

Definition at line 51 of file SxcPluginFactory.java.

References name.

◆ createOfficeDocument() [2/2]

Document org.openoffice.xmerge.converter.xml.sxc.SxcPluginFactory.createOfficeDocument ( String  name,
InputStream  is,
boolean  isZip 
) throws IOException
inline

Create a Document object that corresponds to the Office data passed in via the InputStream object.

This abstract method must be implemented for each plug-in.

This method will read from the given InputStream object. The returned Document object will contain the necessary data for the other objects created by the PluginFactory to process, like a DocumentSerializer object and a DocumentMerger object.

Parameters
nameThe Document name.
isInputStream object corresponding to the Document.
isZipboolean to show that the created office document is to be zipped.
Returns
A Document object representing the particular Document format for the PluginFactory.
Exceptions
IOExceptionIf any I/O error occurs.

Reimplemented from org.openoffice.xmerge.PluginFactory.

Definition at line 61 of file SxcPluginFactory.java.

References name.


The documentation for this class was generated from the following file: