LibreOffice Module xmerge (master)  1
Public Member Functions | Static Public Member Functions | Private Attributes | Static Private Attributes | List of all members
org.openoffice.xmerge.util.registry.ConverterInfo Class Reference

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

Collaboration diagram for org.openoffice.xmerge.util.registry.ConverterInfo:
[legend]

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. More...
 
DocumentDeserializerFactory getDocDeserializerFactory ()
 Returns an instance of the. 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. 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. More...
 
boolean canSerialize ()
 Returns. More...
 
boolean canDeserialize ()
 Returns. More...
 
boolean canMerge ()
 Returns. More...
 
String getXsltSerial ()
 Returns a. More...
 
String getXsltDeserial ()
 Returns a. More...
 

Static Public Member Functions

static boolean isValidOfficeType (String officeMime)
 Returns. 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

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
jarNameThe URL of the jarfile.
officeMimeThe office mime-type.
deviceMimeThe device mime-type.
displayNameThe display name.
descriptionThe description.
versionThe version.
vendorThe vendor name.
implThe implementation class name of
PluginFactory
.
xsltSerialThe URL of the serializer XSL stylesheet
xsltDeserialThe URL of the deserializer XSL stylesheet
Exceptions
RegistryExceptionIf
ci
cannot be loaded.

Definition at line 80 of file ConverterInfo.java.

References equals(), Exception, getClass(), i, org.openoffice.xmerge.util.registry.ConverterInfo.isValidOfficeType(), loader, Object, run(), and URL.

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
jarNameThe URL of the jarfile.
officeMimeThe office mime-type.
deviceMimeThe device mime-type.
displayNameThe display name.
descriptionThe description.
versionThe version.
vendorThe vendor name.
implThe implementation class name of
PluginFactory
.
Exceptions
RegistryExceptionIf
ci
cannot be loaded.

Definition at line 158 of file ConverterInfo.java.

References equals(), Exception, getClass(), i, org.openoffice.xmerge.util.registry.ConverterInfo.isValidOfficeType(), loader, Object, run(), and URL.

Member Function Documentation

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().

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().

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().

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().

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().

Iterator<String> org.openoffice.xmerge.util.registry.ConverterInfo.getDeviceMime ( )
inline
String org.openoffice.xmerge.util.registry.ConverterInfo.getDisplayName ( )
inline
DocumentDeserializerFactory org.openoffice.xmerge.util.registry.ConverterInfo.getDocDeserializerFactory ( )
inline

Returns an instance of the.

DocumentSerializerFactory

interface.

Returns
instance of the
DocumentSerializer
for this .

Definition at line 239 of file ConverterInfo.java.

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

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

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

Returns an instance of the DocumentMergerFactory interface.

Returns
instance of the
DocumentMergerFactory
for this .

Definition at line 249 of file ConverterInfo.java.

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

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

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

Returns an instance of the.

DocumentDeserializerFactory

interface.

Returns
instance of the
DocumentDeserializer
for this .

Definition at line 229 of file ConverterInfo.java.

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

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

String org.openoffice.xmerge.util.registry.ConverterInfo.getJarName ( )
inline
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().

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().

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().

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().

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

Returns a.

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

Returns
.

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().

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

Returns a.

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

Returns
.

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().

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.

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

boolean org.openoffice.xmerge.util.registry.ConverterInfo.piCanDeserialize = false
private
boolean org.openoffice.xmerge.util.registry.ConverterInfo.piCanMerge = false
private
boolean org.openoffice.xmerge.util.registry.ConverterInfo.piCanSerialize = false
private
final String org.openoffice.xmerge.util.registry.ConverterInfo.piClassImpl
private
final ClassLoader org.openoffice.xmerge.util.registry.ConverterInfo.piClassLoader
private

Definition at line 59 of file ConverterInfo.java.

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

Definition at line 48 of file ConverterInfo.java.

final String org.openoffice.xmerge.util.registry.ConverterInfo.piDisplayName
private
final String org.openoffice.xmerge.util.registry.ConverterInfo.piJarName
private
final String org.openoffice.xmerge.util.registry.ConverterInfo.piOfficeMime
private
PluginFactory org.openoffice.xmerge.util.registry.ConverterInfo.piPluginFactory
private
final String org.openoffice.xmerge.util.registry.ConverterInfo.piVendor
private
final String org.openoffice.xmerge.util.registry.ConverterInfo.piVersion
private
String org.openoffice.xmerge.util.registry.ConverterInfo.piXsltDeserial
private
String org.openoffice.xmerge.util.registry.ConverterInfo.piXsltSerial
private
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.


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