org.openoffice.xmerge.Document Interface Reference

A Document represents any Document to be converted and the resulting Document from any conversion. More...

Inheritance diagram for org.openoffice.xmerge.Document:

Public Member Functions
void	write (OutputStream os) throws IOException
	Writes out the Document content to the specified OutputStream. More...
void	read (InputStream is) throws IOException
	Reads the content from the InputStream into the Document. More...
String	getName ()
	Returns the Document name with no file extension. More...
String	getFileName ()
	Returns the Document name with file extension. More...

Detailed Description

A Document represents any Document to be converted and the resulting Document from any conversion.

It is created by the PluginFactory object's createOfficeDocument method or the createDeviceDocument method.

See also

org.openoffice.xmerge.PluginFactory

Definition at line 36 of file Document.java.

Member Function Documentation

getFileName()

String org.openoffice.xmerge.Document.getFileName

(

)

Returns the Document name with file extension.

Returns

The Document name with file extension.

Implemented in org.openoffice.xmerge.converter.dom.DOMDocument, and org.openoffice.xmerge.converter.palm.PalmDocument.

References String.

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

getName()

String org.openoffice.xmerge.Document.getName

(

)

Returns the Document name with no file extension.

Returns

The Document name with no file extension.

Implemented in org.openoffice.xmerge.converter.dom.DOMDocument, and org.openoffice.xmerge.converter.palm.PalmDocument.

References String.

read()

void org.openoffice.xmerge.Document.read

(

InputStream

is

)

throws IOException

Reads the content from the InputStream into the Document.

This method may not be thread-safe. Implementations may or may not synchronize this method. User code (i.e. caller) must make sure that calls to this method are thread-safe.

Parameters

is	InputStream to read in the Document content.

Exceptions

IOException

If any I/O error occurs.

Implemented in org.openoffice.xmerge.converter.dom.DOMDocument, and org.openoffice.xmerge.converter.palm.PalmDocument.

write()

void org.openoffice.xmerge.Document.write

(

OutputStream

os

)

throws IOException

Writes out the Document content to the specified OutputStream.

This method may not be thread-safe. Implementations may or may not synchronize this method. User code (i.e. caller) must make sure that calls to this method are thread-safe.

Parameters

os	OutputStream to write out the Document content.

Exceptions

IOException

If any I/O error occurs.

Implemented in org.openoffice.xmerge.converter.dom.DOMDocument, and org.openoffice.xmerge.converter.palm.PalmDocument.

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

---

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

• Document.java