ifmeserverstring.h

Go to the documentation of this file.

#ifndef _IFMESERVERSTRING_H
#define _IFMESERVERSTRING_H

#include <fmeservertypes.h>


//===========================================================================
// Abstract Interface Class -- all methods are virtual and it has no data
class IFMEServerString
{
public:

   // -----------------------------------------------------------------------
   virtual const char* operator=(const char* stringValue) = 0;

   // -----------------------------------------------------------------------
   virtual operator const char*() const = 0;

   // -----------------------------------------------------------------------
   virtual FME_Boolean operator==(const char* other) = 0;

   // -----------------------------------------------------------------------
   virtual void set(const char* stringValue, const FME_UInt32 length) = 0;

   // -----------------------------------------------------------------------
   virtual const char* data() const = 0;

   // -----------------------------------------------------------------------
   virtual FME_UInt32 length() const = 0;

protected:
   // -----------------------------------------------------------------------
   /* Constructor                                                          */
   IFMEServerString() {}; 

   // -----------------------------------------------------------------------
   /* Destructor                                                           */
   virtual ~IFMEServerString() {};

private:
   // Hide methods that we don't want called -- but we leave the door
   // open if subclasses want to implement these

   // -----------------------------------------------------------------------
   /* copy constructor                                                     */
   IFMEServerString(const IFMEServerString&);

   // -----------------------------------------------------------------------
   /* assignment operator.                                                 */
   IFMEServerString& operator=(const IFMEServerString&);

};

//===========================================================================
// Abstract Interface Class -- all methods are virtual and it has no data
class IFMEServerStringArray
{
public:

   // -----------------------------------------------------------------------
   virtual void append(const char* stringValue) = 0;

   // -----------------------------------------------------------------------
   virtual void append(const IFMEServerString& stringValue) = 0;

   // -----------------------------------------------------------------------
   virtual const char* operator()(FME_UInt32 index) const = 0;

   // -----------------------------------------------------------------------
   virtual FME_MsgNum getElement(const FME_UInt32 index,
                                 IFMEServerString& element) const = 0;

   // -----------------------------------------------------------------------
   virtual FME_MsgNum setElement(const FME_UInt32 index,
                                 const IFMEServerString& element) = 0;

   // -----------------------------------------------------------------------
   virtual FME_UInt32 entries() const = 0;

   // -----------------------------------------------------------------------
   virtual void clear() = 0;

   // -----------------------------------------------------------------------
   virtual FME_Boolean contains(const char* stringValue) const = 0;

   // -----------------------------------------------------------------------
   virtual FME_Boolean contains(const IFMEServerString& stringValue) const = 0;

   // -----------------------------------------------------------------------
   virtual void appendCSVString(const char* csvString, 
      const char* delimiter) = 0;

   // -----------------------------------------------------------------------
   virtual void appendTokenizeString(const char* tokenString, 
      const char* tokenSeparators) = 0;

   // -----------------------------------------------------------------------
   virtual FME_UInt32 removeAll(const char* stringValue) = 0;

   // -----------------------------------------------------------------------
   virtual FME_UInt32 removeAll(const IFMEServerString& stringValue) = 0;  

protected:
   // -----------------------------------------------------------------------
   // No one should be creating an instance of this directly, so we
   // make the constructor protected.
   IFMEServerStringArray() {}; 

   // -----------------------------------------------------------------------
   // Destructor 
   virtual ~IFMEServerStringArray() {};

private:
   // Hide methods that we don't want called -- but we leave the door
   // open if subclasses want to implement these

   //---------------------------------------------------------------
   // copy constructor
   IFMEServerStringArray(const IFMEServerStringArray&);

   //---------------------------------------------------------------
   // assignment operator.
   IFMEServerStringArray& operator=(const IFMEServerStringArray&);
};

#endif