Package com.streambase.sb

Class StreamProperties

java.lang.Object
com.streambase.sb.StreamProperties
All Implemented Interfaces:
Serializable
public final class StreamProperties extends Object implements Serializable
This class contains meta data about a stream.

Note: Serializations of instances of this class that are created (e.g., by using ObjectOutputStream) in one version of StreamBase in general will not be deserializable in any other version of StreamBase.

See Also:

  • Constructor Details

    • StreamProperties

      public StreamProperties(Element element) throws StreamBaseException
      Create a StreamProperties from the given XML document
      Parameters:
      element - The starting element of the StreamProperties XML document
      Throws:
      StreamBaseException - thrown when can not convert XML document into a StreamProperties

    • StreamProperties

      StreamProperties(Element element, ByteOrder byteOrder) throws StreamBaseException
      Create a StreamProperties from the given XML document
      Parameters:
      element - The starting element of the StreamProperties XML document
      byteOrder - the byte order to create tuples in
      Throws:
      StreamBaseException - thrown when can not convert XML document into a StreamProperties

    • StreamProperties

      StreamProperties(String xml, ByteOrder byteOrder) throws StreamBaseException
      Create a StreamProperties from the given string representation of an XML document
      Parameters:
      xml - The string representation of a XML document of a StreamProperties
      byteOrder - the byte order to create tuples in
      Throws:
      StreamBaseException - thrown when can not convert XML document into a StreamProperties

    • StreamProperties

      public StreamProperties(String xml) throws StreamBaseException
      Create a StreamProperties from the given string representation of an XML document
      Parameters:
      xml - The string representation of a XML document of a StreamProperties
      Throws:
      StreamBaseException - thrown when can not convert XML document into a StreamProperties

  • Method Details

    • getQualifiedName

      public String getQualifiedName()
      Return the fully qualified name of this Stream. Will include the container name and any modules.
      Returns:
      container name + name

    • getName

      public String getName()
      Return the stream name part of the name
      Returns:
      the stream name of the name

    • getContainerName

      public String getContainerName()
      Return the container name part of the name
      Returns:
      Return the container name part of the name

    • getModuleQualifiedName

      public String getModuleQualifiedName()
      Return the module qualified name of this Stream. Will include any module names, but does not include the container name.
      Returns:
      (module names if any) + name
      Since:
      5.0

    • getSchema

      public Schema getSchema()
      Return the stream's Schema
      Returns:
      the Schema of the stream

    • toHumanString

      public String toHumanString()
      Convert to human string
      Returns:
      string

    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • isInputStream

      public boolean isInputStream()
      Returns true if this stream is an input stream
      Returns:
      true if this stream is an input stream
      Since:
      6.2

    • isOutputStream

      public boolean isOutputStream()
      Returns true if this stream is an Output Stream
      Returns:
      true if an output stream
      Since:
      6.2

    • getCaptureTransformStrategy

      public CaptureTransformStrategy getCaptureTransformStrategy()
      Get capture transform strategy
      Returns:
      capture transform strategy