StreamProperties.hpp

// Copyright (c) 2004-2023 TIBCO Software Inc.  All rights reserved.

#ifndef STREAMBASE_STREAMPROPERTIES_H
#define STREAMBASE_STREAMPROPERTIES_H

#include "StreamBase.hpp"

#include "Exceptions.hpp"
#include "Schema.hpp"

SB_INTERNAL_FWD(StreamPropertiesUtil)

SB_NAMESPACE_BEGIN;

/// Properties of a single stream. Returned by
/// StreamBaseClient::getStreamProperties().
class StreamProperties {
  public:
    /// Determines the method StreamBase will use to expose capture fields to 
    /// client dequeuers.  The default is FLATTEN.
    enum CaptureTransformStrategy {
        FLATTEN,
        NEST,
        RAW
    };

    /// Null constructor. Object will have no name and no schema.
    StreamProperties() {}

    /// Returns the fully qualified name of the stream.
    const std::string &getQualifiedName() const { return _qualifiedName; }

    /// Returns the name part of the stream.
    const std::string &getName() const { return _name; }

    /// Returns the container part of the stream.
    const std::string &getContainerName() const { return _containerName; }

    /// Returns the schema of the stream.
    const Schema &getSchema() const { return _schema ;}

    // Returns the CaptureTransformStrategy that this stream is using
    CaptureTransformStrategy getCaptureTransformStrategy() const { return _captureStrategy; }

    /// Returns the hash of the stream in binary
    const std::string &hashString() const { return _hash; }

    // Return the hashString as converted into HEX
    const std::string &hexString() const { return _hexString; }

    // hash value of this StreamProperties, used for hash_maps
    const size_t hashValue() const { return _hashValue; }

    bool operator <(const StreamProperties& other) const {
        return hashString() < other.hashString();
    }

    bool operator == (const StreamProperties& other) const {
        return hashString() == other.hashString();        
    }
    bool operator != (const StreamProperties& other) const {
        return !(*this == other);
    }

    /// Parse and return a StreamProperties from an XML String.  The root tag must be
    /// &lt;stream&gt;.
    static StreamProperties fromXml(const std::string &input) ;

  private:
    /// Construct a StreamProperties with the given name and schema.
    StreamProperties(const std::string &name, const std::string &hash, const Schema &schema);
    /// Construct a StreamProperties with the given name, schema, schema for its parent app, and schema for its app
    StreamProperties(const std::string &name, const std::string &hash, const Schema &schema, const CaptureTransformStrategy captureStrategy);

    void init(const std::string &name);

    std::string _containerName;
    std::string _name;
    std::string _hash;
    std::string _qualifiedName;
    Schema _schema;
    CaptureTransformStrategy _captureStrategy;
    size_t _hashValue;
    std::string _hexString;
    friend class sb_internal::StreamPropertiesUtil;
};


SB_NAMESPACE_END;
#endif