51Degrees Pipeline Java  4.1

51Degrees Pipeline for Java

fiftyone.pipeline.engines.fiftyone.data.FiftyOneDataFile Interface Reference

Detailed Description

51Degrees specific data file.

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

[legend]

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

[legend]

Public Member Functions

String  getDataUpdateDownloadType ()
Get the type name to send when checking for data file updates e.g. More...
void  setDataUpdateDownloadType (String type)
Set the data download type e.g. More...

Public Member Functions inherited from fiftyone.pipeline.engines.data.AspectEngineDataFile

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

◆ getDataUpdateDownloadType()

String fiftyone.pipeline.engines.fiftyone.data.FiftyOneDataFile.getDataUpdateDownloadType ( )

Get the type name to send when checking for data file updates e.g.

HashV41. In general, this value should be pulled from the Engine, which will have read it from the data file. However, in some cases, we want to know the type name before the engine is created. (e.g. when UpdateOnStartup is set) This is why the value can also be set.

Returns
download type

Implemented in fiftyone.pipeline.engines.fiftyone.data.FiftyOneDataFileDefault.