Class for storing the information about a converter plug-in. More...

Collaboration diagram for org.openoffice.xmerge.util.registry.ConverterInfo:

Public Member Functions
	ConverterInfo (String jarName, String officeMime, ArrayList< String > deviceMime, String displayName, String description, String version, String vendor, String impl, String xsltSerial, String xsltDeserial) throws RegistryException
	The constructor builds a ConverterInfo structure. More...

	ConverterInfo (String jarName, String officeMime, ArrayList< String > deviceMime, String displayName, String description, String version, String vendor, String impl) throws RegistryException
	The constructor builds a ConverterInfo structure. More...

DocumentSerializerFactory	getDocSerializerFactory ()
	Returns an instance of the `DocumentDeserializerFactory` interface. More...

DocumentDeserializerFactory	getDocDeserializerFactory ()
	Returns an instance of the `DocumentSerializerFactory` interface. More...

DocumentMergerFactory	getDocMergerFactory ()
	Returns an instance of the DocumentMergerFactory interface. More...

String	getJarName ()
	Returns the jar file name. More...

String	getOfficeMime ()
	Returns the office mime-type. More...

Iterator< String >	getDeviceMime ()
	Returns an `Enumeration` of `String` objects indicating the device mime-type. More...

String	getDisplayName ()
	Returns the display name. More...

String	getDescription ()
	Returns the description. More...

String	getVersion ()
	Returns the version. More...

String	getVendor ()
	Returns the vendor name. More...

String	getClassImpl ()
	Returns the implementation class name of PluginFactory. More...

PluginFactory	getPluginFactory ()
	Returns the `PluginFactory` instance for this plug-in. More...

boolean	canSerialize ()
	Returns `true` if this plug-in has a serializer, `false` otherwise. More...

boolean	canDeserialize ()
	Returns `true` if this plug-in has a deserializer, `false` otherwise. More...

boolean	canMerge ()
	Returns `true` if this plug-in has a merger, `false` otherwise. More...

String	getXsltSerial ()
	Returns a `String` containing the Xslt stylesheet URL that is to be used by the Xslt Plug-in Serializer. More...

String	getXsltDeserial ()
	Returns a `String` containing the xslt stylesheet URL that is to be used by the Xslt Plug-in Deserializer. More...

Static Public Member Functions
static boolean	isValidOfficeType (String officeMime)
	Returns `true` if the officeMime is a valid Office mime type. More...

Private Attributes
final String	piJarName

final String	piOfficeMime

final ArrayList< String >	piDeviceMime

final String	piDisplayName

final String	piDescription

final String	piVersion

final String	piVendor

final String	piClassImpl

String	piXsltSerial

String	piXsltDeserial

boolean	piCanSerialize = false

boolean	piCanDeserialize = false

boolean	piCanMerge = false

final ClassLoader	piClassLoader

PluginFactory	piPluginFactory

Static Private Attributes
static final String[]	validOfficeTypes
	Keep track of the valid Office mime types. More...

Detailed Description

Class for storing the information about a converter plug-in.

Definition at line 37 of file ConverterInfo.java.

Constructor & Destructor Documentation

◆ ConverterInfo() [1/2]

org.openoffice.xmerge.util.registry.ConverterInfo.ConverterInfo	(	String	jarName,
		String	officeMime,
		ArrayList< String >	deviceMime,
		String	displayName,
		String	description,
		String	version,
		String	vendor,
		String	impl,
		String	xsltSerial,
		String	xsltDeserial
	)		throws RegistryException

inline

The constructor builds a ConverterInfo structure.

Parameters

jarName	The URL of the jarfile.
officeMime	The office mime-type.
deviceMime	The device mime-type.
displayName	The display name.
description	The description.
version	The version.
vendor	The vendor name.
impl	The implementation class name of `PluginFactory`.
xsltSerial	The URL of the serializer XSL stylesheet
xsltDeserial	The URL of the deserializer XSL stylesheet

Exceptions

RegistryException If ci cannot be loaded.

Definition at line 80 of file ConverterInfo.java.

◆ ConverterInfo() [2/2]

org.openoffice.xmerge.util.registry.ConverterInfo.ConverterInfo	(	String	jarName,
		String	officeMime,
		ArrayList< String >	deviceMime,
		String	displayName,
		String	description,
		String	version,
		String	vendor,
		String	impl
	)		throws RegistryException

inline

The constructor builds a ConverterInfo structure.

Parameters

jarName	The URL of the jarfile.
officeMime	The office mime-type.
deviceMime	The device mime-type.
displayName	The display name.
description	The description.
version	The version.
vendor	The vendor name.
impl	The implementation class name of `PluginFactory`.

Exceptions

RegistryException If ci cannot be loaded.

Definition at line 158 of file ConverterInfo.java.

Member Function Documentation

◆ canDeserialize()

boolean org.openoffice.xmerge.util.registry.ConverterInfo.canDeserialize ( )

inline

Returns true if this plug-in has a deserializer, false otherwise.

Returns: true if this plug-in has a deserializer, false otherwise.

Definition at line 355 of file ConverterInfo.java.

References org.openoffice.xmerge.util.registry.ConverterInfo.piCanDeserialize.

Referenced by org.openoffice.xmerge.util.registry.ConverterInfoMgr.main().

◆ canMerge()

boolean org.openoffice.xmerge.util.registry.ConverterInfo.canMerge ( )

inline

Returns true if this plug-in has a merger, false otherwise.

Returns: true if this plug-in has a merger, false otherwise.

Definition at line 366 of file ConverterInfo.java.

References org.openoffice.xmerge.util.registry.ConverterInfo.piCanMerge.

Referenced by org.openoffice.xmerge.util.registry.ConverterInfoMgr.main().

◆ canSerialize()

boolean org.openoffice.xmerge.util.registry.ConverterInfo.canSerialize ( )

inline

Returns true if this plug-in has a serializer, false otherwise.

Returns: true if this plug-in has a serializer, false otherwise.

Definition at line 344 of file ConverterInfo.java.

References org.openoffice.xmerge.util.registry.ConverterInfo.piCanSerialize.

Referenced by org.openoffice.xmerge.util.registry.ConverterInfoMgr.main().

◆ getClassImpl()

String org.openoffice.xmerge.util.registry.ConverterInfo.getClassImpl ( )

inline

Returns the implementation class name of PluginFactory.

Returns: The implementation class name of PluginFactory, null if none exists.

Definition at line 324 of file ConverterInfo.java.

References org.openoffice.xmerge.util.registry.ConverterInfo.piClassImpl, and String.

Referenced by org.openoffice.xmerge.util.registry.ConverterInfoMgr.main().

◆ getDescription()

String org.openoffice.xmerge.util.registry.ConverterInfo.getDescription ( )

inline

Returns the description.

Returns: The description, null if none exists.

Definition at line 296 of file ConverterInfo.java.

References org.openoffice.xmerge.util.registry.ConverterInfo.piDescription, and String.

Referenced by org.openoffice.xmerge.util.registry.ConverterInfoMgr.main().

◆ getDeviceMime()

Iterator< String > org.openoffice.xmerge.util.registry.ConverterInfo.getDeviceMime ( )

inline

Returns an Enumeration of String objects indicating the device mime-type.

Returns: An Enumeration of String objects indicating the device mime-type.

Definition at line 278 of file ConverterInfo.java.

References org.openoffice.xmerge.util.registry.ConverterInfo.piDeviceMime.

Referenced by org.openoffice.xmerge.util.registry.ConverterInfoMgr.findConverterInfoChain(), org.openoffice.xmerge.converter.xml.xslt.PluginFactoryImpl.getDeviceFileExtension(), and org.openoffice.xmerge.util.registry.ConverterInfoMgr.main().

◆ getDisplayName()

String org.openoffice.xmerge.util.registry.ConverterInfo.getDisplayName ( )

inline

Returns the display name.

Returns: The display name, null if none exists.

Definition at line 287 of file ConverterInfo.java.

References org.openoffice.xmerge.util.registry.ConverterInfo.piDisplayName, and String.

Referenced by org.openoffice.xmerge.util.registry.ConverterInfoMgr.main(), and org.openoffice.xmerge.util.registry.ConverterInfoMgr.removeByName().

◆ getDocDeserializerFactory()

DocumentDeserializerFactory org.openoffice.xmerge.util.registry.ConverterInfo.getDocDeserializerFactory ( )

inline

Returns an instance of the DocumentSerializerFactory interface.

Returns: instance of the DocumentSerializer for this ConverterInfo.

Definition at line 239 of file ConverterInfo.java.

References org.openoffice.xmerge.util.registry.ConverterInfo.piPluginFactory.

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

◆ getDocMergerFactory()

DocumentMergerFactory org.openoffice.xmerge.util.registry.ConverterInfo.getDocMergerFactory ( )

inline

Returns an instance of the DocumentMergerFactory interface.

Returns: instance of the DocumentMergerFactory for this ConverterInfo.

Definition at line 249 of file ConverterInfo.java.

References org.openoffice.xmerge.util.registry.ConverterInfo.piPluginFactory.

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

◆ getDocSerializerFactory()

DocumentSerializerFactory org.openoffice.xmerge.util.registry.ConverterInfo.getDocSerializerFactory ( )

inline

Returns an instance of the DocumentDeserializerFactory interface.

Returns: instance of the DocumentDeserializer for this ConverterInfo.

Definition at line 229 of file ConverterInfo.java.

References org.openoffice.xmerge.util.registry.ConverterInfo.piPluginFactory.

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

◆ getJarName()

String org.openoffice.xmerge.util.registry.ConverterInfo.getJarName ( )

inline

Returns the jar file name.

Returns: The jar file name, null if none exists.

Definition at line 258 of file ConverterInfo.java.

References org.openoffice.xmerge.util.registry.ConverterInfo.piJarName, and String.

Referenced by org.openoffice.xmerge.util.registry.ConverterInfoMgr.main(), org.openoffice.xmerge.util.registry.ConverterInfoMgr.removeByJar(), org.openoffice.xmerge.converter.xml.xslt.DocumentDeserializerImpl.resolve(), org.openoffice.xmerge.converter.xml.xslt.DocumentSerializerImpl.resolve(), org.openoffice.xmerge.converter.xml.xslt.DocumentSerializerImpl.transform(), and org.openoffice.xmerge.converter.xml.xslt.DocumentDeserializerImpl.transform().

◆ getOfficeMime()

String org.openoffice.xmerge.util.registry.ConverterInfo.getOfficeMime ( )

inline

Returns the office mime-type.

Returns: The office mime-type, null if none exists.

Definition at line 267 of file ConverterInfo.java.

References org.openoffice.xmerge.util.registry.ConverterInfo.piOfficeMime, and String.

Referenced by org.openoffice.xmerge.util.registry.ConverterInfoMgr.findConverterInfoChain(), and org.openoffice.xmerge.util.registry.ConverterInfoMgr.main().

◆ getPluginFactory()

PluginFactory org.openoffice.xmerge.util.registry.ConverterInfo.getPluginFactory ( )

inline

Returns the PluginFactory instance for this plug-in.

Returns: The PluginFactory instance for this plug-in.

Definition at line 333 of file ConverterInfo.java.

References org.openoffice.xmerge.util.registry.ConverterInfo.piPluginFactory.

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

◆ getVendor()

String org.openoffice.xmerge.util.registry.ConverterInfo.getVendor ( )

inline

Returns the vendor name.

Returns: The vendor name, null if none exists.

Definition at line 314 of file ConverterInfo.java.

References org.openoffice.xmerge.util.registry.ConverterInfo.piVendor, and String.

Referenced by org.openoffice.xmerge.util.registry.ConverterInfoMgr.main().

◆ getVersion()

String org.openoffice.xmerge.util.registry.ConverterInfo.getVersion ( )

inline

Returns the version.

Returns: The version, null if none exists.

Definition at line 305 of file ConverterInfo.java.

References org.openoffice.xmerge.util.registry.ConverterInfo.piVersion, and String.

Referenced by org.openoffice.xmerge.util.registry.ConverterInfoMgr.main().

◆ getXsltDeserial()

String org.openoffice.xmerge.util.registry.ConverterInfo.getXsltDeserial ( )

inline

Returns a String containing the xslt stylesheet URL that is to be used by the Xslt Plug-in Deserializer.

Returns: String.

Definition at line 403 of file ConverterInfo.java.

References org.openoffice.xmerge.util.registry.ConverterInfo.piXsltDeserial, and String.

Referenced by org.openoffice.xmerge.util.registry.ConverterInfoMgr.main(), and org.openoffice.xmerge.converter.xml.xslt.DocumentDeserializerImpl.transform().

◆ getXsltSerial()

String org.openoffice.xmerge.util.registry.ConverterInfo.getXsltSerial ( )

inline

Returns a String containing the Xslt stylesheet URL that is to be used by the Xslt Plug-in Serializer.

Returns: String.

Definition at line 393 of file ConverterInfo.java.

References org.openoffice.xmerge.util.registry.ConverterInfo.piXsltSerial, and String.

Referenced by org.openoffice.xmerge.util.registry.ConverterInfoMgr.main(), and org.openoffice.xmerge.converter.xml.xslt.DocumentSerializerImpl.transform().

◆ isValidOfficeType()

static boolean org.openoffice.xmerge.util.registry.ConverterInfo.isValidOfficeType ( String officeMime )

inlinestatic

Returns true if the officeMime is a valid Office mime type.

Returns: true if the officeMime is a valid Office mime type.

Definition at line 375 of file ConverterInfo.java.

References String, and org.openoffice.xmerge.util.registry.ConverterInfo.validOfficeTypes.

Referenced by org.openoffice.xmerge.util.registry.ConverterInfo.ConverterInfo(), org.openoffice.xmerge.util.registry.ConverterInfoMgr.findConverterInfo(), and org.openoffice.xmerge.ConverterFactory.getConverter().

Member Data Documentation

◆ piCanDeserialize

boolean org.openoffice.xmerge.util.registry.ConverterInfo.piCanDeserialize = false

private

Definition at line 57 of file ConverterInfo.java.

Referenced by org.openoffice.xmerge.util.registry.ConverterInfo.canDeserialize(), and org.openoffice.xmerge.util.registry.ConverterInfo.ConverterInfo().

◆ piCanMerge

boolean org.openoffice.xmerge.util.registry.ConverterInfo.piCanMerge = false

private

Definition at line 58 of file ConverterInfo.java.

Referenced by org.openoffice.xmerge.util.registry.ConverterInfo.canMerge(), and org.openoffice.xmerge.util.registry.ConverterInfo.ConverterInfo().

◆ piCanSerialize

boolean org.openoffice.xmerge.util.registry.ConverterInfo.piCanSerialize = false

private

Definition at line 56 of file ConverterInfo.java.

Referenced by org.openoffice.xmerge.util.registry.ConverterInfo.canSerialize(), and org.openoffice.xmerge.util.registry.ConverterInfo.ConverterInfo().

◆ piClassImpl

final String org.openoffice.xmerge.util.registry.ConverterInfo.piClassImpl

private

Definition at line 53 of file ConverterInfo.java.

Referenced by org.openoffice.xmerge.util.registry.ConverterInfo.ConverterInfo(), and org.openoffice.xmerge.util.registry.ConverterInfo.getClassImpl().

◆ piClassLoader

final ClassLoader org.openoffice.xmerge.util.registry.ConverterInfo.piClassLoader

private

Definition at line 59 of file ConverterInfo.java.

Referenced by org.openoffice.xmerge.util.registry.ConverterInfo.ConverterInfo().

◆ piDescription

final String org.openoffice.xmerge.util.registry.ConverterInfo.piDescription

private

Definition at line 50 of file ConverterInfo.java.

Referenced by org.openoffice.xmerge.util.registry.ConverterInfo.ConverterInfo(), and org.openoffice.xmerge.util.registry.ConverterInfo.getDescription().

◆ piDeviceMime

final ArrayList<String> org.openoffice.xmerge.util.registry.ConverterInfo.piDeviceMime

private

Definition at line 48 of file ConverterInfo.java.

Referenced by org.openoffice.xmerge.util.registry.ConverterInfo.ConverterInfo(), and org.openoffice.xmerge.util.registry.ConverterInfo.getDeviceMime().

◆ piDisplayName

final String org.openoffice.xmerge.util.registry.ConverterInfo.piDisplayName

private

Definition at line 49 of file ConverterInfo.java.

Referenced by org.openoffice.xmerge.util.registry.ConverterInfo.ConverterInfo(), and org.openoffice.xmerge.util.registry.ConverterInfo.getDisplayName().

◆ piJarName

final String org.openoffice.xmerge.util.registry.ConverterInfo.piJarName

private

Definition at line 46 of file ConverterInfo.java.

Referenced by org.openoffice.xmerge.util.registry.ConverterInfo.ConverterInfo(), and org.openoffice.xmerge.util.registry.ConverterInfo.getJarName().

◆ piOfficeMime

final String org.openoffice.xmerge.util.registry.ConverterInfo.piOfficeMime

private

Definition at line 47 of file ConverterInfo.java.

Referenced by org.openoffice.xmerge.util.registry.ConverterInfo.ConverterInfo(), and org.openoffice.xmerge.util.registry.ConverterInfo.getOfficeMime().

◆ piPluginFactory

PluginFactory org.openoffice.xmerge.util.registry.ConverterInfo.piPluginFactory

private

Definition at line 60 of file ConverterInfo.java.

Referenced by org.openoffice.xmerge.util.registry.ConverterInfo.ConverterInfo(), org.openoffice.xmerge.util.registry.ConverterInfo.getDocDeserializerFactory(), org.openoffice.xmerge.util.registry.ConverterInfo.getDocMergerFactory(), org.openoffice.xmerge.util.registry.ConverterInfo.getDocSerializerFactory(), and org.openoffice.xmerge.util.registry.ConverterInfo.getPluginFactory().

◆ piVendor

final String org.openoffice.xmerge.util.registry.ConverterInfo.piVendor

private

Definition at line 52 of file ConverterInfo.java.

Referenced by org.openoffice.xmerge.util.registry.ConverterInfo.ConverterInfo(), and org.openoffice.xmerge.util.registry.ConverterInfo.getVendor().

◆ piVersion

final String org.openoffice.xmerge.util.registry.ConverterInfo.piVersion

private

Definition at line 51 of file ConverterInfo.java.

Referenced by org.openoffice.xmerge.util.registry.ConverterInfo.ConverterInfo(), and org.openoffice.xmerge.util.registry.ConverterInfo.getVersion().

◆ piXsltDeserial

String org.openoffice.xmerge.util.registry.ConverterInfo.piXsltDeserial

private

Definition at line 55 of file ConverterInfo.java.

Referenced by org.openoffice.xmerge.util.registry.ConverterInfo.ConverterInfo(), and org.openoffice.xmerge.util.registry.ConverterInfo.getXsltDeserial().

◆ piXsltSerial

String org.openoffice.xmerge.util.registry.ConverterInfo.piXsltSerial

private

Definition at line 54 of file ConverterInfo.java.

Referenced by org.openoffice.xmerge.util.registry.ConverterInfo.ConverterInfo(), and org.openoffice.xmerge.util.registry.ConverterInfo.getXsltSerial().

◆ validOfficeTypes

final String [] org.openoffice.xmerge.util.registry.ConverterInfo.validOfficeTypes

staticprivate

Initial value:

= new String[] {
        
        "staroffice/sxw",
        "staroffice/sxc"
    }

Keep track of the valid Office mime types.

Definition at line 40 of file ConverterInfo.java.

Referenced by org.openoffice.xmerge.util.registry.ConverterInfo.isValidOfficeType().

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

ConverterInfo.java

Public Member Functions

Static Public Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ConverterInfo() [1/2]

◆ ConverterInfo() [2/2]

Member Function Documentation

◆ canDeserialize()

◆ canMerge()

◆ canSerialize()

◆ getClassImpl()

◆ getDescription()

◆ getDeviceMime()

◆ getDisplayName()

◆ getDocDeserializerFactory()

◆ getDocMergerFactory()

◆ getDocSerializerFactory()

◆ getJarName()

◆ getOfficeMime()

◆ getPluginFactory()

◆ getVendor()

◆ getVersion()

◆ getXsltDeserial()

◆ getXsltSerial()

◆ isValidOfficeType()

Member Data Documentation

◆ piCanDeserialize

◆ piCanMerge

◆ piCanSerialize

◆ piClassImpl

◆ piClassLoader

◆ piDescription

◆ piDeviceMime

◆ piDisplayName

◆ piJarName

◆ piOfficeMime

◆ piPluginFactory

◆ piVendor

◆ piVersion

◆ piXsltDeserial

◆ piXsltSerial

◆ validOfficeTypes