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

Search Toolkit Book for CSeqDB_TitleWalker

Walker for TITLE field of alias file. More...

+ Inheritance diagram for CSeqDB_TitleWalker:
+ Collaboration diagram for CSeqDB_TitleWalker:

Public Member Functions

virtual const char * GetFileKey () const
 This provides the alias file key used for this field. More...
 
virtual void Accumulate (const CSeqDBVol &vol)
 Collect data from a volume. More...
 
virtual void AddString (const string &value)
 Collect data from an alias file. More...
 
string GetTitle ()
 Returns the database title string. More...
 
- Public Member Functions inherited from CSeqDB_AliasWalker
virtual ~CSeqDB_AliasWalker ()
 Destructor. More...
 

Private Attributes

string m_Value
 The title string we are accumulating. More...
 

Detailed Description

Walker for TITLE field of alias file.

The TITLE field of the alias file is a string describing the set of sequences collected by that file. The title is reported via the "CSeqDB::GetTitle()" method.

Definition at line 991 of file seqdbalias.cpp.

Member Function Documentation

◆ Accumulate()

virtual void CSeqDB_TitleWalker::Accumulate ( const CSeqDBVol vol)
inlinevirtual

Collect data from a volume.

If the TITLE field is not specified in an alias file, we can use the title(s) in the database volume(s). Values from alias node tree siblings are concatenated with "; " used as a delimiter.

Parameters
volA database volume

Implements CSeqDB_AliasWalker.

Definition at line 1008 of file seqdbalias.cpp.

References AddString(), and CSeqDBVol::GetTitle().

◆ AddString()

virtual void CSeqDB_TitleWalker::AddString ( const string value)
inlinevirtual

Collect data from an alias file.

If the TITLE field is specified in an alias file, it will be used unmodified. Values from alias node tree siblings are concatenated with "; " used as a delimiter.

Parameters
valueA database volume

Implements CSeqDB_AliasWalker.

Definition at line 1021 of file seqdbalias.cpp.

References m_Value, SeqDB_JoinDelim(), and value.

Referenced by Accumulate().

◆ GetFileKey()

virtual const char* CSeqDB_TitleWalker::GetFileKey ( ) const
inlinevirtual

This provides the alias file key used for this field.

Implements CSeqDB_AliasWalker.

Definition at line 994 of file seqdbalias.cpp.

◆ GetTitle()

string CSeqDB_TitleWalker::GetTitle ( void  )
inline

Returns the database title string.

Definition at line 1027 of file seqdbalias.cpp.

References m_Value.

Referenced by CSeqDBAliasNode::GetTitle().

Member Data Documentation

◆ m_Value

string CSeqDB_TitleWalker::m_Value
private

The title string we are accumulating.

Definition at line 1034 of file seqdbalias.cpp.

Referenced by AddString(), and GetTitle().


The documentation for this class was generated from the following file:
Modified on Thu Feb 22 17:12:43 2024 by modify_doxy.py rev. 669887