51Degrees Pipeline Java  4.1

51Degrees Pipeline for Java

fiftyone.pipeline.engines.data.AspectEngineDataFile Interface Reference

Detailed Description

Interface for the details of a data file used by an Aspect engine.

These properties are used by the DataUpdateService to perform automatic updates if enabled.

Inheritance diagram for fiftyone.pipeline.engines.data.AspectEngineDataFile:

[legend]

Collaboration diagram for fiftyone.pipeline.engines.data.AspectEngineDataFile:

[legend]

Public Member Functions

String  getIdentifier ()
Get an identifier for this data file. More...
void  setIdentifier (String identifier)
Set an identifier for this data file. More...
OnPremiseAspectEngine  getEngine ()
Get the engine this data file is used by. More...
void  setEngine (OnPremiseAspectEngine engine)
Set the engine this data file is used by. More...
String  getDataFilePath ()
The complete file path to the location of the data file. More...
String  getTempDataFilePath ()
Get the complete file path to the location of the temporary copy of the data file that is currently being used by the AspectEngine. More...
void  setTempDataFilePath (String file)
Set the complete file path to the location of the temporary copy of the data file that is currently being used by the AspectEngine. More...
String  getTempDataDirPath ()
Get the path to use when working with temporary files associated with this data file. More...
void  setTempDataDirPath (String path)
Set the path to use when working with temporary files associated with this data file. More...
boolean  getAutomaticUpdatesEnabled ()
True if automatic updates are enabled, false otherwise. More...
Date  getUpdateAvailableTime ()
Get the date and time by which an update to the current data file is expected to have been published. More...
void  setUpdateAvailableTime (Date availableTime)
Set the date and time by which an update to the current data file is expected to have been published. More...
Date  getDataPublishedDateTime ()
Set the date and time that the current data file was published. More...
void  setDataPublishedDateTime (Date published)
Set the date and time that the current data file was published. More...
DataFileConfiguration  getConfiguration ()
Get the configuration that was provided for this data file. More...
void  setConfiguration (DataFileConfiguration configuration)
Set the configuration that was provided for this data file. More...
boolean  getIsRegistered ()
Returns true if this file has been registered with the data update service. More...
String  getFormattedUrl ()
Get the data update URL complete with any query string parameters that are needed to retrieve the data. More...
void  setDataUpdateService (DataUpdateService dataUpdateService)
Set the data update service that this data file is registered with. More...

Member Function Documentation

◆ getAutomaticUpdatesEnabled()

boolean fiftyone.pipeline.engines.data.AspectEngineDataFile.getAutomaticUpdatesEnabled ( )

True if automatic updates are enabled, false otherwise.

Returns
true if automatic updates are enabled, false otherwise

Implemented in fiftyone.pipeline.engines.data.AspectEngineDataFileDefault.

◆ getDataFilePath()

String fiftyone.pipeline.engines.data.AspectEngineDataFile.getDataFilePath ( )

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.

Returns
file path or null

Implemented in fiftyone.pipeline.engines.data.AspectEngineDataFileDefault.

◆ getFormattedUrl()

String fiftyone.pipeline.engines.data.AspectEngineDataFile.getFormattedUrl ( )

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.

Returns
formatted URL for getting a new data file

Implemented in fiftyone.pipeline.engines.data.AspectEngineDataFileDefault.

◆ getIsRegistered()

boolean fiftyone.pipeline.engines.data.AspectEngineDataFile.getIsRegistered ( )

Returns true if this file has been registered with the data update service.

False if not.

Returns
true if the file has been registered for updates

Implemented in fiftyone.pipeline.engines.data.AspectEngineDataFileDefault.

◆ getTempDataFilePath()

String fiftyone.pipeline.engines.data.AspectEngineDataFile.getTempDataFilePath ( )

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.

Returns
temp data file path or null

Implemented in fiftyone.pipeline.engines.data.AspectEngineDataFileDefault.

◆ getUpdateAvailableTime()

Date fiftyone.pipeline.engines.data.AspectEngineDataFile.getUpdateAvailableTime ( )

Get the date and time by which an update to the current data file is expected to have been published.

Returns
the data of the next data file

Implemented in fiftyone.pipeline.engines.data.AspectEngineDataFileDefault.

◆ setDataPublishedDateTime()

void fiftyone.pipeline.engines.data.AspectEngineDataFile.setDataPublishedDateTime ( Date   published )

Set the date and time that the current data file was published.

Parameters
published - date the file was published

Implemented in fiftyone.pipeline.engines.data.AspectEngineDataFileDefault.

◆ setIdentifier()

void fiftyone.pipeline.engines.data.AspectEngineDataFile.setIdentifier ( String   identifier )

Set an identifier for this data file.

Each data file used by an engine must have a different identifier.

Parameters
identifier - data file identifier

Implemented in fiftyone.pipeline.engines.data.AspectEngineDataFileDefault.

◆ setTempDataDirPath()

void fiftyone.pipeline.engines.data.AspectEngineDataFile.setTempDataDirPath ( String   path )

Set the path to use when working with temporary files associated with this data file.

Parameters
path - the to create temporary files in

Implemented in fiftyone.pipeline.engines.data.AspectEngineDataFileDefault.

◆ setTempDataFilePath()

void fiftyone.pipeline.engines.data.AspectEngineDataFile.setTempDataFilePath ( String   file )

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.

Parameters
file - temp data file path

Implemented in fiftyone.pipeline.engines.data.AspectEngineDataFileDefault.

◆ setUpdateAvailableTime()

void fiftyone.pipeline.engines.data.AspectEngineDataFile.setUpdateAvailableTime ( Date   availableTime )

Set the date and time by which an update to the current data file is expected to have been published.

Parameters
availableTime - the date of the next data file

Implemented in fiftyone.pipeline.engines.data.AspectEngineDataFileDefault.