fiftyone.pipeline.engines.data.AspectEngineDataFile Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of pipeline.engines Show documentation
Shared base functionality for implementing engines for the 51Degrees Pipeline API
There is a newer version: 4.4.61
/* *********************************************************************
 * 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.engines.data;

import fiftyone.pipeline.engines.configuration.DataFileConfiguration;
import fiftyone.pipeline.engines.flowelements.OnPremiseAspectEngine;
import fiftyone.pipeline.engines.services.DataUpdateService;

import java.io.Closeable;
import java.util.Date;

/**
 * Interface for the details of a data file used by an Aspect engine.
 * These properties are used by the {@link DataUpdateService} to perform
 * automatic updates if enabled.
 */
public interface AspectEngineDataFile extends Closeable {
    /**
     * Get an identifier for this data file. Each data file used by an engine
     * must have a different identifier.
     * @return data file identifier
     */
    String getIdentifier();

    /**
     * Set an identifier for this data file. Each data file used by an engine
     * must have a different identifier.
     * @param identifier data file identifier
     */
    void setIdentifier(String identifier);

    /**
     * Get the engine this data file is used by.
     * @return engine the data file is used by
     */
    OnPremiseAspectEngine getEngine();
    /**
     * Set the engine this data file is used by.
     * @param engine the data file is used by
     */
    void setEngine(OnPremiseAspectEngine engine);

    /**
     * The complete file path to the location of the data file.
     * This value will be null if the file has been supplied from
     * a byte[] in memory.
     * @return file path or null
     */
    String getDataFilePath();

    /**
     * Get the complete file path to the location of the temporary
     * copy of the data file that is currently being used by the
     * AspectEngine.
     * Engines often make a temporary copy of the data file in order
     * to allow the original to be updated.
     * This value will be null if the file is loaded entirely into memory.
     * @return temp data file path or null
     */
    String getTempDataFilePath();

    /**
     * Set the complete file path to the location of the temporary
     * copy of the data file that is currently being used by the
     * AspectEngine.
     * Engines often make a temporary copy of the data file in order
     * to allow the original to be updated.
     * This value will be null if the file is loaded entirely into memory.
     * @param file temp data file path
     */
    void setTempDataFilePath(String file);

    /**
     * Get the path to use when working with temporary files associated with
     * this data file.
     * @return path to create temporary files in
     */
    String getTempDataDirPath();

    /**
     * Set the path to use when working with temporary files associated with
     * this data file.
     * @param path the to create temporary files in
     */
    void setTempDataDirPath(String path);

    /**
     * True if automatic updates are enabled, false otherwise.
     * @return true if automatic updates are enabled, false otherwise
     */
    boolean getAutomaticUpdatesEnabled();

    /**
     * Get the date and time by which an update to the current data file is
     * expected to have been published.
     * @return the data of the next data file
     */
    Date getUpdateAvailableTime();

    /**
     * Set the date and time by which an update to the current data file is
     * expected to have been published.
     * @param availableTime the date of the next data file
     */
    void setUpdateAvailableTime(Date availableTime);

    /**
     * Set the date and time that the current data file was published.
     * @return date the file was published
     */
    Date getDataPublishedDateTime();

    /**
     * Set the date and time that the current data file was published.
     * @param published date the file was published
     */
    void setDataPublishedDateTime(Date published);

    /**
     * Get the configuration that was provided for this data file.
     * @return configuration for this file
     */
    DataFileConfiguration getConfiguration();

    /**
     * Set the configuration that was provided for this data file.
     * @param configuration for this file
     */
    void setConfiguration(DataFileConfiguration configuration);

    /**
     * Returns true if this file has been registered with the data update
     * service. False if not.
     * @return true if the file has been registered for updates
     */
    boolean getIsRegistered();

    /**
     * Get the data update URL complete with any query string
     * parameters that are needed to retrieve the data.
     * By default, no query string parameters are added to the URL.
     * @return formatted URL for getting a new data file
     */
    String getFormattedUrl();

    /**
     * Set the data update service that this data file is registered with.
     * @param dataUpdateService The data update service.
     */
    void setDataUpdateService(DataUpdateService dataUpdateService);
}