Class ExportFilterBase

  • All Implemented Interfaces:
    com.sun.star.lang.XServiceInfo, com.sun.star.lang.XServiceName, com.sun.star.lang.XTypeProvider, com.sun.star.uno.XInterface, com.sun.star.xml.sax.XDocumentHandler, com.sun.star.xml.XExportFilter
    Direct Known Subclasses:
    W2LExportFilter, W2XExportFilter

    public abstract class ExportFilterBase
    extends java.lang.Object
    implements com.sun.star.xml.XExportFilter, com.sun.star.lang.XServiceName, com.sun.star.lang.XServiceInfo, com.sun.star.xml.sax.XDocumentHandler, com.sun.star.lang.XTypeProvider
    This class provides an abstract uno component which implements an XExportFilter. The filter is actually generic and only then constructor and 3 strings needs to changed by the subclass.
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String __displayName
      Filter name to include in error messages
      static java.lang.String __implementationName
      Implementation name for the component
      static java.lang.String __serviceName
      Service name for the component
      protected static com.sun.star.lang.XMultiServiceFactory xMSF  
      • Fields inherited from interface com.sun.star.xml.sax.XDocumentHandler

        UNOTYPEINFO
      • Fields inherited from interface com.sun.star.xml.XExportFilter

        UNOTYPEINFO
      • Fields inherited from interface com.sun.star.lang.XServiceInfo

        UNOTYPEINFO
      • Fields inherited from interface com.sun.star.lang.XServiceName

        UNOTYPEINFO
      • Fields inherited from interface com.sun.star.lang.XTypeProvider

        UNOTYPEINFO
    • Constructor Summary

      Constructors 
      Constructor Description
      ExportFilterBase​(com.sun.star.uno.XComponentContext xComponentContext1)
      We need to get the Service Manager from the Component context to instantiate certain services, hence this constructor.
    • Field Detail

      • __serviceName

        public static final java.lang.String __serviceName
        Service name for the component
        See Also:
        Constant Field Values
      • __implementationName

        public static final java.lang.String __implementationName
        Implementation name for the component
        See Also:
        Constant Field Values
      • __displayName

        public static final java.lang.String __displayName
        Filter name to include in error messages
        See Also:
        Constant Field Values
      • xMSF

        protected static com.sun.star.lang.XMultiServiceFactory xMSF
    • Constructor Detail

      • ExportFilterBase

        public ExportFilterBase​(com.sun.star.uno.XComponentContext xComponentContext1)
        We need to get the Service Manager from the Component context to instantiate certain services, hence this constructor. The subclass must override this to set xMSF properly from the reigstration class
    • Method Detail

      • replace

        public java.lang.String replace​(java.lang.String origString,
                                        java.lang.String origChar,
                                        java.lang.String replaceChar)
      • needsMask

        public java.lang.String needsMask​(java.lang.String origString)
      • exporter

        public boolean exporter​(com.sun.star.beans.PropertyValue[] aSourceData,
                                java.lang.String[] msUserData)
                         throws com.sun.star.uno.RuntimeException
        Specified by:
        exporter in interface com.sun.star.xml.XExportFilter
        Throws:
        com.sun.star.uno.RuntimeException
      • startDocument

        public void startDocument()
        Specified by:
        startDocument in interface com.sun.star.xml.sax.XDocumentHandler
      • endDocument

        public void endDocument()
                         throws com.sun.star.uno.RuntimeException
        Specified by:
        endDocument in interface com.sun.star.xml.sax.XDocumentHandler
        Throws:
        com.sun.star.uno.RuntimeException
      • startElement

        public void startElement​(java.lang.String str,
                                 com.sun.star.xml.sax.XAttributeList xattribs)
        Specified by:
        startElement in interface com.sun.star.xml.sax.XDocumentHandler
      • endElement

        public void endElement​(java.lang.String str)
        Specified by:
        endElement in interface com.sun.star.xml.sax.XDocumentHandler
      • characters

        public void characters​(java.lang.String str)
        Specified by:
        characters in interface com.sun.star.xml.sax.XDocumentHandler
      • ignorableWhitespace

        public void ignorableWhitespace​(java.lang.String str)
        Specified by:
        ignorableWhitespace in interface com.sun.star.xml.sax.XDocumentHandler
      • processingInstruction

        public void processingInstruction​(java.lang.String aTarget,
                                          java.lang.String aData)
        Specified by:
        processingInstruction in interface com.sun.star.xml.sax.XDocumentHandler
      • setDocumentLocator

        public void setDocumentLocator​(com.sun.star.xml.sax.XLocator xLocator)
        Specified by:
        setDocumentLocator in interface com.sun.star.xml.sax.XDocumentHandler
      • convert

        public void convert​(com.sun.star.io.XInputStream xml,
                            com.sun.star.io.XOutputStream exportStream)
                     throws com.sun.star.uno.RuntimeException,
                            java.io.IOException
        Throws:
        com.sun.star.uno.RuntimeException
        java.io.IOException
      • getTypes

        public com.sun.star.uno.Type[] getTypes()
        Specified by:
        getTypes in interface com.sun.star.lang.XTypeProvider
      • getImplementationId

        public byte[] getImplementationId()
        Specified by:
        getImplementationId in interface com.sun.star.lang.XTypeProvider
      • getServiceName

        public java.lang.String getServiceName()
        Specified by:
        getServiceName in interface com.sun.star.lang.XServiceName
      • supportsService

        public boolean supportsService​(java.lang.String stringServiceName)
        Specified by:
        supportsService in interface com.sun.star.lang.XServiceInfo
      • getImplementationName

        public java.lang.String getImplementationName()
        Specified by:
        getImplementationName in interface com.sun.star.lang.XServiceInfo
      • getSupportedServiceNames

        public java.lang.String[] getSupportedServiceNames()
        Specified by:
        getSupportedServiceNames in interface com.sun.star.lang.XServiceInfo