keywords_item.hpp

ncbi源码

/*
 * ===========================================================================
 * PRODUCTION $Log: keywords_item.hpp,v $
 * PRODUCTION Revision 1000.1  2004/06/01 19:39:47  gouriano
 * PRODUCTION PRODUCTION: UPGRADED [GCC34_MSVC7] Dev-tree R1.2
 * PRODUCTION
 * ===========================================================================
 */

#ifndef OBJTOOLS_FORMAT_ITEMS___KEYWORDS_ITEM__HPP
#define OBJTOOLS_FORMAT_ITEMS___KEYWORDS_ITEM__HPP

/*  $Id: keywords_item.hpp,v 1000.1 2004/06/01 19:39:47 gouriano Exp $
* ===========================================================================
*
*                            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.
*
* ===========================================================================
*
* Author:  Aaron Ucko, NCBI
*          Mati Shomrat
*
* File Description:
*   Keywords item for flat-file generator
*
*/
#include <corelib/ncbistd.hpp>

#include <list>

#include <objtools/format/items/item_base.hpp>


BEGIN_NCBI_SCOPE
BEGIN_SCOPE(objects)


class CBioseqContext;
class IFormatter;



///////////////////////////////////////////////////////////////////////////
//
// Keywords

class CKeywordsItem : public CFlatItem
{
public:
    // types
    typedef list<string> TKeywords;

    CKeywordsItem(CBioseqContext& ctx);
    void Format(IFormatter& formatter, IFlatTextOStream& text_os) const;

    const TKeywords& GetKeywords(void) const;

private:
    void x_GatherInfo(CBioseqContext& ctx);

    void x_AddKeyword(const string& keyword, Uint4 flags = 0);
    bool x_CheckSpecialKeyword(const string& keyword, Uint4 flags = 0) const;

    // data
    TKeywords m_Keywords;
};


END_SCOPE(objects)
END_NCBI_SCOPE


/*
* ===========================================================================
*
* $Log: keywords_item.hpp,v $
* Revision 1000.1  2004/06/01 19:39:47  gouriano
* PRODUCTION: UPGRADED [GCC34_MSVC7] Dev-tree R1.2
*
* Revision 1.2  2004/04/22 15:37:17  shomrat
* Changes in context
*
* Revision 1.1  2003/12/17 19:48:45  shomrat
* Initial revision (adapted from flat lib)
*
*
* ===========================================================================
*/


#endif  /* OBJTOOLS_FORMAT_ITEMS___KEYWORDS_ITEM__HPP */