rwKeywordValuePairsReader.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2013 MaK Technologies, Inc.
** All rights reserved.
*******************************************************************************/


#pragma once
 
#include "vrfutil/vrfutilDefines.h"
#include <readerWriter/readerWriter.h>
#include "vrfutil/rwKeyValueList.h"
#include "vrfutil/rwTemplatedList.h"

#include <string>
#include <map>
#include <set>

class DtFilename;

class DT_DLL_vrfutil DtRwKeywordValuePairsReader : public DtRwTemplatedListPtr<DtRwKeyValueList, true>
{
public:
   DtRwKeywordValuePairsReader(const DtString& name = "DtRwKeywordValuePairsReader");

   DtRwKeywordValuePairsReader(const DtRwKeywordValuePairsReader& orig);

   const DtRwKeywordValuePairsReader& operator=(const DtRwKeywordValuePairsReader & orig);

   virtual ~DtRwKeywordValuePairsReader();

   virtual const char* readerWriterType();

   static const char* theXmlType();

   virtual const char* xmlType() const
   {
      return theXmlType();
   }

   virtual DtString parameterNameFor(const DtString&) const;

   virtual bool hasMappingFor(const DtString&) const;

   virtual std::map<DtString, DtString> asStdMap(const DtString&) const;

   virtual bool isUserEditable(const DtString&) const;

   virtual void setValuesFor(const DtString& rw, const std::map<DtString, DtString>&);
   virtual void setValuesFor(const DtString& rw, const DtRwKeyValueList&);

   virtual void remove(const DtString&);


   virtual void getData(const DtEnvironmentSP env, const DtEnvValueSP envObject,
      const DtReaderWriter::SearchPaths& searchPaths, const DtVariableBindingsList& bindings);

   virtual std::set<DtString> readerWriterItems() const;

   virtual void rename(const DtString& from, const DtString& to);

   virtual DtString displayNameForKeyword(const DtString& rwName, const DtString& keyword) const;
};