org.kie.api.runtime.process.DataTransformer Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of kogito-api

The Kogito public API which is backwards compatible between releases.

There is a newer version: 10.0.0

/*
 * Copyright 2013 Red Hat, Inc. and/or its affiliates.
 *
 * 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 org.kie.api.runtime.process;

import java.util.Map;

/**
 * Data transformation capabilities used by data input and data output transformation
 * as part of BPMN2 process definition. It allows plugable implementations.
 *
 */
public interface DataTransformer {

    /**
     * Compiles given expression into reusable unit. This is optional operation and in case
     * it's not supported by given transformed it should return the same expression that was
     * given in the input. If compilation is supported a compiled instance of the expression
     * should be returned.
     * @param expression language specific expression
     * @param parameters parameters e.g. imports defined in the process
     * @return compiled expression instance or same as given as argument expression
     * @throws RuntimeException in case of unexpected errors during compilation
     */
    public Object compile(String expression, Map parameters);

    /**
     * Transforms the given expression object (might be compiled expression) using
     * parameters as contextual information (aka bindings) used during
     * evaluation of the expression.
     * @param expression expression to evaluate
     * @param parameters binding parameters
     * @return result of the evaluation
     * @throws RuntimeException in case of unexpected errors during evaluation of the expression
     */
    public Object transform(Object expression, Map parameters);

}