Package javax.batch.api.partition

Class PartitionPlanImpl

  • All Implemented Interfaces:
    PartitionPlan

    public class PartitionPlanImpl
extends java.lang.Object
implements PartitionPlan
    The PartitionPlanImpl class provides a basic implementation of the PartitionPlan interface.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.util.Properties[] getPartitionProperties​()
      Gets array of Partition Properties objects for Partitions.
      int getPartitions​()
      Gets count of Partitions.
      boolean getPartitionsOverride​()
      Return current value of partition override setting.
      int getThreads​()
      Gets count of threads.
      void setPartitionProperties​(java.util.Properties[] props)
      Sets array of substitution Properties objects for the set of Partitions.
      void setPartitions​(int count)
      Set number of partitions.
      void setPartitionsOverride​(boolean override)
      Specify whether or not to override the partition count from the previous job execution.
      void setThreads​(int count)
      Set number of threads.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • PartitionPlanImpl

        public PartitionPlanImpl​()

    • Method Detail

      • setPartitions

        public void setPartitions​(int count)
        Description copied from interface: PartitionPlan
        Set number of partitions.
        Specified by:
        setPartitions in interface PartitionPlan
        Parameters:
        count - specifies the partition count

      • setThreads

        public void setThreads​(int count)
        Description copied from interface: PartitionPlan
        Set number of threads. Defaults to zero, which means thread count is equal to partition count.
        Specified by:
        setThreads in interface PartitionPlan
        Parameters:
        count - specifies the thread count

      • setPartitionsOverride

        public void setPartitionsOverride​(boolean override)
        Description copied from interface: PartitionPlan
        Specify whether or not to override the partition count from the previous job execution. This applies only to step restart. The default is false.

        When false is specified, the partition count from the previous job execution is used and any new value set for partition count in the current run is ignored. In addition, partition results from the previous job execution are remembered, and only incomplete partitions are reprocessed.

        When true is specified, the partition count from the current run is used and all results from past partitions are discarded. Any resource cleanup or back out of work done in the previous run is the responsibility of the application. The PartitionReducer artifact's rollbackPartitionedStep method is invoked during restart before any partitions begin processing to provide a cleanup hook.

        Specified by:
        setPartitionsOverride in interface PartitionPlan

      • getPartitionsOverride

        public boolean getPartitionsOverride​()
        Description copied from interface: PartitionPlan
        Return current value of partition override setting.
        Specified by:
        getPartitionsOverride in interface PartitionPlan
        Returns:
        override setting.

      • setPartitionProperties

        public void setPartitionProperties​(java.util.Properties[] props)
        Description copied from interface: PartitionPlan
        Sets array of substitution Properties objects for the set of Partitions.
        Specified by:
        setPartitionProperties in interface PartitionPlan
        Parameters:
        props - specifies the Properties object array

      • getPartitions

        public int getPartitions​()
        Description copied from interface: PartitionPlan
        Gets count of Partitions.
        Specified by:
        getPartitions in interface PartitionPlan
        Returns:
        Partition count

      • getThreads

        public int getThreads​()
        Description copied from interface: PartitionPlan
        Gets count of threads.
        Specified by:
        getThreads in interface PartitionPlan
        Returns:
        thread count

      • getPartitionProperties

        public java.util.Properties[] getPartitionProperties​()
        Description copied from interface: PartitionPlan
        Gets array of Partition Properties objects for Partitions.
        Specified by:
        getPartitionProperties in interface PartitionPlan
        Returns:
        Partition Properties object array