Module datarush.library
Package com.pervasive.datarush.operators.graph

Class MockableExternalRecordSource

java.lang.Object
com.pervasive.datarush.operators.AbstractLogicalOperator
com.pervasive.datarush.operators.StreamingOperator
com.pervasive.datarush.operators.ExecutableOperator
com.pervasive.datarush.operators.graph.MockableExternalRecordSource
All Implemented Interfaces:
LogicalOperator, PipelineOperator<RecordPort>, RecordPipelineOperator
public class MockableExternalRecordSource extends ExecutableOperator implements RecordPipelineOperator
A mockable source that can be utilized with the SubJobExecutor to insert parameter data. When used with a SubJobExecutor this node should be explicitly named 'Start Node'. Additionally this operator can be used to generate key-value properties that can be used by connected operators. These can be provided directly or with a file that contains the property values, however both methods cannot be used together. The operator will check for input from the port and if it is not available then it will use the properties provided either from a file or programmatically.

  • Constructor Details

    • MockableExternalRecordSource

      public MockableExternalRecordSource()

  • Method Details

    • getInput

      public RecordPort getInput()
      Description copied from interface: PipelineOperator
      Returns the input port
      Specified by:
      getInput in interface PipelineOperator<RecordPort>
      Returns:
      the input port

    • getOutput

      public RecordPort getOutput()
      Description copied from interface: PipelineOperator
      Returns the output port
      Specified by:
      getOutput in interface PipelineOperator<RecordPort>
      Returns:
      the output port

    • getProperties

      public Properties getProperties()
      Get the key-value properties that will be output.
      Returns:
      the properties sent to the output

    • setProperties

      public void setProperties(Properties properties)
      Set the key-value properties that will be output.
      Parameters:
      properties - sent to the output

    • getParameterFile

      public String getParameterFile()
      Get the file containing the property values.
      Returns:
      the file with property values

    • setParameterFile

      public void setParameterFile(String filename)
      Set the file containing the property values.
      Parameters:
      filename - of the file with property values

    • getParameterFileType

      public PropertiesFileUtil.PropertyFileType getParameterFileType()
      Get the format of the file containing property values. Default is Java property file but also supports JSON and XML.
      Returns:
      the format of the property file

    • setParameterFileType

      public void setParameterFileType(PropertiesFileUtil.PropertyFileType parameterFileType)
      Set the format of the file containing property values. File format can be Java property, JSON, or XML.
      Parameters:
      parameterFileType - format of the property file

    • discoverParameterFileType

      public void discoverParameterFileType()
      Attempts to set the parameter file type automatically based on the extension of the file.

    • execute

      protected void execute(ExecutionContext ctx)
      Description copied from class: ExecutableOperator
      Executes the operator. Implementations should adhere to the following contracts:
      1. Following execution, all input ports must be at end-of-data.
      2. Following execution, all output ports must be at end-of-data.
      Specified by:
      execute in class ExecutableOperator
      Parameters:
      ctx - context in which to lookup physical ports bound to logical ports

    • computeMetadata

      protected void computeMetadata(StreamingMetadataContext ctx)
      Description copied from class: StreamingOperator
      Implementations must adhere to the following contracts

      General

      Regardless of input ports/output port types, all implementations must do the following:

      1. Validation. Validation of configuration should always be performed first.
      2. Declare parallelizability.. Implementations must declare parallelizability by calling StreamingMetadataContext.parallelize(ParallelismStrategy).

      Input record ports

      Implementations with input record ports must declare the following:
      1. Required data ordering:
        2. Implementations that have data ordering requirements must declare them by calling RecordPort#setRequiredDataOrdering, otherwise data may arrive in any order.
      2. Required data distribution (only applies to parallelizable operators):
        3. Implementations that have data distribution requirements must declare them by calling RecordPort#setRequiredDataDistribution, otherwise data will arrive in an unspecified partial distribution.
      Note that if the upstream operator's output distribution/ordering is compatible with those required, we avoid a re-sort/re-distribution which is generally a very large savings from a performance standpoint. In addition, some operators may chose to query the upstream output distribution/ordering by calling RecordPort#getSourceDataDistribution and RecordPort#getSourceDataOrdering. These should be viewed as a hints to help chose a more efficient algorithm. In such cases, though, operators must still declare data ordering and data distribution requirements; otherwise there is no guarantee that data will arrive sorted/distributed as required.

      Output record ports

      Implementations with output record ports must declare the following:
      1. Type: Implementations must declare their output type by calling RecordPort#setType.
      Implementations with output record ports may declare the following:
      1. Output data ordering: Implementations that can make guarantees as to their output ordering may do so by calling RecordPort#setOutputDataOrdering
      2. Output data distribution (only applies to parallelizable operators): Implementations that can make guarantees as to their output distribution may do so by calling RecordPort#setOutputDataDistribution
      Note that both of these properties are optional; if unspecified, performance may suffer since the framework may unnecessarily re-sort/re-distributed the data.

      Input model ports

      In general, there is nothing special to declare for input model ports. Models are implicitly duplicated to all partitions when going from non-parallel to parallel operators. The case of a model going from a parallel to a non-parallel node is a special case of a "model reducer" operator. In the case of a model reducer, the downstream operator, must declare the following:
      1. Merge handler: Model reducers must declare a merge handler by calling AbstractModelPort#setMergeHandler.
      Note that MergeModel is a convenient, re-usable model reducer, parameterized with a merge-handler.

      Output model ports

      SimpleModelPort's have no associated metadata and therefore there is never any output metadata to declare. PMMLPort's, on the other hand, do have associated metadata. For all PMMLPorts, implementations must declare the following:
      1. pmmlModelSpec: Implementations must declare the PMML model spec by calling PMMLPort.setPMMLModelSpec.
      Specified by:
      computeMetadata in class StreamingOperator
      Parameters:
      ctx - the context