EDMLogDescription

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


edm.edom3

Interface EDMLogDescription


  • All Known Subinterfaces:EDMLogger


    public interface EDMLogDescription

    Log description are used in the some of the EDMWorker classes to define logging

    • Method Summary

      All Methods Instance Methods Abstract Methods 

      Modifier and TypeMethod and Description
      java.lang.StringgetDeclarationsToLog()
      Returns the current declarations to be logged.
      java.lang.StringgetLogFileName()
      Returns the name of the file, which the log stream are directed to.
      intgetMaxLogFileSize()
      Returns the max size of the log file.
      longgetOptions()
      Returns the current options.
      java.lang.StringgetSourceAreaToLog()
      Returns the current source area to be logged.
      java.lang.StringgetUserOutputFileName()
      Returns the name of the file, which the useroutput stream are directed to.
      voidsetDeclarationsToLog(java.lang.String qualifiedName)
      Sets declarations to be logged.
      voidsetLogFileName(java.lang.String name)
      Sets the name of the file, which the log stream should be directed to.
      voidsetMaxLogFileSize(int size, boolean ringFile)
      Sets the max size of the log file and enable/disable ring file, OBS:ringfile not possible for all log types.
      voidsetOptions(long options)
      Sets the current options.
      voidsetSourceAreaToLog(java.lang.String value)
      Sets the current source area to be logged.
      voidsetUserOutputFileName(java.lang.String name)
      Sets the name of the file, which the useroutput stream should be directed to.

    • Method Detail

      • getOptions

        long getOptions()

        Returns the current options.

        Returns:long the current options.

      • setOptions

        void setOptions(long options)

        Sets the current options.

        Parameters:options - Specifies the current options. The "options" value should be defined as a bitwise OR between the options to enable. Default options are enabled when the value of "options" is set to zero.

      • getUserOutputFileName

        java.lang.String getUserOutputFileName()

        Returns the name of the file, which the useroutput stream are directed to.

        Returns:String the file name.

      • setUserOutputFileName

        void setUserOutputFileName(java.lang.String name)

        Sets the name of the file, which the useroutput stream should be directed to.

        Parameters:name - the file name.

      • getMaxLogFileSize

        int getMaxLogFileSize()

        Returns the max size of the log file.

        Returns:Long the max file size.

      • setMaxLogFileSize

        void setMaxLogFileSize(int size,
                       boolean ringFile)

        Sets the max size of the log file and enable/disable ring file, OBS:ringfile not possible for all log types.

        Parameters:size - the max file size.ringFile - enable or disable trace to ring file. If true, The trace output file is a ring file, i.e. when the file size has reached the max size,the file will be rewound and the trace output will start from the beginning of the file. This is only relevant if max size is unequal zero. The header of the trace file will contain information about current write pointer, enabling the user to find the first and last line on the trace file.

      • getLogFileName

        java.lang.String getLogFileName()

        Returns the name of the file, which the log stream are directed to.

        Returns:String the file name.

      • setLogFileName

        void setLogFileName(java.lang.String name)

        Sets the name of the file, which the log stream should be directed to.

        Parameters:name - the file name.

      • getSourceAreaToLog

        java.lang.String getSourceAreaToLog()

        Returns the current source area to be logged.

        Returns:String the current source area to be logged.

      • setSourceAreaToLog

        void setSourceAreaToLog(java.lang.String value)

        Sets the current source area to be logged.

        Parameters:value - Specifies the Express-X/Express source line intervals that should be logged during the conversion process. A source line interval is specified either as the name of a declaration of type: map, compose, statements, function, procedure, where rule and rule, or by a single line number or by the first line number and the last line number separated by the hyphen '-' character. Any number of intervals can be specified, the intervals are separated by a comma. The order of the intervals is not significant.

      • getDeclarationsToLog

        java.lang.String getDeclarationsToLog()

        Returns the current declarations to be logged.

        Returns:String the current declarations to be logged.

      • setDeclarationsToLog

        void setDeclarationsToLog(java.lang.String qualifiedName)

        Sets declarations to be logged.

        Parameters:qualifiedName - Specifies the Express-X/Express declarations that should be executed when logging should be performed, I.e., the part of the source schema(s) defined in the "sourceAreaToLog" argument will only be logged when those parts are executed on behalf of the declarations specified in the "declarationsToLog" argument.