fiftyone.pipeline.core.flowelements.PipelineBuilderFromConfiguration Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of pipeline.core Show documentation

There is a newer version: 4.5.0-alpha.1

/* *********************************************************************
 * This Original Work is copyright of 51 Degrees Mobile Experts Limited.
 * Copyright 2023 51 Degrees Mobile Experts Limited, Davidson House,
 * Forbury Square, Reading, Berkshire, United Kingdom RG1 3EU.
 *
 * This Original Work is licensed under the European Union Public Licence
 * (EUPL) v.1.2 and is subject to its terms as set out below.
 *
 * If a copy of the EUPL was not distributed with this file, You can obtain
 * one at https://opensource.org/licenses/EUPL-1.2.
 *
 * The 'Compatible Licences' set out in the Appendix to the EUPL (as may be
 * amended by the European Commission) shall be deemed incompatible for
 * the purposes of the Work and the provisions of the compatibility
 * clause in Article 5 of the EUPL shall not apply.
 *
 * If using the Work as, or as part of, a network application, by
 * including the attribution notice(s) required under Article 5 of the EUPL
 * in the end user terms of the application under an appropriate heading,
 * such notice(s) shall fulfill the requirements of that article.
 * ********************************************************************* */

package fiftyone.pipeline.core.flowelements;

import fiftyone.pipeline.core.configuration.PipelineOptions;

/**
 * Pipeline builders implementing this interface are capable of building a
 * {@link Pipeline} based on a supplied {@link PipelineOptions} instance.
 * @see Specification
 */
public interface PipelineBuilderFromConfiguration {

    /**
     * Build the pipeline using the specified configuration options.
     * @param options a {@link PipelineOptions} instance describing how to build
     *                the pipeline
     * @return a new {@link Pipeline} instance containing the configured
     * {@link FlowElement} instances
     * @throws Exception if the configuration could not be used to build a valid
     * {@link Pipeline}
     */
    Pipeline buildFromConfiguration(PipelineOptions options) throws Exception;
}