Package org.deckfour.xes.out

Class XesXmlSerializer

  • All Implemented Interfaces:
    XSerializer
    Direct Known Subclasses:
    XesXmlGZIPSerializer
    public class XesXmlSerializer
extends java.lang.Object
implements XSerializer
    XES plain XML serialization for the XES format.
    Author:
    Christian W. Guenther (christian@deckfour.org)

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected void addAttributes​(org.deckfour.spex.SXTag tag, java.util.Collection<XAttribute> attributes)
      Helper method, adds the given collection of attributes to the given Tag.
      protected void addGlobalAttributes​(org.deckfour.spex.SXTag parent, java.lang.String scope, java.util.List<XAttribute> attributes)
      Helper method for defining global attributes on a given scope.
      java.lang.String getAuthor()
      Returns the name of this serialization's author.
      java.lang.String getDescription()
      Returns a brief description of this serialization.
      java.lang.String getName()
      Returns the human-readable name of this serialization.
      java.lang.String[] getSuffices()
      Returns an array of possible file suffices for this serialization.
      void serialize​(XLog log, java.io.OutputStream out)
      Serializes a given log to the given output stream.
      java.lang.String toString()
      toString() defaults to getName().

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    • Constructor Detail

      • XesXmlSerializer

        public XesXmlSerializer()

    • Method Detail

      • getDescription

        public java.lang.String getDescription()
        Description copied from interface: XSerializer
        Returns a brief description of this serialization.
        Specified by:
        getDescription in interface XSerializer

      • getName

        public java.lang.String getName()
        Description copied from interface: XSerializer
        Returns the human-readable name of this serialization.
        Specified by:
        getName in interface XSerializer

      • getAuthor

        public java.lang.String getAuthor()
        Description copied from interface: XSerializer
        Returns the name of this serialization's author.
        Specified by:
        getAuthor in interface XSerializer

      • getSuffices

        public java.lang.String[] getSuffices()
        Description copied from interface: XSerializer
        Returns an array of possible file suffices for this serialization.
        Specified by:
        getSuffices in interface XSerializer

      • serialize

        public void serialize​(XLog log,
                      java.io.OutputStream out)
               throws java.io.IOException
        Description copied from interface: XSerializer
        Serializes a given log to the given output stream.
        Specified by:
        serialize in interface XSerializer
        Parameters:
        log - Log to be serialized.
        out - OutputStream for serialization.
        Throws:
        java.io.IOException

      • addGlobalAttributes

        protected void addGlobalAttributes​(org.deckfour.spex.SXTag parent,
                                   java.lang.String scope,
                                   java.util.List<XAttribute> attributes)
                            throws java.io.IOException
        Helper method for defining global attributes on a given scope.
        Throws:
        java.io.IOException

      • addAttributes

        protected void addAttributes​(org.deckfour.spex.SXTag tag,
                             java.util.Collection<XAttribute> attributes)
                      throws java.io.IOException
        Helper method, adds the given collection of attributes to the given Tag.
        Parameters:
        tag - Tag to add attributes to.
        attributes - The attributes to add.
        Throws:
        java.io.IOException

      • toString

        public java.lang.String toString()
        toString() defaults to getName().
        Overrides:
        toString in class java.lang.Object