com.streambase.sb.monitor

## Class StreamInfo

- java.lang.Object
- - com.streambase.sb.monitor.StreamInfo

- All Implemented Interfaces:
    Cloneable

      public class StreamInfo
      extends Object
      implements Cloneable

  Represents information about a stream in a StreamBase Server. Instances of this class should be retrieved from a Snapshot.
  See Also:
    `Snapshot`

- - ### Field Summary

    Fields
    Modifier and Type | Field and Description
    --- | ---
    `(package private) boolean` | `isActive`

  - ### Constructor Summary

    Constructors
    Constructor and Description
    `StreamInfo(StreamProperties props)`

  - ### Method Summary

    All Methods Instance Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `(package private) void` | `calculate(Snapshot ms, SystemInfo si)`
    `(package private) void` | `clear()`
    `Object` | `clone()`
    `(package private) void` | `extractInfo(StatTuple st)` extract stream info from the StatTuple, setting member data as appropriate
    `(package private) void` | `extractInfo(StatTuplev3 st)`
    `long` | `getDeltaTuples()` Return the number of tuples since the last snapshot
    `long` | `getNumTuples()` Return the total number of tuples on the stream since the stream was created
    `StreamProperties` | `getStreamProperties()` Returns the StreamProperties of the stream
    `(package private) void` | `prettyPrint()` Pretty-print a StreamInfo object to the standard output.
    `(package private) void` | `saveForNextCycle()`
    `String` | `toString()` Returns a string representation of the StreamInfo object.

    - ### Methods inherited from class java.lang.Object

      `equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

- - ### Field Detail

    - #### isActive

          boolean isActive

  - ### Constructor Detail

    - #### StreamInfo

          StreamInfo(StreamProperties props)

  - ### Method Detail

    - #### extractInfo

          void extractInfo(StatTuple st)

      extract stream info from the StatTuple, setting member data as appropriate
      Parameters:
        `st` -

    - #### extractInfo

          void extractInfo(StatTuplev3 st)

    - #### clone

          public Object clone()

      Overrides:
        `clone` in class `Object`

    - #### saveForNextCycle

          void saveForNextCycle()

    - #### calculate

          void calculate(Snapshot ms,
                         SystemInfo si)

    - #### getStreamProperties

          public StreamProperties getStreamProperties()

      Returns the StreamProperties of the stream
      Returns:
        the StreamProperties of the stream

    - #### getNumTuples

          public long getNumTuples()

      Return the total number of tuples on the stream since the stream was created
      Returns:
        the total number of tuples on the stream since the stream was created

    - #### getDeltaTuples

          public long getDeltaTuples()

      Return the number of tuples since the last snapshot
      Returns:
        the number of tuples since the last snapshot

    - #### toString

          public String toString()

      Returns a string representation of the StreamInfo object.
      Overrides:
        `toString` in class `Object`
      Returns:
        a string representation of the object.

    - #### prettyPrint

          void prettyPrint()

      Pretty-print a StreamInfo object to the standard output.

    - #### clear

          void clear()

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