net.sf.okapi.steps.common.AbstractCompoundStep Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of okapi-lib Show documentation
There is a newer version: 1.47.0
/*===========================================================================
  Copyright (C) 2008-2010 by the Okapi Framework contributors
-----------------------------------------------------------------------------
  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 net.sf.okapi.steps.common;

import net.sf.okapi.common.Event;
import net.sf.okapi.common.EventType;
import net.sf.okapi.common.exceptions.OkapiException;
import net.sf.okapi.common.pipeline.BasePipelineStep;
import net.sf.okapi.common.pipeline.IPipelineStep;
import net.sf.okapi.common.pipeline.annotations.ConfigurationParameter;
import net.sf.okapi.common.pipeline.annotations.StepIntrospector;
import net.sf.okapi.common.pipeline.annotations.StepParameterMapping;
import net.sf.okapi.common.pipeline.annotations.StepParameterType;
import net.sf.okapi.common.pipelinebuilder.XPipelineStep;
import net.sf.okapi.common.resource.MultiEvent;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Method;
import java.net.URI;
import java.util.LinkedList;
import java.util.List;

public abstract class AbstractCompoundStep extends BasePipelineStep {

    protected LinkedList steps = new LinkedList<>();
    private final LinkedList> paramList;
    private final Logger logger = LoggerFactory.getLogger(getClass());

    protected abstract void addStepsToList(List list);

    public AbstractCompoundStep() {
        super();
        paramList = new LinkedList<>();
        addStepsToList(steps);
        for (IPipelineStep step : steps) {
            if (step == null) {
                logger.error("Attempt to add null for an internal step.");
                continue;
            }

            step.setTargetLocale(getTargetLocale());
            step.setSourceLocale(getSourceLocale());

            List pList = null;
            if (step instanceof XPipelineStep) {
                pList = StepIntrospector.getStepParameters(((XPipelineStep)step).getStep());
            } else {
                pList = StepIntrospector.getStepParameters(step);
            }
            paramList.add(pList);
        }
    }

    private Event expandEvent(Event event, IPipelineStep currentStep) {
        if (event.getEventType() == EventType.MULTI_EVENT
                && !(((MultiEvent) event.getResource()).isPropagateAsSingleEvent())) {

            // add the remaining steps to a temp list - these are the steps that will receive the expanded
            // MULT_EVENTS
            List remainingSteps = steps.subList(steps.indexOf(currentStep) + 1,
                    steps.size());
            if (remainingSteps.size() == 0) {
                return event;
            }

            for (Event e : ((MultiEvent)event.getResource())) {
                // send the current event from MULTI_EVENT down the remaining steps in the pipeline
                for (IPipelineStep remainingStep : remainingSteps) {
                    e = remainingStep.handleEvent(e);
                    e = expandEvent(e, remainingStep);
                }
            }
        }

        return event;
    }

    @Override
    public Event handleEvent(Event event) {
        for (IPipelineStep step : steps) {
            event = super.handleEvent(event);
            step.setTargetLocale(getTargetLocale());
            step.setSourceLocale(getSourceLocale());
            event = step.handleEvent(event);
            // Recursively expand the event if needed
            event = expandEvent(event, step);
        }
        return event;
    }

    private void invokeParameterMethods(StepParameterType type, Object value) {
        for ( List pList : paramList ) {
            // For each exposed parameter
            for ( ConfigurationParameter p : pList ) {
                Method method = p.getMethod();
                if ( method == null ) {
                    continue;
                }
                if ( p.getParameterType() == type) {
                    try {
                        method.invoke(p.getStep(), value);
                    }
                    catch ( IllegalArgumentException | InvocationTargetException | IllegalAccessException e ) {
                        throw new OkapiException("Error when assigning runtime parameters.", e);
                    }
                }
            }
        }
    }

    @StepParameterMapping(parameterType = StepParameterType.OUTPUT_ENCODING)
    public void setOutputEncoding (String outputEncoding) {
        invokeParameterMethods(StepParameterType.OUTPUT_ENCODING, outputEncoding);
    }

    @StepParameterMapping(parameterType = StepParameterType.INPUT_URI)
    public void setInputUri (URI inputURI) {
        invokeParameterMethods(StepParameterType.INPUT_URI, inputURI);
    }

    @StepParameterMapping(parameterType = StepParameterType.OUTPUT_URI)
    public void setOutputUri (URI outputURI) {
        invokeParameterMethods(StepParameterType.OUTPUT_URI, outputURI);
    }
}