StoreDelayGreaterThanThresholdInContextProcessor.java

/*
 * The MIT License (MIT)
 *
 * Copyright (c) 2015 Almex
 *
 * Permission is hereby granted, free of charge, to any person obtaining a
 * copy of this software and associated documentation files (the "Software"),
 * to deal in the Software without restriction, including without limitation
 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
 * and/or sell copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
 * IN THE SOFTWARE.
 */

package be.raildelays.batch.processor;

import be.raildelays.batch.bean.BatchExcelRow;
import be.raildelays.delays.Delays;
import be.raildelays.domain.Sens;
import be.raildelays.logging.Logger;
import be.raildelays.logging.LoggerFactory;
import org.springframework.batch.core.StepExecution;
import org.springframework.batch.core.annotation.BeforeStep;
import org.springframework.batch.item.ExecutionContext;
import org.springframework.batch.item.ItemProcessor;
import org.springframework.beans.factory.InitializingBean;
import org.springframework.util.Assert;

import java.util.HashMap;
import java.util.Map;

/**
 * Filter delay greater than a certain threshold and store the {@link be.raildelays.batch.bean.BatchExcelRow}
 * in the <code>Step</code> {@link org.springframework.batch.item.ExecutionContext}.
 * <p>
 * You should configure keyName name in order to match key used when retrieving this
 * {@link be.raildelays.batch.bean.BatchExcelRow} like below:
 * </p>
 * <p>
 * <code>
 * Map<Sens, BatchExcelRow> excelRow = (Map) context.get(keyName);
 * </code>
 * </p>
 *
 * @author Almex
 * @since 1.2
 */
public class StoreDelayGreaterThanThresholdInContextProcessor implements ItemProcessor<BatchExcelRow, BatchExcelRow>, InitializingBean {

    private static final Logger LOGGER = LoggerFactory.getLogger("Fas", StoreDelayGreaterThanThresholdInContextProcessor.class);

    private Long threshold;

    private ExecutionContext context;

    private String keyName;

    @BeforeStep
    public void beforeStep(StepExecution stepExecution) {
        this.context = stepExecution.getExecutionContext();
    }

    @Override
    public void afterPropertiesSet() throws Exception {
        Assert.notNull(threshold, "The 'threshold' property must be provided");
        Assert.notNull(keyName, "The 'keyName' property must be provided");
    }

    @Override
    public BatchExcelRow process(final BatchExcelRow item) throws Exception {

        if (item.getDelay() < Delays.toMillis(threshold)) {
            LOGGER.debug("delay<" + threshold, item);
        } else {
            LOGGER.debug("delay>=" + threshold, item);

            storeInContext(item);
        }

        return item;
    }

    private void storeInContext(final BatchExcelRow item) {
        Map<Sens, BatchExcelRow> map = null;

        /*
         * We can only have two trains  the same day having more than one hour of delay (one per sens).
         */
        if (context.containsKey(keyName)) {
            map = (Map) context.get(keyName);
        } else {
            map = new HashMap<>(2);
            context.put(keyName, map);
        }

        map.put(item.getSens(), item);

        LOGGER.trace("store_in_context", item);
    }

    /**
     * @param threshold in number of minutes
     */
    public void setThreshold(Long threshold) {
        this.threshold = threshold;
    }

    public void setKeyName(String keyName) {
        this.keyName = keyName;
    }
}