org.openoffice.xmerge.Convert Class Reference

The. More...

Inheritance diagram for org.openoffice.xmerge.Convert:

Collaboration diagram for org.openoffice.xmerge.Convert:

Public Member Functions
	Convert (ConverterInfo ci, boolean toOffice)
	Construct a Convert class with specified. More...
void	addInputStream (String name, InputStream is) throws IOException
	Adds an. More...
void	addInputStream (String name, InputStream is, boolean isZip) throws IOException
	Adds an. More...
DocumentMerger	getDocumentMerger (Document origDoc) throws IOException
	Returns a. More...
Object	clone ()
	Clones a. More...
ConvertData	convert () throws ConvertException, IOException
	Convert the input specified in calls to the. More...
Document	getOfficeDocument (String name, InputStream is) throws IOException
	Returns the appropriate "Office". More...

Private Member Functions
void	reset ()
	Resets the input queue, so that the user can use this class to perform another conversion. More...

Private Attributes
final ConverterInfo	ci
	ConvertInfo that corresponds to the from-mime/to-mime conversion. More...
final boolean	toOffice
final ConvertData	inputCD = new ConvertData()
	Holds the convert input data. More...

Detailed Description

The.

Convert 

class manages a conversion from one mime-type to another.

The

ConvertFactory 

is responsible for returning the appropriate

Convert 

class for a specified conversion. This class is responsible for all interactions with the

PluginFactory 

implementation.

See also

ConverterFactory

PluginFactory

org.openoffice.xmerge.util.registry.ConverterInfo

Definition at line 38 of file Convert.java.

Constructor & Destructor Documentation

org.openoffice.xmerge.Convert.Convert ( ConverterInfo  ci, boolean  toOffice  )

inline

Construct a Convert class with specified.

ConvertInfo 

registry information.

Parameters

ci	A ConvertInfo object containing registry information corresponding to a specific plug-in.
toOffice

Definition at line 61 of file Convert.java.

References org.openoffice.xmerge.Convert.ci, and org.openoffice.xmerge.Convert.toOffice.

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

Member Function Documentation

void org.openoffice.xmerge.Convert.addInputStream ( String  name, InputStream  is  ) throws IOException

inline

Adds an.

InputStream 

to be used as input by the

Convert 

class.

It is possible that many files need to be converted into a single output

Document 

, so this function may be called more than one time. It is the plug-in's responsibility to know how to handle the input.

Parameters

name	The name corresponding to the InputStream .
is

Definition at line 80 of file Convert.java.

References org.openoffice.xmerge.ConvertData.addDocument(), org.openoffice.xmerge.PluginFactory.createDeviceDocument(), org.openoffice.xmerge.PluginFactory.createOfficeDocument(), org.openoffice.xmerge.util.registry.ConverterInfo.getPluginFactory(), and name.

Referenced by org.openoffice.xmerge.util.ActiveSyncDriver.Convert(), XMergeBridge._XMergeBridge.convert(), and org.openoffice.xmerge.test.Driver.doConversion().

void org.openoffice.xmerge.Convert.addInputStream ( String  name, InputStream  is, boolean  isZip  ) throws IOException

inline

Adds an.

InputStream 

to be used as input by the

Convert 

class.

It is possible that many files need to be converted into a single output

Document 

, so this function may be called more than one time. It is the plug-in's responsibility to know how to handle the input.

Parameters

name	The name corresponding to the InputStream .
is

Definition at line 108 of file Convert.java.

References org.openoffice.xmerge.ConvertData.addDocument(), org.openoffice.xmerge.PluginFactory.createDeviceDocument(), org.openoffice.xmerge.PluginFactory.createOfficeDocument(), org.openoffice.xmerge.util.registry.ConverterInfo.getPluginFactory(), and name.

Object org.openoffice.xmerge.Convert.clone ( )

inline

Clones a.

Convert 

object so another Convert object can do the same conversion.

InputStream 

objects passed in via calls to the

addInputStream 

method are not copied.

Returns

The cloned

Convert 

object.

Definition at line 158 of file Convert.java.

References org.openoffice.xmerge.Convert.clone(), org.openoffice.xmerge.Convert.Convert(), Object, org.openoffice.xmerge.Convert.reset(), and System.

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

ConvertData org.openoffice.xmerge.Convert.convert ( ) throws ConvertException, IOException

inline

Convert the input specified in calls to the.

addInputStream 

method to the output format specified by this

Convert 

class.

Returns

The output data.

Exceptions

ConvertException	If any conversion error occurs.
IOException	If any I/O error occurs.

Definition at line 181 of file Convert.java.

References org.openoffice.xmerge.ConvertData.addDocument(), org.openoffice.xmerge.DocumentDeserializerFactory.createDocumentDeserializer(), org.openoffice.xmerge.DocumentSerializerFactory.createDocumentSerializer(), org.openoffice.xmerge.DocumentDeserializer.deserialize(), org.openoffice.xmerge.util.registry.ConverterInfo.getDocDeserializerFactory(), org.openoffice.xmerge.util.registry.ConverterInfo.getDocSerializerFactory(), org.openoffice.xmerge.ConvertData.getDocumentEnumeration(), and org.openoffice.xmerge.DocumentSerializer.serialize().

Referenced by org.openoffice.xmerge.util.ActiveSyncDriver.Convert(), XMergeBridge._XMergeBridge.convert(), and org.openoffice.xmerge.test.Driver.doConversion().

DocumentMerger org.openoffice.xmerge.Convert.getDocumentMerger ( Document  origDoc ) throws IOException

inline

Returns a.

DocumentMerger 

for the given

Document 

.

Parameters

origDoc

The Document were later changes will be merged to.

Returns

The

DocumentMerger 

object for the given document.

Exceptions

IOException

If any I/O error occurs.

Definition at line 131 of file Convert.java.

References org.openoffice.xmerge.DocumentMergerFactory.createDocumentMerger(), and org.openoffice.xmerge.util.registry.ConverterInfo.getDocMergerFactory().

Referenced by org.openoffice.xmerge.test.Driver.doConversion().

Document org.openoffice.xmerge.Convert.getOfficeDocument ( String  name, InputStream  is  ) throws IOException

inline

Returns the appropriate "Office".

Document 

object for this plug-in.

Parameters

name	The name of the Document to create.
is	The InputStream corresponding to the Document to create.

Returns

The appropriate "Office"

Document 

object for this plug-in.

Exceptions

IOException

If any I/O error occurs.

Definition at line 229 of file Convert.java.

References org.openoffice.xmerge.PluginFactory.createOfficeDocument(), org.openoffice.xmerge.util.registry.ConverterInfo.getPluginFactory(), and name.

Referenced by org.openoffice.xmerge.test.Driver.doConversion().

void org.openoffice.xmerge.Convert.reset ( )

inlineprivate

Resets the input queue, so that the user can use this class to perform another conversion.

This causes the

addInputStream 

method to accept input for the next conversion.

Definition at line 144 of file Convert.java.

References org.openoffice.xmerge.ConvertData.reset().

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

Member Data Documentation

final ConverterInfo org.openoffice.xmerge.Convert.ci

private

ConvertInfo that corresponds to the from-mime/to-mime conversion.

Definition at line 41 of file Convert.java.

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

final ConvertData org.openoffice.xmerge.Convert.inputCD = new ConvertData()

private

Holds the convert input data.

Definition at line 50 of file Convert.java.

final boolean org.openoffice.xmerge.Convert.toOffice

private

true 

if converting to the Office format,

false 

if converting to the device format.

Definition at line 47 of file Convert.java.

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

---

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

• Convert.java