Teuchos - Trilinos Tools Package Version of the Day
Teuchos_ValidatorXMLConverter.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_ValidatorXMLConverter.hpp"
00043 
00044 namespace Teuchos{
00045 
00046 RCP<ParameterEntryValidator>
00047 ValidatorXMLConverter::fromXMLtoValidator(
00048   const XMLObject& xmlObj,
00049   const IDtoValidatorMap& validatorIDsMap) const
00050 {
00051   #ifdef HAVE_TEUCHOS_DEBUG
00052   RCP<const ParameterEntryValidator> dummyValidator = getDummyValidator();
00053   TEST_FOR_EXCEPTION(
00054     xmlObj.getRequired(getTypeAttributeName())
00055     !=
00056     dummyValidator->getXMLTypeName(), 
00057     BadValidatorXMLConverterException, 
00058     "Cannot convert xmlObject " << 
00059     ". Expected a " << dummyValidator->getXMLTypeName() <<
00060     " tag but got a " << xmlObj.getRequired(getTypeAttributeName()) << "type");
00061   #endif
00062   RCP<ParameterEntryValidator> toReturn = 
00063     convertXML(xmlObj, validatorIDsMap);
00064   return toReturn;
00065 }
00066 
00067 XMLObject 
00068 ValidatorXMLConverter::fromValidatortoXML(
00069   const RCP<const ParameterEntryValidator> validator,
00070   const ValidatortoIDMap& validatorIDsMap,
00071   bool assignedID) const
00072 {
00073   #ifdef HAVE_TEUCHOS_DEBUG
00074   RCP<const ParameterEntryValidator> dummyValidator = getDummyValidator();
00075   TEST_FOR_EXCEPTION(
00076     validator->getXMLTypeName() 
00077     !=
00078     dummyValidator->getXMLTypeName(), 
00079     BadValidatorXMLConverterException, 
00080     "Cannot convert Validator " << 
00081     ". Expected a " << dummyValidator->getXMLTypeName() <<
00082     " validator but got a " << validator->getXMLTypeName() << "type");
00083   #endif
00084   XMLObject toReturn(getValidatorTagName());
00085   toReturn.addAttribute(getTypeAttributeName(), validator->getXMLTypeName());
00086   if(assignedID){
00087     TEST_FOR_EXCEPTION(validatorIDsMap.find(validator) == validatorIDsMap.end(),
00088       MissingValidatorDefinitionException,
00089       "Could not find an id associated with the validator in the "
00090       "given validatorIDsMap to use when " <<
00091       "writing it to XML!" << std::endl << std::endl);
00092     toReturn.addAttribute(getIdAttributeName(),
00093       validatorIDsMap.find(validator)->second);
00094   }
00095   convertValidator(validator, toReturn, validatorIDsMap);
00096   return toReturn;
00097 }
00098 
00099 
00100 }
00101 
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines