# Package com.streambase.sb.operator

Provides classes and interfaces to add custom operators to StreamBase applications.

See: Description

- Interface Summary
  Interface | Description
  --- | ---
  IResourceReader |
  Operator.ConfigurationAccessor | Provides access to configuration information for use by operators and adapters, available from the server's configuration file.
  Operator.RuntimeEnvironment | This interface is used to gain access to StreamBase Server information and facilities.
  Operator.SharedObject | A SharedObject is an object that can be shared between Operators within a Container.
  Operator.SharedObjectManager | The manager for SharedObjects within a container.
  Parameterizable | Interface for the objects that hold the user-configurable parameters for Java Operators when they appear in StreamBase Studio.
  PreparedQuery | A query that has been prepared against a table.
  RowConsumer | Interface for consumers of table rows.
  TableAccessor | A handle for accessing a table.

- Class Summary
  Class | Description
  --- | ---
  AggregateWindow | represent a Heap-based aggregate window (For backward compat, we can't call this HeapAggregateWindow, hence have to settle with AggregateWindow)
  BaseAggregateWindow | Abstract base class for all custom java aggregate functions.
  Operator | Abstract base class for User code that is used as a Java Operator or an embedded Adapter in a StreamBase application.
  Operator.ArtifactProperties | For operators supporting Artifacts, this class is used to communicate properties about them during development in Studio, and is reported to the operator immediately prior to `Operator.typecheck()` along with all other setters.
  Operator.OperatorStates | The set of runtime states that an Operator can be in.
  Operator.SuspendBehaviorStates | Suspend behavior defines how an Operator handles tuples when it is suspended; meaning when it is in the `SUSPENDED` state.
  OperatorInternal |
  PortCounts | A record type to describe the number of input and output ports an operator has.
  TransactionalMemoryAggregateWindow | A transactional memory aggregate window

- Enum Summary
  Enum | Description
  --- | ---
  Operator.IconKind | An enumeration for the different kinds of icons that StreamBase Studio may request when displaying Operators and Adapters.
  Operator.LogLevel | Included values are, in decreasing order of chattiness: `Operator.LogLevel.ALL`, `Operator.LogLevel.TRACE`, `Operator.LogLevel.DEBUG`, `Operator.LogLevel.INFO`, `Operator.LogLevel.WARN`, `Operator.LogLevel.ERROR`, `Operator.LogLevel.OFF`.
  Operator.SharedObject.State | The state of the SharedObject
  StorageMethod | Data storage method
  TransactionIsolationLevel | This describes the server's transaction isolation level (only meaningful for com.streambase.sb.operator.StorageMethod.TRANSACTIONAL_MEMORY)

- Exception Summary
  Exception | Description
  --- | ---
  AlreadyRegisteredException |
  DbConnectTypecheckException |
  ParameterInterpretationException |
  ResourceNotFoundException | Thrown when an operator tries to get a resource by name, but no such resource exists.
  SqlTypecheckException |
  TypecheckException | May be thrown when an error occurs during an Operator's typecheck() method.

## Package com.streambase.sb.operator Description

Provides classes and interfaces to add custom operators to StreamBase applications.

Copyright © 2015–2018 Cloud Software Group, Inc.. All rights reserved.