StreamBaseEntityType.hpp

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

#ifndef STREAMBASE_ENTITY_TYPE_H
#define STREAMBASE_ENTITY_TYPE_H

#include "StreamBase.hpp"
#include "Exceptions.hpp"

#include <string>


SB_NAMESPACE_BEGIN;


/// A type of entity in a StreamBase catalog.
class StreamBaseEntityType
{
  public:
    /// An enumeration of the types of entities stored in a catalog.
    enum Type {
        /// A stream.
        STREAM = 1,

        /// A schema.
        SCHEMA = 2,

        /// An operator.
        OPERATOR = 3,

        /// An window.
        WINDOW_SPEC = 4,

        /// A container.
        CONTAINER = 5,

        /// Pseudo-entity-type for tables
        TABLE = 6,

        /// Pseudo-entity-type for input streams only (in listEntities()).
        INPUT_STREAMS = 100,

        /// Pseudo-entity-type for output streams only, i.e., streams
        /// with no operators downstream (in listEntities()).
        OUTPUT_STREAMS = 101
    };

    /// Return a string naming the entity type.
    static std::string as_string(Type aType);

    /// Parse a string as an entity type.
    /// @param aType the string to parse
    /// @param allow_plural true if a plural version of the entity types (e.g., "streams" instead of "stream") is allowed
    /// @throw StreamBaseException if the entity type cannot be parsed
    static Type as_enum(const std::string &aType, bool allow_plural = false) ;
  private:
    StreamBaseEntityType() {}
    ~StreamBaseEntityType() {}
};

SB_NAMESPACE_END;
#endif