Package com.ibm.di.api.local.impl

Class SequenceImpl

  • All Implemented Interfaces:
    Sequence
    public class SequenceImpl
extends java.lang.Object
implements Sequence

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      ConfigInstance getConfigInstance()
      Returns the configuration instance of the Sequence.
      java.lang.String getName()
      Returns the name of the Sequence.
      Entry getResult()
      This method returns the result entry object.
      TaskStatistics getStatistics()
      This method returns the TaskStatistics object for this Sequence.
      int getUniqueCode()
      Returns the unique code of the AssemblyLine.
      boolean isActive()
      Checks if the Sequence is active.
      void stop()
      Stops the execution of the Sequence.
      void stop​(boolean sync)
      Stops the execution of the Sequence, and waits for it to stop.

      • Methods inherited from class java.lang.Object

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

    • Method Detail

      • getConfigInstance

        public ConfigInstance getConfigInstance()
                                 throws DIException
        Description copied from interface: Sequence
        Returns the configuration instance of the Sequence.
        Specified by:
        getConfigInstance in interface Sequence
        Returns:
        Returns ConfigInstance object
        Throws:
        DIException - if an error occurs while retrieving the configuration instance information.

      • getName

        public java.lang.String getName()
                         throws DIException
        Description copied from interface: Sequence
        Returns the name of the Sequence.
        Specified by:
        getName in interface Sequence
        Returns:
        String object representing the Sequence's name.
        Throws:
        DIException - if an error occurs while retrieving the name

      • getResult

        public Entry getResult()
                throws DIException
        Description copied from interface: Sequence
        This method returns the result entry object. This object is a copy of the working entry.
        Specified by:
        getResult in interface Sequence
        Returns:
        The last "work" entry object.
        Throws:
        DIException - if an error occurs while getting the result Entry.

      • getStatistics

        public TaskStatistics getStatistics()
                             throws DIException
        Description copied from interface: Sequence
        This method returns the TaskStatistics object for this Sequence.
        Specified by:
        getStatistics in interface Sequence
        Returns:
        The accumulated TaskStatistics object.
        Throws:
        DIException - if an error occurs while getting the Sequence statistics.

      • getUniqueCode

        public int getUniqueCode()
                  throws DIException
        Description copied from interface: Sequence
        Returns the unique code of the AssemblyLine.
        Specified by:
        getUniqueCode in interface Sequence
        Returns:
        int value representing the unique code of the Sequence.
        Throws:
        DIException - if an error occurs while retrieving the unique code.

      • isActive

        public boolean isActive()
                 throws DIException
        Description copied from interface: Sequence
        Checks if the Sequence is active.
        Specified by:
        isActive in interface Sequence
        Returns:
        true if the Sequence thread is alive, false otherwise.
        Throws:
        DIException - if an error occurs while getting the state.

      • stop

        public void stop()
          throws DIException
        Description copied from interface: Sequence
        Stops the execution of the Sequence.
        Specified by:
        stop in interface Sequence
        Throws:
        DIException - if an error occurs while stopping the AssemblyLine.

      • stop

        public void stop​(boolean sync)
          throws DIException
        Description copied from interface: Sequence
        Stops the execution of the Sequence, and waits for it to stop.
        Specified by:
        stop in interface Sequence
        Parameters:
        sync - If true, create a new Thread to do the waiting.
        Throws:
        DIException - if an error occurs while stopping the Sequence.