Teuchos Package Browser (Single Doxygen Collection) Version of the Day
Teuchos_ValidatorXMLConverter.hpp
Go to the documentation of this file.
00001 // @HEADER
00002 // ***********************************************************************
00003 //
00004 //                    Teuchos: Common Tools Package
00005 //                 Copyright (2004) Sandia Corporation
00006 //
00007 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
00008 // license for use of this work by or on behalf of the U.S. Government.
00009 //
00010 // Redistribution and use in source and binary forms, with or without
00011 // modification, are permitted provided that the following conditions are
00012 // met:
00013 //
00014 // 1. Redistributions of source code must retain the above copyright
00015 // notice, this list of conditions and the following disclaimer.
00016 //
00017 // 2. Redistributions in binary form must reproduce the above copyright
00018 // notice, this list of conditions and the following disclaimer in the
00019 // documentation and/or other materials provided with the distribution.
00020 //
00021 // 3. Neither the name of the Corporation nor the names of the
00022 // contributors may be used to endorse or promote products derived from
00023 // this software without specific prior written permission.
00024 //
00025 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
00026 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00027 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
00028 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
00029 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
00030 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
00031 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00032 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00033 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00034 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00035 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00036 //
00037 // Questions? Contact Michael A. Heroux (maherou@sandia.gov)
00038 //
00039 // ***********************************************************************
00040 // @HEADER
00041 
00042 #ifndef TEUCHOS_VALIDATORXMLCONVERTER_HPP
00043 #define TEUCHOS_VALIDATORXMLCONVERTER_HPP
00044 
00050 #include "Teuchos_XMLObject.hpp"
00051 #include "Teuchos_Describable.hpp"
00052 #include "Teuchos_XMLParameterListExceptions.hpp"
00053 #include "Teuchos_ParameterEntryValidator.hpp"
00054 #include "Teuchos_XMLParameterListReader.hpp"
00055 #include "Teuchos_XMLParameterListWriter.hpp"
00056 
00057 
00058 namespace Teuchos {
00059 
00060 
00064 class TEUCHOS_LIB_DLL_EXPORT ValidatorXMLConverter : public Describable {
00065 
00066 public:
00067 
00070   
00078   RCP<ParameterEntryValidator>
00079   fromXMLtoValidator(
00080     const XMLObject& xmlObj,
00081     const IDtoValidatorMap& validatorIDsMap) const;
00082 
00092   virtual RCP<ParameterEntryValidator> 
00093     convertXML(const XMLObject& xmlObj, 
00094     const IDtoValidatorMap& validatorIDsMap) const=0;
00095 
00106   XMLObject fromValidatortoXML(
00107     const RCP<const ParameterEntryValidator> validator,
00108     const ValidatortoIDMap& validatorIDsMap,
00109     bool assignedID=true) const;
00110 
00120   virtual void convertValidator(
00121     const RCP<const ParameterEntryValidator> validator,
00122     XMLObject& xmlObj,
00123     const ValidatortoIDMap& validatorIDsMap) const = 0;
00124   
00126 
00127   #ifdef HAVE_TEUCHOS_DEBUG
00128 
00130 
00137   virtual Teuchos::RCP<const ParameterEntryValidator> 
00138     getDummyValidator() const = 0;
00139   
00141   #endif
00142 
00144 
00145   
00147   static const std::string& getIdAttributeName(){
00148     static const std::string idAttributeName = "validatorId";
00149     return idAttributeName;
00150   }
00151 
00153   static const std::string& getPrototypeIdAttributeName(){
00154     static const std::string prototypeIdAttributeName = "prototypeId";
00155     return prototypeIdAttributeName;
00156   }
00157   
00159   static const std::string& getTypeAttributeName(){
00160     static const std::string typeAttributeName = "type";
00161     return typeAttributeName;
00162   }
00163 
00165   static const std::string& getValidatorTagName(){
00166     static const std::string validatorTagName = "Validator";
00167     return validatorTagName;
00168   }
00170 
00171 };
00172 
00173 
00174 } // namespace Teuchos
00175 
00176 
00177 #endif // TEUCHOS_VALIDATORXMLCONVERTER_HPP
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines