org.datacleaner.restclient.ComponentController Maven / Gradle / Ivy

Go to download
/**
 * DataCleaner (community edition)
 * Copyright (C) 2014 Neopost - Customer Information Management
 *
 * This copyrighted material is made available to anyone wishing to use, modify,
 * copy, or redistribute it subject to the terms and conditions of the GNU
 * Lesser General Public License, as published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
 * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License
 * for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this distribution; if not, write to:
 * Free Software Foundation, Inc.
 * 51 Franklin Street, Fifth Floor
 * Boston, MA  02110-1301  USA
 */
package org.datacleaner.restclient;


/**
 * Controller for DataCleaner components (transformers and analyzers). It enables to use a particular component
 * and provide the input data separately without any need of the whole job or datastore dcConfiguration.
 * @since 24. 07. 2015
 */
public interface ComponentController {
    /**
     * It returns a list of all components and their configurations (with/without icon data).
     * @param tenant
     * @param iconData
     * @return
     */
    public ComponentList getAllComponents(final String tenant, final boolean iconData);

    /**
     * It returns a component's configuration (with/without icon data).
     * @param tenant
     * @param name
     * @param iconData
     * @return
     */
    public ComponentList.ComponentInfo getComponentInfo(final String tenant, final String name, final boolean iconData);

    public OutputColumns getOutputColumns(String tenant, String name, CreateInput createInput);

    /**
     * It creates a new component with the provided configuration, runs it and returns the result.
     * @param tenant
     * @param name
     * @param processStatelessInput
     * @return
     */
    public ProcessStatelessOutput processStateless(final String tenant, final String name,
        final ProcessStatelessInput processStatelessInput);

    /**
     * It runs the component and returns the results.
     *
     * @param tenant
     * @param name
     * @param timeout
     * @param config
     * @return
     */
    public String createComponent(final String tenant, final String name, final String timeout,
        final CreateInput config);

    /**
     * It returns the continuous result of the component for the provided input data.
     * @param tenant
     * @param id
     * @param processInput
     * @return
     */
    public ProcessOutput processComponent(final String tenant, final String id, final ProcessInput processInput);

    /**
     * It returns the component's final result.
     * @param tenant
     * @param id
     * @return
     */
    public ProcessResult getFinalResult(final String tenant, final String id);

    /**
     * It deletes the component.
     * @param tenant
     * @param id
     */
    public void deleteComponent(final String tenant, final String id);
}