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

Class OpenComposite

java.lang.Object
com.pervasive.datarush.operators.AbstractLogicalOperator
com.pervasive.datarush.operators.CompositeOperator
com.pervasive.datarush.operators.OpenComposite
All Implemented Interfaces:
PropertyValued, LogicalOperator, OperatorComposable
public final class OpenComposite extends CompositeOperator
A composite operator that can be externally composed. This is a convenient way to create a grouping of nodes without needing to subclass CompositeOperator.

  • Constructor Details

    • OpenComposite

      public OpenComposite(List<? extends LogicalPortFactory<?>> inputs, List<? extends LogicalPortFactory<?>> outputs)
      Create an open composite whose input ports and output ports are of arbitrary types. Following construction, callers must create the body by calling add and connect.
      Parameters:
      inputs - the factories for each of the input ports
      outputs - the factories for each of the output ports.

    • OpenComposite

      public OpenComposite(int numInputs, int numOutputs)
      Create an open composite whose input ports and output ports are all of type record. Following construction, callers must create the body by calling add and connect.
      Parameters:
      numInputs - the number of record inputs
      numOutputs - the number of record outputs

  • Method Details

    • getInput

      public final LogicalPort getInput(int index)
      Returns the input port of the given port index
      Parameters:
      index - the port index
      Returns:
      the input port

    • getOutput

      public final LogicalPort getOutput(int index)
      Returns the output port of the given port index
      Parameters:
      index - the port index
      Returns:
      the output port

    • connectOutput

      public void connectOutput(LogicalPort from, int index)

    • connectInput

      public void connectInput(int index, LogicalPort to)

    • compose

      protected final void compose(CompositionContext ctx)
      This implementation of compose adds any operators were added to this to the provided composition context and creates any connections that were added to this in the provided composition context.
      Specified by:
      compose in class CompositeOperator
      Parameters:
      ctx - the context

    • add

      public final <O extends LogicalOperator> O add(O op)
      Description copied from interface: OperatorComposable
      Add a LogicalOperator to this graph, using the short class name as the name of the operator.
      Specified by:
      add in interface OperatorComposable
      Type Parameters:
      O - the type of the operator.
      Parameters:
      op - the operator to add to the graph.
      Returns:
      the same operator that was passed to this method

    • add

      public final <O extends LogicalOperator> O add(O op, String name)
      Description copied from interface: OperatorComposable
      Add a LogicalOperator to this graph, specifying a name of the operator.
      Specified by:
      add in interface OperatorComposable
      Type Parameters:
      O - the type of the operator.
      Parameters:
      op - the operator to add to the graph.
      name - the name of the the operator
      Returns:
      the same operator that was passed to this method

    • add

      public final <O extends LogicalOperator> O add(O op, OperatorSettings settings)
      Description copied from interface: OperatorComposable
      Add a LogicalOperator to this graph, specifying advanced operator settings.
      Specified by:
      add in interface OperatorComposable
      Type Parameters:
      O - the type of the operator.
      Parameters:
      op - the operator to add to the graph.
      settings - operators settings, contains name and other configuration options.
      Returns:
      the same operator that was passed to this method

    • connect

      public final void connect(LogicalPort from, LogicalPort to)
      Description copied from interface: OperatorComposable
      Connect two ports together. Depending in the specific context, the source and target operators may be one of the following pairs:
      1. From an output port of an operator that was added to this context to an input port of an operator that was added to this context
      2. From an input port of the CompositeOperator to an input port of an operator that was added to this context. (Applies to CompositeOperator.compose(com.pervasive.datarush.operators.CompositionContext)).
      3. From an output port of an operator that was added to this context to an output port of the CompositeOperator. (Applies to CompositeOperator.compose(com.pervasive.datarush.operators.CompositionContext)).

      Note on port types: connecting mixed type ports will generally fail when the graph is compiled.

      Note that ports do not store connection information; rather, connection information is stored externally within this context.

      Specified by:
      connect in interface OperatorComposable
      Parameters:
      from - the source port
      to - the target port

    • getProperty

      public final Object getProperty(GraphPath path)
      Description copied from interface: PropertyValued
      Returns a property of the given path. Paths are of the form operatorPath.propertyName", where operatorPath is the name of an operator that was added to this graph and propertyName is the name of a property of the object.
      Specified by:
      getProperty in interface PropertyValued
      Parameters:
      path - the path to the property.
      Returns:
      the value of the property

    • setProperty

      public final void setProperty(GraphPath path, Object value)
      Description copied from interface: PropertyValued
      Sets a property of the given path. Paths are of the form operatorPath.propertyName", where operatorPath is the name of an operator that was added to this graph and propertyName is the name of a property of the object.
      Specified by:
      setProperty in interface PropertyValued
      Parameters:
      path - the path to the property.
      value - the new value of the property

    • getProperty

      public final Object getProperty(String path)
      Description copied from interface: PropertyValued
      Returns a property of the given path. Paths are of the form operatorPath.propertyName", where operatorPath is the name of an operator that was added to this graph and propertyName is the name of a property of the object.
      Specified by:
      getProperty in interface PropertyValued
      Parameters:
      path - the path to the property.
      Returns:
      the value of the property

    • setProperty

      public final void setProperty(String path, Object value)
      Description copied from interface: PropertyValued
      Sets a property of the given path. Paths are of the form operatorPath.propertyName", where operatorPath is the name of an operator that was added to this graph and propertyName is the name of a property of the object.
      Specified by:
      setProperty in interface PropertyValued
      Parameters:
      path - the path to the property.
      value - the new value of the property