Package org.deckfour.xes.info

Interface XLogInfo

  • All Known Implementing Classes:
    XLogInfoImpl
    public interface XLogInfo
    This interface defines a bare-bones log summary.
    Author:
    Christian W. Guenther (christian@deckfour.org)

    • Method Detail

      • getLog

        XLog getLog()
        Retrieves the log used for this summary.
        Returns:
        The event log which this summary describes.

      • getNumberOfEvents

        int getNumberOfEvents()
        Retrieves the total number of events in this log.
        Returns:
        Total number of events.

      • getNumberOfTraces

        int getNumberOfTraces()
        Retrieves the number of traces in this log.
        Returns:
        Number of traces available in this log.

      • getEventClassifiers

        java.util.Collection<XEventClassifier> getEventClassifiers()
        Retrieves the set of event classifiers covered by this log info, i.e., for which event classes are registered in this log info instance.
        Returns:
        The collection of event classifiers covered by this log info instance.

      • getEventClasses

        XEventClasses getEventClasses​(XEventClassifier classifier)
        Retrieves the event classes for a given classifier.

        Note:The given event classifier must be covered by this log info, i.e., the log info must have been created with this classifier. Otherwise, this method will return null. You can retrieve the collection of event classifiers covered by this log info instance by calling the method getEventClassifiers().

        Parameters:
        classifier - The classifier for which to retrieve the event classes.
        Returns:
        The requested event classes, or null if the given event classifier is not covered by this log info instance.

      • getEventClasses

        XEventClasses getEventClasses()
        Retrieves the event classes of the summarized log, as defined by the event classifier used for this summary.
        Returns:
        The event classes of the summarized log.

      • getResourceClasses

        XEventClasses getResourceClasses()
        Retrieves the resource classes of the summarized log.
        Returns:
        The resource classes of the summarized log.

      • getNameClasses

        XEventClasses getNameClasses()
        Retrieves the event name classes of the summarized log.
        Returns:
        The event name classes of the summarized log.

      • getTransitionClasses

        XEventClasses getTransitionClasses()
        Retrieves the lifecycle transition classes of the summarized log.
        Returns:
        The lifecycle transition classes of the summarized log.

      • getLogTimeBoundaries

        XTimeBounds getLogTimeBoundaries()
        Retrieves the global timestamp boundaries of this log.
        Returns:
        Timestamp boundaries for the complete log.

      • getTraceTimeBoundaries

        XTimeBounds getTraceTimeBoundaries​(XTrace trace)
        Retrieves the timestamp boundaries for a specified trace.
        Parameters:
        trace - Trace to be queried for.
        Returns:
        Timestamp boundaries for the indicated trace.

      • getLogAttributeInfo

        XAttributeInfo getLogAttributeInfo()
        Retrieves attribute information about all attributes this log contains on the log level.
        Returns:
        Attribute information on the log level.

      • getTraceAttributeInfo

        XAttributeInfo getTraceAttributeInfo()
        Retrieves attribute information about all attributes this log contains on the trace level.
        Returns:
        Attribute information on the trace level.

      • getEventAttributeInfo

        XAttributeInfo getEventAttributeInfo()
        Retrieves attribute information about all attributes this log contains on the event level.
        Returns:
        Attribute information on the event level.

      • getMetaAttributeInfo

        XAttributeInfo getMetaAttributeInfo()
        Retrieves attribute information about all attributes this log contains on the meta (i.e., attribute) level.
        Returns:
        Attribute information on the meta level.

      • toString

        java.lang.String toString()
        Returns a string representation of this summary.
        Overrides:
        toString in class java.lang.Object