Package org.processmining.log.csvimport.handler

Interface CSVConversionHandler<R>

  • Type Parameters:
    R -
    All Known Implementing Classes:
    XESConversionHandlerImpl
    public interface CSVConversionHandler<R>
    Handler for the conversion following a visitor-like pattern.
    Author:
    F. Mannhardt

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void endAttribute()
      Called after the attribute has been parsed
      void endEvent()
      Called when the full row (including all attributes) have been parsed.
      void endTrace​(java.lang.String caseId)
      Called after a traces has been fully parsed.
      void errorDetected​(int lineNumber, int columnIndex, java.lang.String attributeName, java.lang.Object cellContent, java.lang.Exception e)
      Detected an error in the conversion.
      java.lang.String getConversionErrors()  
      R getResult()  
      boolean hasConversionErrors()  
      void startAttribute​(java.lang.String name, boolean value)
      Called when a boolean attribute is parsed
      void startAttribute​(java.lang.String name, double value)
      Called when a double attribute is parsed
      void startAttribute​(java.lang.String name, long value)
      Called when a long attribute is parsed
      void startAttribute​(java.lang.String name, java.lang.String value)
      Called when a string attribute is parsed
      void startAttribute​(java.lang.String name, java.util.Date value)
      Called when a date attribute is parsed
      void startEvent​(java.lang.String eventClass, java.util.Date completionTime, java.util.Date startTime)
      Called when parsing a row, thereby creating an event.
      void startLog​(CSVFile inputFile)
      Called upon start parsing the CSVFile.
      void startTrace​(java.lang.String caseId)
      Called when a new trace is encountered.

    • Method Detail

      • startLog

        void startLog​(CSVFile inputFile)
        Called upon start parsing the CSVFile.
        Parameters:
        inputFile -

      • startTrace

        void startTrace​(java.lang.String caseId)
        Called when a new trace is encountered. Traces are assumed to be sorted by caseId, therefore, this is only called once per trace.
        Parameters:
        caseId -

      • endTrace

        void endTrace​(java.lang.String caseId)
        Called after a traces has been fully parsed.
        Parameters:
        caseId -

      • startEvent

        void startEvent​(java.lang.String eventClass,
                java.util.Date completionTime,
                java.util.Date startTime)
        Called when parsing a row, thereby creating an event.
        Parameters:
        eventClass - the name (class) of the event
        completionTime - the completion time possibly NULL
        startTime - the start time possibly NULL

      • startAttribute

        void startAttribute​(java.lang.String name,
                    java.lang.String value)
        Called when a string attribute is parsed
        Parameters:
        name -
        value -

      • startAttribute

        void startAttribute​(java.lang.String name,
                    long value)
        Called when a long attribute is parsed
        Parameters:
        name -
        value -

      • startAttribute

        void startAttribute​(java.lang.String name,
                    double value)
        Called when a double attribute is parsed
        Parameters:
        name -
        value -

      • startAttribute

        void startAttribute​(java.lang.String name,
                    java.util.Date value)
        Called when a date attribute is parsed
        Parameters:
        name -
        value -

      • startAttribute

        void startAttribute​(java.lang.String name,
                    boolean value)
        Called when a boolean attribute is parsed
        Parameters:
        name -
        value -

      • endAttribute

        void endAttribute()
        Called after the attribute has been parsed

      • endEvent

        void endEvent()
        Called when the full row (including all attributes) have been parsed.

      • errorDetected

        void errorDetected​(int lineNumber,
                   int columnIndex,
                   java.lang.String attributeName,
                   java.lang.Object cellContent,
                   java.lang.Exception e)
            throws CSVConversionException
        Detected an error in the conversion.
        Parameters:
        lineNumber -
        columnIndex -
        attributeName -
        cellContent -
        e -
        Throws:
        CSVConversionException

      • getResult

        R getResult()
        Returns:
        the result of the parse

      • hasConversionErrors

        boolean hasConversionErrors()
        Returns:
        whether any errors have been encountered during the conversion

      • getConversionErrors

        java.lang.String getConversionErrors()
        Returns:
        a descriptive String of the error