LibreOffice Module xmerge (master)  1
Public Member Functions | Private Attributes | List of all members
org.openoffice.xmerge.PluginFactory Class Referenceabstract

A. More...

Inheritance diagram for org.openoffice.xmerge.PluginFactory:
[legend]
Collaboration diagram for org.openoffice.xmerge.PluginFactory:
[legend]

Public Member Functions

 PluginFactory (ConverterInfo ci)
 Constructor that caches the. More...
 
ConverterInfo getConverterInfo ()
 Returns the. More...
 
abstract Document createOfficeDocument (String name, InputStream is) throws IOException
 Create a. More...
 
abstract Document createOfficeDocument (String name, InputStream is, boolean isZip) throws IOException
 Create a. More...
 
abstract Document createDeviceDocument (String name, InputStream is) throws IOException
 Create a. More...
 

Private Attributes

final ConverterInfo ciCache
 Cached. More...
 

Detailed Description

A.

encapsulates the conversions from one

format to another.

It provides conversions in both directions. Refer to the package description for its usage.

Conversion from the "Office"

format to a "Device"

format may be lossy, i.e. some information may be lost. If a plug-in implements the

DocumentMergerFactory

interface, then there is the possibility for merging the changes done on the "Device"

back to the original "Office"

via the

DocumentMerger

interface.

Plug-ins that convert from the "Device"

format to the "Office"

format must implement the

DocumentDeserializerFactory

interface. Plug-ins that convert from the "Office"

format to the "Device" format must implement the

DocumentSerializerFactory

interface.

All plug-ins should have an associated Plug-in Configuration XML File which describes the capabilities of the plug-in. If the plug-in is bundled in a jarfile, then this XML file is also bundled with the jarfile. The data in the XML file is managed by the

ConverterInfo

object. The

ConverterInfoMgr

manages a registry of all

ConverterInfo

objects. For more information about this XML file, refer to org.openoffice.xmerge.util.registry.

See also
Document
DocumentSerializer
DocumentSerializerFactory
DocumentDeserializer
DocumentDeserializerFactory
DocumentMerger
DocumentMergerFactory
ConverterInfo
org.openoffice.xmerge.util.registry.ConverterInfoMgr

Definition at line 67 of file PluginFactory.java.

Constructor & Destructor Documentation

org.openoffice.xmerge.PluginFactory.PluginFactory ( ConverterInfo  ci)
inline

Constructor that caches the.

ConvertInfo

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

Parameters
ci

Definition at line 80 of file PluginFactory.java.

Member Function Documentation

abstract Document org.openoffice.xmerge.PluginFactory.createDeviceDocument ( String  name,
InputStream  is 
) throws IOException
abstract

Create a.

object that corresponds to the device 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

object will contain the necessary data for the other objects created by the

to process, like a

DocumentSerializer

object and a

DocumentMerger

object.

Parameters
nameThe name.
is

Referenced by org.openoffice.xmerge.Convert.addInputStream().

abstract Document org.openoffice.xmerge.PluginFactory.createOfficeDocument ( String  name,
InputStream  is 
) throws IOException
abstract

Create a.

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

object will contain the necessary data for the other objects created by the

to process, like a

DocumentSerializer

object and a

DocumentMerger

object.

Parameters
nameThe name.
is

Referenced by org.openoffice.xmerge.Convert.addInputStream(), and org.openoffice.xmerge.Convert.getOfficeDocument().

abstract Document org.openoffice.xmerge.PluginFactory.createOfficeDocument ( String  name,
InputStream  is,
boolean  isZip 
) throws IOException
abstract

Create a.

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

object will contain the necessary data for the other objects created by the

to process, like a

DocumentSerializer

object and a

DocumentMerger

object.

Parameters
nameThe name.
is
ConverterInfo org.openoffice.xmerge.PluginFactory.getConverterInfo ( )
inline

Member Data Documentation

final ConverterInfo org.openoffice.xmerge.PluginFactory.ciCache
private

Cached.

ConvertInfo

object.

Definition at line 72 of file PluginFactory.java.

Referenced by org.openoffice.xmerge.PluginFactory.getConverterInfo().


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