ScriptSink (RVPF-Core API Documentation)

Object
- SinkModule.Abstract
- - ScriptSink

All Implemented Interfaces:: SinkModule

public final class ScriptSink
extends SinkModule.Abstract

Script sink.

Nested Class Summary
- Nested classes/interfaces inherited from interface SinkModule
  SinkModule.Abstract

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`DELETE_TEXT_PROPERTY` Delete text property.
`static String`	`ENGINE_NAME_PROPERTY` Engine name property.
`static String`	`ENGINE_VERSION_PROPERTY` Engine version property.
`static String`	`METADATA_ATTRIBUTE` Metadata attribute.
`static String`	`SCRIPT_PROPERTIES` The script properties group.
`static String`	`START_FILE_PROPERTY` Start file property.
`static String`	`START_TEXT_PROPERTY` Start text property.
`static String`	`STOP_TEXT_PROPERTY` Stop text property.
`static String`	`UPDATE_ARG_ATTRIBUTE` Update argument attribute.
`static String`	`UPDATE_COUNT_ATTRIBUTE` Update count attribute.
`static String`	`UPDATE_TEXT_PROPERTY` Update text property.

Constructor Summary

Constructors
Constructor and Description

ScriptSink()

Constructors
Constructor and Description
`ScriptSink()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`close()` Closes this sink.
`boolean`	`delete(VersionedValue versionedValue)` Deletes a value.
`void`	`open()` Opens this Sink.
`boolean`	`setUp(SinkServiceAppImpl sinkAppImpl)` Sets up the sink for action.
`void`	`tearDown()` Tears down what has been set up.
`boolean`	`update(VersionedValue versionedValue)` Updates a value.

Methods inherited from class SinkModule.Abstract
abort, getMetadata, getSinkAppImpl, getThisLogger

Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DELETE_TEXT_PROPERTY
```
public static final String DELETE_TEXT_PROPERTY
```
    Delete text property.
    
    See Also:
    
    Constant Field Values
  - ENGINE_NAME_PROPERTY
```
public static final String ENGINE_NAME_PROPERTY
```
    Engine name property.
    
    See Also:
    
    Constant Field Values
  - ENGINE_VERSION_PROPERTY
```
public static final String ENGINE_VERSION_PROPERTY
```
    Engine version property.
    
    See Also:
    
    Constant Field Values
  - METADATA_ATTRIBUTE
```
public static final String METADATA_ATTRIBUTE
```
    Metadata attribute.
    
    See Also:
    
    Constant Field Values
  - SCRIPT_PROPERTIES
```
public static final String SCRIPT_PROPERTIES
```
    The script properties group.
    
    See Also:
    
    Constant Field Values
  - START_FILE_PROPERTY
```
public static final String START_FILE_PROPERTY
```
    Start file property.
    
    See Also:
    
    Constant Field Values
  - START_TEXT_PROPERTY
```
public static final String START_TEXT_PROPERTY
```
    Start text property.
    
    See Also:
    
    Constant Field Values
  - STOP_TEXT_PROPERTY
```
public static final String STOP_TEXT_PROPERTY
```
    Stop text property.
    
    See Also:
    
    Constant Field Values
  - UPDATE_ARG_ATTRIBUTE
```
public static final String UPDATE_ARG_ATTRIBUTE
```
    Update argument attribute.
    
    See Also:
    
    Constant Field Values
  - UPDATE_COUNT_ATTRIBUTE
```
public static final String UPDATE_COUNT_ATTRIBUTE
```
    Update count attribute.
    
    See Also:
    
    Constant Field Values
  - UPDATE_TEXT_PROPERTY
```
public static final String UPDATE_TEXT_PROPERTY
```
    Update text property.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ScriptSink
```
public ScriptSink()
```
- Method Detail
  - close
```
public void close()
```
    Closes this sink.
    
    Specified by:
    
    close in interface SinkModule
    
    Overrides:
    
    close in class SinkModule.Abstract
  - delete
```
public boolean delete(VersionedValue versionedValue)
```
    Deletes a value.
    
    Specified by:
    
    delete in interface SinkModule
    
    Overrides:
    
    delete in class SinkModule.Abstract
    
    Parameters:
    
    versionedValue - The point value to delete.
    
    Returns:
    
    True if notification may proceed.
  - open
```
public void open()
          throws ServiceNotReadyException
```
    Opens this Sink.
    
    Specified by:
    
    open in interface SinkModule
    
    Overrides:
    
    open in class SinkModule.Abstract
    
    Throws:
    
    ServiceNotReadyException - When the service is not ready.
  - setUp
```
public boolean setUp(SinkServiceAppImpl sinkAppImpl)
```
    Sets up the sink for action.
    
    Specified by:
    
    setUp in interface SinkModule
    
    Overrides:
    
    setUp in class SinkModule.Abstract
    
    Parameters:
    
    sinkAppImpl - The sink application implementation.
    
    Returns:
    
    True on success.
  - tearDown
```
public void tearDown()
```
    Tears down what has been set up.
    
    Specified by:
    
    tearDown in interface SinkModule
    
    Overrides:
    
    tearDown in class SinkModule.Abstract
  - update
```
public boolean update(VersionedValue versionedValue)
```
    Updates a value.
    
    Specified by:
    
    update in interface SinkModule
    
    Overrides:
    
    update in class SinkModule.Abstract
    
    Parameters:
    
    versionedValue - The new point value.
    
    Returns:
    
    True if notification may proceed.

Class ScriptSink

Nested Class Summary

Nested classes/interfaces inherited from interface SinkModule

Field Summary

Constructor Summary

Method Summary

Methods inherited from class SinkModule.Abstract

Methods inherited from class Object

Field Detail

DELETE_TEXT_PROPERTY

ENGINE_NAME_PROPERTY

ENGINE_VERSION_PROPERTY

METADATA_ATTRIBUTE

SCRIPT_PROPERTIES

START_FILE_PROPERTY

START_TEXT_PROPERTY

STOP_TEXT_PROPERTY

UPDATE_ARG_ATTRIBUTE

UPDATE_COUNT_ATTRIBUTE

UPDATE_TEXT_PROPERTY

Constructor Detail

ScriptSink

Method Detail

close

delete

open

setUp

tearDown

update