Class 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:
    Serialized Form
    • Constructor Detail

      • 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

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

      • 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()
      • 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
        Since:
        6.2