otbXMLMetadataSupplier.h

Go to the documentation of this file.

/*
 * Copyright (C) 2005-2024 Centre National d'Etudes Spatiales (CNES)
 *
 * This file is part of Orfeo Toolbox
 *
 *     https://www.orfeo-toolbox.org/
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
 
#ifndef otbXMLMetadataSupplier_h
#define otbXMLMetadataSupplier_h
 
#include "cpl_minixml.h"
#include "cpl_string.h"
 
#include "OTBMetadataExport.h"
#include "otbMetadataSupplierInterface.h"
#include "otbStringUtilities.h"
 
 
namespace otb
{
 
class OTBMetadata_EXPORT XMLMetadataSupplier
  : public MetadataSupplierInterface
{
public:
  XMLMetadataSupplier(const std::string &);
  XMLMetadataSupplier(const XMLMetadataSupplier &) = delete;
  XMLMetadataSupplier& operator=(const XMLMetadataSupplier&) = delete;
 
  std::string GetMetadataValue(std::string const& path, bool& hasValue, int band=1) const override;
 
  std::string GetFirstMetadataValue(std::string const& paths, bool& hasValue) const;
 
  template <typename T> T GetFirstAs(std::string const& path) const
  {
    bool hasValue;
    std::string ret = GetFirstMetadataValue(path, hasValue);
    if (!hasValue)
    {
      otbGenericExceptionMacro(MissingMetadataException,<<"Missing metadata '"<<path<<"'")
    }
    try
    {
      return boost::lexical_cast<T>(ret);
    }
    catch (boost::bad_lexical_cast&)
    {
      otbGenericExceptionMacro(MissingMetadataException,<<"Bad metadata value for '"<<path<<"', got: "<<ret)
    }
  }
 
  std::string GetResourceFile(std::string const& s="") const override;
 
  int GetNbBands() const override;
 
  unsigned int GetNumberOf(std::string const& path) const override;
 
  unsigned int GetAttributeId(std::string const& path, std::string const& value) const override;
 
  std::string PrintSelf() const;
 
  ~XMLMetadataSupplier() = default;
protected:
 
  char** AddXMLNameValueToList(char** papszList, const char *pszName,
                                               const char *pszValue);
 
  void ReadXMLToListFirstPass(const CPLXMLNode* psNode,
                                              std::map<std::string, int>& oMapCountKeysFull,
                                              const std::string& osPrefixFull);
  virtual char** ReadXMLToList(const CPLXMLNode* psNode,
                                       char** papszList,
                                       const std::map<std::string, int>& oMapCountKeysFullRef,
                                       std::map<std::string, int>& oMapCountKeysFull,
                                       std::map<std::string, int>& oMapCountKeys,
                                       const std::string& osPrefix,
                                       const std::string& osPrefixFull);
 
  virtual char** ReadXMLToList(CPLXMLNode* psNode, char** papszList,
                               const char* pszName = "");
 
  std::vector<std::string> FetchPartialNameValueMultiple(char** papszStrList, const char *pszName) const;
 
  std::vector<std::string> FetchPartialNameValueMultiple(const std::vector<std::string> &StringVector,
                                                     const std::string &Name) const;
 
  std::vector<std::string> GetAllStartWith(char** papszStrList, const char *pszName) const;
 
private:
  std::string m_FileName;
 
  char** m_MetadataDic = nullptr;
};
 
} // end namespace otb
 
#endif