ifmeserverdataset.h

Go to the documentation of this file.

#ifndef _IFMESERVERDATASET_H
#define _IFMESERVERDATASET_H

#include <fmeservertypes.h>
#include <ifmeservervector.h>
#include <ifmeserverstatus.h>

class IFMEServerString;
class IFMEServerPropertyAccessor;

class IFMEServerDataset
{
public:

   //-------------------------------------------------------------------
   // Gets the name of the dataset.
   // @return the name of the dataset
   virtual void getName(IFMEServerString& name) const = 0;

   //-------------------------------------------------------------------
   // Gets all the feature types included in this dataset.
   // @return a list of all the feature types included in this dataset
   // This object retains ownership of the featuretype vector
   virtual IFMEServerFeatureTypeVector* getFeatureTypes() const = 0;

   //-------------------------------------------------------------------
   // Gets the spatial data format of this dataset.
   // @return the format of the dataset
   virtual void getFormat(IFMEServerString& format) const = 0;

   //-------------------------------------------------------------------
   // Gets the location of this dataset in the repository.
   // @return the location of the file or folder containing this dataset
   virtual void getLocation(IFMEServerString& location) const = 0;

   //-------------------------------------------------------------------
   // Checks whether this dataset is a source or destination dataset.
   // @return <code>true</code> if this dataset is used as a source dataset,
   //         <code>false</code> if it is a destination dataset
   virtual FME_Boolean isSource() const = 0;

   //-------------------------------------------------------------------
   // Gets a property accessor to access dataset properties.
   // @return the property accessor
   virtual IFMEServerPropertyAccessor* getPropertyAccessor() const = 0;

   //-------------------------------------------------------------------
   // Updates the property accessor.
   // @param propertyAccessor the property accessor.
   // @return IFMEServerStatus or NULL if nothing wrong happened.
   virtual IFMEServerStatus* updatePropertyAccessor(IFMEServerPropertyAccessor& propertyAccessor) const = 0;

protected:

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

   // -----------------------------------------------------------------------
   // No one should be destroying an instance of this directly, so we
   // make the destructor protected.
   virtual ~IFMEServerDataset() {}

private:

   // -----------------------------------------------------------------------
   // The copy constructor is not implemented.
   IFMEServerDataset(const IFMEServerDataset &other);

   //---------------------------------------------------------------
   // The assignment operator is not implemented. 
   IFMEServerDataset &operator=(const IFMEServerDataset &other);
};


#endif