Writing the Filtering Component

OpenOffice.org Developer's Guide

Office Development

< Previous Section

Next Section >

• OpenOffice.org Application Environment

• Desktop Environment
• Framework API

• Frame-Controller-Model Paradigm in OpenOffice.org
• Frames
• Controllers
• Windows
• Dispatch Framework

• Using the Desktop
• Using the Component Framework

• Getting Frames, Controllers and Models from Each Other
• Frames
• Controllers
• Models
• Window Interfaces

• Creating Frames Manually
• Handling Documents

• Closing Documents
• Storing Documents

• Using the Dispatch Framework

• Command URL
• Processing Chain
• Dispatch Process
• Dispatch Results
• Dispatch Interception

• Java Window Integration

• Common Application Features

• Internationalization

• Overview and Using the API
• Implementing a New Locale

• Linguistics

• Using Spellchecker
• Using Hyphenator
• Using Thesaurus
• Events
• Implementing a Spell Checker
• Implementing a Hyphenator
• Implementing a Thesaurus

• Integrating Import and Export Filters

• Filtering Process
• Filters
• Type Detection and its Configuration
• Properties of a Type
• Properties of a Filter
• Filter Options
• Properties of a FrameLoader
• Document API Filter Development

• XML Based Filter Development

• Writing the Filtering Component
• The Importer
• The Exporter
• XML Filter Detection

• Number Formats

• Managing Number Formats
• Applying Number Formats

• Document Events
• Path Organization

• Path Settings
• Path Variables

• Predefined Variables
• Custom Path Variables
• Resolving Path Variables

• OpenOffice.org Single Sign-On API
• RDF metadata

< Previous Page

Next Page >

The filtering component must implement the following interfaces as described by the com.sun.star.xml.ImportFilter service and the com.sun.star.xml.ExportFilter service:

Importer:

com.sun.star.xml.XMLImportFilter

Exporter:

com.sun.star.xml.XMLExportFilter and com.sun.star.xml.sax.XDocumentHandler

XImportFilter

The service com.sun.star.xml.XMLImportFilter defines an interface with the following method:

  boolean importer(
  [in] sequence< com::sun::star::beans::PropertyValue > aSourceData,
  [in] com::sun::star::xml::sax::XDocumentHandler xDocHandler,
  [in] sequence< string > msUserData )

aSourceData is a MediaDescriptor, which can be used to obtain the following information:

• An XInputStream

This is a stream that is attached to the source to be read. This can be a file, or some other data source.

• Filename

This is the name of the file on the disk, that the input stream comes from.

• Url

This is an URL describing the location being read.

xDocHandler is a SAX event handler that can be used when parsing an XInputStream, which may or may not contain Apache OpenOffice XML. Before this stream can be read by Apache OpenOffice, it will need to be transformed into Apache OpenOffice XML.

msUserData is an array of Strings, that contains the information supplied in the UserData section of the Filter definition in the TypeDetection.xcu file.

XExportFilter

The com.sun.star.xml.XExportFilter defines an interface with the following method:

  boolean exporter( 
  [in] sequence< com::sun::star::beans::PropertyValue > aSourceData,
  [in] sequence< string > msUserData )

aSourceData and msUserData contain the same type of information as in the importer, except that the MediaDescriptor contains an XOutputStream, which can be used to write to.

XDocumentHandler

When the export takes place, the new Filtering component must also be an XDocumentHandler, to allow the output based on SAX events to be filtered, if required. For this reason, an XDocumentHandler is not passed to the exporter, and any exporter that is used by the XML filter adaptor must implement the com.sun.star.xml.sax.XDocumentHandler interface.

In order for Java based components to operate effectively, a set of wrapper classes have been added to the javaunohelper package. These files allow for an XInputStream or an XOutputStream to be accessed using the same methods as a normal Java InputStream or OutputStream. These classes are located in the javaunohelper package at com.sun.star.lib.uno.adapter.XInputStreamToInputStreamAdapter com.sun.star.lib.uno.adapter.XOutputStreamToOutputStreamAdapter For more information on the use of these helper classes, see the flatxmljava example.

Content on this page is licensed under the Public Documentation License (PDL).