Package cern.nxcals.api.custom.service
Interface ExtractionService
-
public interface ExtractionService
Represents a service for data extraction actions, as configured by the provided properties. Actions defined on this service operate on top of raw data that are directly extractable viaDataQuery
orDevicePropertyDataQuery
.- See Also:
Variable
,Entity
,ExtractionProperties
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description org.apache.spark.sql.Dataset<org.apache.spark.sql.Row>
getData(Entity entity, ExtractionProperties properties)
org.apache.spark.sql.Dataset<org.apache.spark.sql.Row>
getData(Variable variable, ExtractionProperties properties)
-
-
-
Method Detail
-
getData
org.apache.spark.sql.Dataset<org.apache.spark.sql.Row> getData(Variable variable, ExtractionProperties properties)
Returns adataset
based on the providedvariable
, controlled by the givenextraction properties
. This action extracts variable data for a given time window, enhanced by a configurablelookup strategy
.- Parameters:
variable
- an instance ofVariable
pointing to raw data for the extractionproperties
- theextraction properties
containing all semantics to control the action- Returns:
- a dataset of the extracted rows
-
getData
org.apache.spark.sql.Dataset<org.apache.spark.sql.Row> getData(Entity entity, ExtractionProperties properties)
Returns aDataset
based on the providedentity
, controlled by the givenextraction properties
. This action extracts entity data for a given time window, enhanced by a configurablelookup strategy
.- Parameters:
entity
- an instance ofEntity
pointing to raw data for the extractionproperties
- theextraction properties
containing all semantics to control the action- Returns:
- a dataset of the extracted rows
-
-