Teuchos - Trilinos Tools Package Version of the Day
Teuchos_ValidatorXMLConverterDB.cpp
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 #include "Teuchos_ValidatorXMLConverterDB.hpp"
00043 #include "Teuchos_StandardParameterEntryValidators.hpp"
00044 #include "Teuchos_VerbosityLevel.hpp"
00045 #include "Teuchos_StaticSetupMacro.hpp"
00046 
00047 
00048 
00049 namespace Teuchos {
00050 
00051 
00052 void ValidatorXMLConverterDB::addConverter(
00053   RCP<const ParameterEntryValidator> validator,
00054   RCP<ValidatorXMLConverter> converterToAdd){
00055   getConverterMap().insert(ConverterPair(
00056     validator->getXMLTypeName(), converterToAdd));
00057 }
00058 
00059 
00060 RCP<const ValidatorXMLConverter>
00061 ValidatorXMLConverterDB::getConverter(const ParameterEntryValidator& validator)
00062 {
00063   ConverterMap::const_iterator it = getConverterMap().find(validator.getXMLTypeName());
00064   TEUCHOS_TEST_FOR_EXCEPTION(it == getConverterMap().end(),
00065     CantFindValidatorConverterException,
00066     "Could not find a ValidatorXMLConverter for validator type " <<
00067      validator.getXMLTypeName() << std::endl <<
00068      "Try adding an appropriate converter to the ValidatorXMLConverterDB " <<
00069      "in order solve this problem." << std::endl << std::endl
00070   )
00071   return it->second;
00072 }
00073 
00074 
00075 RCP<const ValidatorXMLConverter>
00076 ValidatorXMLConverterDB::getConverter(const XMLObject& xmlObject)
00077 { 
00078   std::string validatorType = xmlObject.getRequired(
00079     ValidatorXMLConverter::getTypeAttributeName());
00080   ConverterMap::const_iterator it = getConverterMap().find(validatorType);
00081   TEUCHOS_TEST_FOR_EXCEPTION(it == getConverterMap().end(),
00082     CantFindValidatorConverterException,
00083     "Could not find a ValidatorXMLConverter for type " << validatorType <<
00084     std::endl << 
00085     "Try adding an appropriate converter to the ValidatorXMLConverterDB " <<
00086     "in order solve this problem." << std::endl << std::endl
00087   )
00088   return it->second;
00089 }
00090 
00091 
00092 XMLObject ValidatorXMLConverterDB::convertValidator(
00093   RCP<const ParameterEntryValidator> validator,
00094   const ValidatortoIDMap& validatorIDsMap,
00095   bool assignID)
00096 {
00097   return getConverter(*validator)->fromValidatortoXML(
00098     validator, validatorIDsMap, assignID);
00099 }
00100 
00101  
00102 RCP<ParameterEntryValidator> ValidatorXMLConverterDB::convertXML(
00103   const XMLObject& xmlObject,
00104   const IDtoValidatorMap& validatorIDsMap)
00105 {
00106   return ValidatorXMLConverterDB::
00107     getConverter(xmlObject)->fromXMLtoValidator(xmlObject, validatorIDsMap);
00108 }
00109 
00110 
00111 ValidatorXMLConverterDB::ConverterMap&
00112 ValidatorXMLConverterDB::getConverterMap()
00113 {
00114   static ConverterMap masterMap;
00115   return masterMap;
00116   // See default setup code below!
00117 }
00118 
00119 
00120 void ValidatorXMLConverterDB::printKnownConverters(std::ostream& out){
00121   out << "Known ValidatorXMLConverters: " << std::endl;
00122   for(
00123     ConverterMap::const_iterator it = getConverterMap().begin();
00124     it != getConverterMap().end();
00125     ++it)
00126   {
00127     out << "\t" << it->first <<std::endl;
00128   }
00129 }
00130   
00131 
00132 } // namespace Teuchos
00133 
00134 
00135 namespace {
00136 
00137 
00138 TEUCHOS_STATIC_SETUP()
00139 {
00140   TEUCHOS_ADD_NUMBERTYPE_VALIDATOR_CONVERTERS(int);
00141   TEUCHOS_ADD_ENHANCEDNUMBERVALIDATOR_CONVERTER(double);
00142   TEUCHOS_ADD_ENHANCEDNUMBERVALIDATOR_CONVERTER(float);
00143   
00144   TEUCHOS_ADD_ARRAYVALIDATOR_CONVERTER(Teuchos::EnhancedNumberValidator<double>, double);
00145   TEUCHOS_ADD_ARRAYVALIDATOR_CONVERTER(Teuchos::EnhancedNumberValidator<float>, float);
00146   
00147   TEUCHOS_ADD_ARRAYVALIDATOR_CONVERTER(Teuchos::FileNameValidator, std::string);
00148   TEUCHOS_ADD_ARRAYVALIDATOR_CONVERTER(Teuchos::StringValidator, std::string);
00149   
00150 #ifdef HAVE_TEUCHOS_LONG_LONG_INT
00151   TEUCHOS_ADD_NUMBERTYPE_VALIDATOR_CONVERTERS(long long int);
00152 #endif // HAVE_TEUCHOS_LONG_LONG_INT
00153   
00154   TEUCHOS_ADD_STRINGTOINTEGRALVALIDATOR_CONVERTER(Teuchos::EVerbosityLevel); 
00155 
00156   TEUCHOS_ADD_VALIDATOR_CONVERTER(Teuchos::FileNameValidator, Teuchos::FileNameValidatorXMLConverter);
00157   TEUCHOS_ADD_VALIDATOR_CONVERTER(Teuchos::StringValidator, Teuchos::StringValidatorXMLConverter);
00158   TEUCHOS_ADD_VALIDATOR_CONVERTER(Teuchos::AnyNumberParameterEntryValidator, Teuchos::AnyNumberValidatorXMLConverter);
00159   
00160 }
00161 
00162 
00163 } // namespace
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines