EDMWorker

Owned by Former user (Deleted)
Feb 25, 2019
3 min read


edm.edom3

Interface EDMWorker


  • All Superinterfaces:EDMContextDependent

    All Known Subinterfaces:EDMCheckin, EDMCheckout, EDMCompiler, EDMDownload, EDMMerger, EDMQuery, EDMSelectInstances, EDMUpload, EDMValidator, EDMWebService


    public interface EDMWorker
extends EDMContextDependent

    This interface defines an EDMoperation. Copyright(C) EPM Technology AS.

    Version:2.12Author:Arne Toen - EPM Technology AS.

    • Method Detail

      • setOptions

        void setOptions(long options)

        Set bit options

        Parameters:options - bit options to set

      • getOptions

        long getOptions()

        Get options.

        Returns:bit options

      • resetOptions

        void resetOptions()

        Reset options.

      • getSource

        EDMData getSource()
           throws EdmiException

        Retrieve the source description for this worker

        Returns:source data descriptorThrows:EdmiException - if the method fails

      • setSource

        void setSource(EDMData source)
        throws EdmiException

        Set the source description for this worker

        Parameters:source - data sourceThrows:EdmiException - if the method fails

      • getTarget

        EDMData getTarget()
           throws EdmiException

        Retrieve the target descriptor for this worker

        Returns:target data descriptorThrows:EdmiException - if the method fails

      • setTarget

        void setTarget(EDMData target)
        throws EdmiException

        Set the target description for this worker

        Parameters:target - data targetThrows:EdmiException - if the method fails

      • getResult

        EDMWorkerResult getResult()
                   throws EdmiException

        Get the result for this worker

        Returns:null if worker not completedThrows:EdmiException - if the method fails

      • getLogDescription

        EDMLogDescription getLogDescription()

        Get the logDescription for this worker. The LogDescription defines how and where system and user defined output should be written. Typical examples are compiler diagnostic files and EDMvalidator user output files.

        Returns:logDescription for this worker

      • setSystemOutput

        void setSystemOutput(java.io.File f)

        Deprecated. use getLogDescription().setLogFileName() instead.
        Set system output file

        Parameters:f - File

      • setSystemOutput

        void setSystemOutput(java.lang.String name)

        Deprecated. use getLogDescription().setLogFileName() instead.
        Set system output filename

        Parameters:name - Name

      • setUserOutput

        void setUserOutput(java.io.File f)

        Deprecated. use getLogDescription().setUserOutputFileName() instead.
        Set user output file

        Parameters:f - File

      • setUserOutput

        void setUserOutput(java.lang.String name)

        Deprecated. use getLogDescription().setUserOutputFileName() instead.
        Set user output filename

        Parameters:name - Name

      • setParameters

        void setParameters(EDMSelect[] parameters)

        Assign worker parameters. If the worker does not require any parameters the assignment has no effect. Workers accepting parameters are in general query, merge/convert, check-out, check-in and validator

        Parameters:parameters - Parameters used when executing the worker.

      • getParameters

        EDMSelect[] getParameters()

        Retrieve worker parameters

        Returns:array of worker parameters, null if none set.

      • setFileMappings

        void setFileMappings(EDMFileMapping[] mappings)

        Assign worker file mappings. If the worker does not require any mappings the assignment has no effect. Workers accepting parameters are in general query, merge/convert, check-out, check-in and validator

        Parameters:mappings - File mappings used when executing the worker.

      • getFileMappings

        EDMFileMapping[] getFileMappings()

        Retrieve worker file mappings

        Returns:array of worker file mappings, null if none set.

      • getFormalParameters

        EDMFormalParameter[] getFormalParameters()
                                  throws EdmiException

        Gets a list of EDMFormalParameter for this Worker if possible. If the worker does not accept parameters, or if it cannot be retrieved null is returned.

        Returns:array of EDMFormalParameter objects.Throws:EdmiException - if the method fails

      • execute

        void execute()
      throws EdmiException

        Execute operation specified source and target

        Throws:EdmiException - If the method fails.

      • getConfiguration

        EDMRow getConfiguration()

        Get current configuration assigned to this worker.

        Returns:current configuration id, null = none

      • setConfiguration

        void setConfiguration(EDMRow s)

        Set configuration for this worker. Configurations are common in XML export.

        Parameters:s - configurationSee Also:EDMDataFactory.getXmlConfiguration(edm.edom3.EDMExpressSchema, java.lang.String), EDMDataFactory.listXmlConfigurations(edm.edom3.EDMExpressSchema, java.lang.String)

      • getIndexOut

        int getIndexOut()

      • getHitsOut

        int getHitsOut()