qual_validate.hpp

Go to the documentation of this file.

Go to the SVN repository for this file.

/* $Id: qual_validate.hpp 99335 2023-03-13 13:48:10Z stakhovv $
 * ===========================================================================
 *
 *                            PUBLIC DOMAIN NOTICE
 *               National Center for Biotechnology Information
 *
 *  This software/database is a "United States Government Work" under the
 *  terms of the United States Copyright Act.  It was written as part of
 *  the author's official duties as a United States Government employee and
 *  thus cannot be copyrighted.  This software/database is freely available
 *  to the public for use. The National Library of Medicine and the U.S.
 *  Government have not placed any restriction on its use or reproduction.
 *
 *  Although all reasonable efforts have been taken to ensure the accuracy
 *  and reliability of the software and data, the NLM and the U.S.
 *  Government do not and cannot warrant the performance or results that
 *  may be obtained by using this software or data. The NLM and the U.S.
 *  Government disclaim all warranties, express or implied, including
 *  warranties of performance, merchantability or fitness for any particular
 *  purpose.
 *
 *  Please cite the author in any work or product based on this material.
 *
 * ===========================================================================
 *
 * File Name: qual_validate.hpp
 *
 * Author: Frank Ludwig
 *
 * File Description:
 *
 */
 
#ifndef FLATFILE__QUAL_VALIDATE__HPP
#define FLATFILE__QUAL_VALIDATE__HPP
 
#include "ftaerr.hpp"
#include <objtools/flatfile/flat2err.h>
 
BEGIN_NCBI_SCOPE
 
 
//  ----------------------------------------------------------------------------
class CQualCleanup
//  ----------------------------------------------------------------------------
{
public:
    CQualCleanup(
        const string& featKey,
        const string& featLocation);
 
    bool CleanAndValidate(
        string& qualKey,
        string& qualVal);
 
private:
    bool xCleanAndValidateGeneric(
        string& qualKey,
        string& qualVal);
 
    bool xCleanAndValidateConsSplice(
        string& qualKey,
        string& qualVal);
    bool xCleanAndValidateNote(
        string& qualKey,
        string& qualVal);
    bool xCleanAndValidateSpecificHost(
        string& qualKey,
        string& qualVal);
    bool xCleanAndValidateReplace(
        string& qualKey,
        string& qualVal);
    bool xCleanAndValidateRptUnit(
        string& qualKey,
        string& qualVal);
    bool xCleanAndValidateRptUnitSeq(
        string& qualKey,
        string& qualVal);
    bool xCleanAndValidateTranslation(
        string& qualKey,
        string& qualVal);
 
    static bool xCleanStripBlanks(
        string& val);
    static bool xCleanToLower(
        string& val);
    static bool xCleanFollowCommasWithBlanks(
        string& val);
 
    static bool xValueContainsEmbeddedQualifier(
        const string& val,
        string&       firstEmbeddedQualifier);
    static bool xValueIsMissingOrExtra(
        const string& qualKey,
        const string& qualVal,
        bool&         shouldHaveValue);
 
    const string& mFeatKey;
    const string& mFeatLocation;
};
 
END_NCBI_SCOPE
 
#endif // FLATFILE__QUAL_VALIDATE__HPP