NCBI C++ ToolKit
Public Types | Public Member Functions | Static Public Member Functions | Static Private Member Functions | Static Private Attributes | List of all members
CCdDbPriority Class Reference

Search Toolkit Book for CCdDbPriority

#include <algo/structure/cd_utils/cuDbPriority.hpp>

+ Collaboration diagram for CCdDbPriority:

Public Types

enum  {
  eTopTier = 0 , eTier1 = 1 , eTier2 = 2 , eTier3 = 3 ,
  eTier4 = 4 , eBottomTier
}
 
enum  EDbSource {
  eDPGi = 0 , eDPPdb = 1 , eDPSwissprot = 2 , eDPGenbank = 3 ,
  eDPEmbl = 4 , eDPDdbj = 5 , eDPPrf = 6 , eDPPir = 7 ,
  eDPGeneral = 8 , eDPRefSeqAny = 10 , eDPRefSeqCurated = 11 , eDPRefSeqNP = 12 ,
  eDPRefSeqAP = 13 , eDPRefSeqAutomated = 15 , eDPRefSeqXP = 16 , eDPRefSeqYP = 17 ,
  eDPRefSeqWP = 18 , eDPRefSeqZP = 19 , eDPLocal = 20 , eDPUnsupported = 99 ,
  eDPGibbsq = 100 , eDPGibbmt = 101 , eDPGiim = 102 , eDPPatent = 103 ,
  eDPTPGenbank = 104 , eDPTPEmbl = 105 , eDPTPDdbj = 106 , eDPGpipe = 107 ,
  eDPUnknown = 999
}
 
typedef unsigned int TDbPriority
 
typedef map< EDbSource, TDbPriority > TSourcePriorityMap
 
typedef TSourcePriorityMap::iterator TSourcePriorityIt
 
typedef TSourcePriorityMap::value_type TSourcePriorityVT
 
typedef multimap< EDbSource, string > TSourceNameMap
 
typedef TSourceNameMap::value_type TSourceNameVT
 
typedef map< string, EDbSource > TNameSourceMap
 

Public Member Functions

 CCdDbPriority ()
 
 ~CCdDbPriority ()
 

Static Public Member Functions

static int CompareSources (const string &source1, const string &source2)
 
static string GetSourceName (EDbSource priority)
 
static unsigned int GetSourceNames (EDbSource priority, vector< string > &names)
 
static bool IsKnownDbSource (string dbSource)
 
static TDbPriority GetPriority (string dbSource)
 
static bool IsSupported (string dbSource)
 
static string SeqIdTypeToSource (unsigned int seqIdType, string accession=kEmptyStr)
 
static TDbPriority SeqIdTypeToPriority (unsigned int seqIdType, string accession=kEmptyStr)
 

Static Private Member Functions

static void Initialize ()
 
static EDbSource GetSourceCode (string dbSource)
 
static EDbSource SeqIdTypeToSourceCode (unsigned int seqIdType, string accession=kEmptyStr)
 

Static Private Attributes

static CSafeStatic< TSourcePriorityMap > m_sourcePriorityMap
 
static CSafeStatic< TSourceNameMap > m_sourceNameMap
 
static CSafeStatic< TNameSourceMap > m_nameSourceMap
 

Detailed Description

Definition at line 48 of file cuDbPriority.hpp.

Member Typedef Documentation

◆ TDbPriority

typedef unsigned int CCdDbPriority::TDbPriority

Definition at line 112 of file cuDbPriority.hpp.

◆ TNameSourceMap

typedef map<string, EDbSource> CCdDbPriority::TNameSourceMap

Definition at line 121 of file cuDbPriority.hpp.

◆ TSourceNameMap

typedef multimap<EDbSource, string> CCdDbPriority::TSourceNameMap

Definition at line 119 of file cuDbPriority.hpp.

◆ TSourceNameVT

typedef TSourceNameMap::value_type CCdDbPriority::TSourceNameVT

Definition at line 120 of file cuDbPriority.hpp.

◆ TSourcePriorityIt

typedef TSourcePriorityMap::iterator CCdDbPriority::TSourcePriorityIt

Definition at line 114 of file cuDbPriority.hpp.

◆ TSourcePriorityMap

typedef map<EDbSource, TDbPriority> CCdDbPriority::TSourcePriorityMap

Definition at line 113 of file cuDbPriority.hpp.

◆ TSourcePriorityVT

typedef TSourcePriorityMap::value_type CCdDbPriority::TSourcePriorityVT

Definition at line 115 of file cuDbPriority.hpp.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
eTopTier 
eTier1 
eTier2 
eTier3 
eTier4 
eBottomTier 

Definition at line 54 of file cuDbPriority.hpp.

◆ EDbSource

enum CCdDbPriority::EDbSource
Enumerator
eDPGi 
eDPPdb 
eDPSwissprot 
eDPGenbank 
eDPEmbl 
eDPDdbj 
eDPPrf 
eDPPir 
eDPGeneral 
eDPRefSeqAny 
eDPRefSeqCurated 
eDPRefSeqNP 
eDPRefSeqAP 
eDPRefSeqAutomated 
eDPRefSeqXP 
eDPRefSeqYP 
eDPRefSeqWP 
eDPRefSeqZP 
eDPLocal 
eDPUnsupported 
eDPGibbsq 
eDPGibbmt 
eDPGiim 
eDPPatent 
eDPTPGenbank 
eDPTPEmbl 
eDPTPDdbj 
eDPGpipe 
eDPUnknown 

Definition at line 70 of file cuDbPriority.hpp.

Constructor & Destructor Documentation

◆ CCdDbPriority()

CCdDbPriority::CCdDbPriority ( )
inline

Definition at line 123 of file cuDbPriority.hpp.

◆ ~CCdDbPriority()

CCdDbPriority::~CCdDbPriority ( )
inline

Definition at line 124 of file cuDbPriority.hpp.

Member Function Documentation

◆ CompareSources()

int CCdDbPriority::CompareSources ( const string &  source1,
const string &  source2 
)
static

Definition at line 327 of file cuDbPriority.cpp.

References GetPriority().

◆ GetPriority()

CCdDbPriority::TDbPriority CCdDbPriority::GetPriority ( string  dbSource)
static

Definition at line 312 of file cuDbPriority.cpp.

References eBottomTier, GetSourceCode(), Initialize(), and m_sourcePriorityMap.

Referenced by CompareSources().

◆ GetSourceCode()

CCdDbPriority::EDbSource CCdDbPriority::GetSourceCode ( string  dbSource)
staticprivate

Definition at line 321 of file cuDbPriority.cpp.

References eDPUnknown, and m_nameSourceMap.

Referenced by GetPriority().

◆ GetSourceName()

string CCdDbPriority::GetSourceName ( EDbSource  priority)
static

Definition at line 274 of file cuDbPriority.cpp.

References eDPUnknown, Initialize(), and m_sourceNameMap.

Referenced by GetAccessionAndDatabaseSource(), and SeqIdTypeToSource().

◆ GetSourceNames()

unsigned int CCdDbPriority::GetSourceNames ( EDbSource  priority,
vector< string > &  names 
)
static

Definition at line 290 of file cuDbPriority.cpp.

References SStaticPair< FirstType, SecondType >::first, Initialize(), m_sourceNameMap, names, and SStaticPair< FirstType, SecondType >::second.

◆ Initialize()

void CCdDbPriority::Initialize ( )
staticprivate

Definition at line 48 of file cuDbPriority.cpp.

References eBottomTier, eDPDdbj, eDPEmbl, eDPGenbank, eDPGeneral, eDPGi, eDPGibbmt, eDPGibbsq, eDPGiim, eDPGpipe, eDPLocal, eDPPatent, eDPPdb, eDPPir, eDPPrf, eDPRefSeqAny, eDPRefSeqAP, eDPRefSeqAutomated, eDPRefSeqCurated, eDPRefSeqNP, eDPRefSeqWP, eDPRefSeqXP, eDPRefSeqYP, eDPRefSeqZP, eDPSwissprot, eDPTPDdbj, eDPTPEmbl, eDPTPGenbank, eDPUnknown, eDPUnsupported, eTier1, eTier2, eTier3, eTier4, eTopTier, m_nameSourceMap, m_sourceNameMap, and m_sourcePriorityMap.

Referenced by GetPriority(), GetSourceName(), GetSourceNames(), and IsKnownDbSource().

◆ IsKnownDbSource()

bool CCdDbPriority::IsKnownDbSource ( string  dbSource)
static

Definition at line 305 of file cuDbPriority.cpp.

References Initialize(), and m_nameSourceMap.

◆ IsSupported()

static bool CCdDbPriority::IsSupported ( string  dbSource)
inlinestatic

Definition at line 137 of file cuDbPriority.hpp.

◆ SeqIdTypeToPriority()

CCdDbPriority::TDbPriority CCdDbPriority::SeqIdTypeToPriority ( unsigned int  seqIdType,
string  accession = kEmptyStr 
)
static

Definition at line 267 of file cuDbPriority.cpp.

References eBottomTier, m_sourcePriorityMap, and SeqIdTypeToSourceCode().

◆ SeqIdTypeToSource()

string CCdDbPriority::SeqIdTypeToSource ( unsigned int  seqIdType,
string  accession = kEmptyStr 
)
static

Definition at line 261 of file cuDbPriority.cpp.

References GetSourceName(), and SeqIdTypeToSourceCode().

Referenced by GetAccessionAndDatabaseSource().

◆ SeqIdTypeToSourceCode()

CCdDbPriority::EDbSource CCdDbPriority::SeqIdTypeToSourceCode ( unsigned int  seqIdType,
string  accession = kEmptyStr 
)
staticprivate

Definition at line 148 of file cuDbPriority.cpp.

References NStr::CompareNocase(), eDPDdbj, eDPEmbl, eDPGenbank, eDPGeneral, eDPGi, eDPGibbmt, eDPGibbsq, eDPGiim, eDPGpipe, eDPLocal, eDPPatent, eDPPdb, eDPPir, eDPPrf, eDPRefSeqAny, eDPRefSeqAP, eDPRefSeqCurated, eDPRefSeqNP, eDPRefSeqWP, eDPRefSeqXP, eDPRefSeqYP, eDPRefSeqZP, eDPSwissprot, eDPTPDdbj, eDPTPEmbl, eDPTPGenbank, and eDPUnknown.

Referenced by SeqIdTypeToPriority(), and SeqIdTypeToSource().

Member Data Documentation

◆ m_nameSourceMap

CSafeStatic< CCdDbPriority::TNameSourceMap > CCdDbPriority::m_nameSourceMap
staticprivate

Definition at line 153 of file cuDbPriority.hpp.

Referenced by GetSourceCode(), Initialize(), and IsKnownDbSource().

◆ m_sourceNameMap

CSafeStatic< CCdDbPriority::TSourceNameMap > CCdDbPriority::m_sourceNameMap
staticprivate

Definition at line 152 of file cuDbPriority.hpp.

Referenced by GetSourceName(), GetSourceNames(), and Initialize().

◆ m_sourcePriorityMap

CSafeStatic< CCdDbPriority::TSourcePriorityMap > CCdDbPriority::m_sourcePriorityMap
staticprivate

Definition at line 151 of file cuDbPriority.hpp.

Referenced by GetPriority(), Initialize(), and SeqIdTypeToPriority().

The documentation for this class was generated from the following files:
Generated by doxygen 1.9.0
Modified on Fri Sep 20 14:56:59 2024 by modify_doxy.py rev. 669887