javax.batch.api.partition.PartitionMapper Maven / Gradle / Ivy

/*
 * Copyright 2012 International Business Machines Corp.
 * 
 * See the NOTICE file distributed with this work for additional information
 * regarding copyright ownership. Licensed under the Apache License, 
 * Version 2.0 (the "License"); you may not use this file except in compliance
 * with the License. You may obtain a copy of the License at
 * 
 *   http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package javax.batch.api.partition;

import javax.batch.api.partition.PartitionPlan;

/**
 * PartitionMapper receives control at the start of a partitioned execution. A
 * PartitionMapper is responsible to provide unique batch properties for each
 * partition.
 * 
 */
public interface PartitionMapper {
	/**
	 * The mapPartitions method that receives control at the start of
	 * partitioned step processing. The method returns a PartitionPlan, which
	 * specifies the batch properties for each partition.
	 * 
	 * @return partition plan for a partitioned step.
	 * @throws Exception
	 *             is thrown if an error occurs.
	 */
	public PartitionPlan mapPartitions() throws Exception;
}