TDbiOutRowStream Class Reference

Concept Output stream for the values of a single table row with type checking and deferred sequence number asignment. More...

#include <TDbiOutRowStream.hxx>

Inheritance diagram for TDbiOutRowStream:

[legend]

Collaboration diagram for TDbiOutRowStream:

[legend]

List of all members.

Public Member Functions
	TDbiOutRowStream (const TDbiTableMetaData *metaData)
virtual	~TDbiOutRowStream ()
Bool_t	HasGoodData () const
const string &	GetCSV () const
Bool_t	IsComplete () const
TDbiOutRowStream &	operator<< (Bool_t src)
TDbiOutRowStream &	operator<< (Char_t src)
TDbiOutRowStream &	operator<< (const Char_t *src)
TDbiOutRowStream &	operator<< (Short_t src)
TDbiOutRowStream &	operator<< (UShort_t src)
TDbiOutRowStream &	operator<< (Int_t src)
TDbiOutRowStream &	operator<< (UInt_t src)
TDbiOutRowStream &	operator<< (Float_t src)
TDbiOutRowStream &	operator<< (Double_t src)
TDbiOutRowStream &	operator<< (const string &src)
TDbiOutRowStream &	operator<< (const TVldTimeStamp &src)
void	Clear ()
virtual const TDbiFieldType &	ColFieldType (UInt_t col) const
virtual string	ColName (UInt_t col) const
virtual const TDbiFieldType &	CurColFieldType () const
virtual string	CurColName () const
virtual UInt_t	CurColNum () const
Bool_t	HasEpoch () const
Bool_t	HasRowCounter () const
Bool_t	IsVLDTable () const
virtual UInt_t	NumCols () const
virtual string	TableName () const
virtual string	TableNameTc () const
virtual const TDbiTableMetaData *	MetaData () const
virtual void	DecrementCurCol ()
virtual void	IncrementCurCol ()
Protected Member Functions
virtual void	ClearCurCol ()
Private Member Functions
void	Store (const string &str)
Bool_t	StoreDefaultIfInvalid (TDbi::DataTypes type)
Private Attributes
Bool_t	fBadData
	Set KTRUE if streamed bad data.
string	fCSV
	Comma separated list of values.
Friends
class	TDbiConfigSet

---

Detailed Description

Concept Output stream for the values of a single table row with type checking and deferred sequence number asignment.

Id

TDbiOutRowStream.hxx,v 1.1 2011/01/18 05:49:20 finch Exp

Purpose This is a helper class for TDbiSqlValPacket. Its primary purpose is to provide an << operator with built-type checking to simplify the writing of TDbiTableRow subclasses. Contact: A.Finch@lancaster.ac.uk

Definition at line 34 of file TDbiOutRowStream.hxx.

---

Constructor & Destructor Documentation

TDbiOutRowStream::TDbiOutRowStream

(

const TDbiTableMetaData *

metaData

)

TDbiOutRowStream::~TDbiOutRowStream

(

)

[virtual]

Definition at line 71 of file TDbiOutRowStream.cxx.

References SK_DBI_Trace.

                                    {
//
//
//  Purpose: Destructor


  SK_DBI_Trace( "Destroying TDbiOutRowStream" << "  ");

}

---

Member Function Documentation

void TDbiOutRowStream::Clear

(

)

[inline]

Definition at line 66 of file TDbiOutRowStream.hxx.

References TDbiRowStream::ClearCurCol(), fBadData, and fCSV.

{ fBadData = kFALSE; fCSV.erase(); ClearCurCol();}

Here is the call graph for this function:

virtual void TDbiRowStream::ClearCurCol

(

)

[inline, protected, virtual, inherited]

Definition at line 64 of file TDbiRowStream.hxx.

References TDbiRowStream::fCurCol.

Referenced by Clear(), and TDbiInRowStream::FetchRow().

{ fCurCol = 1; }

Here is the caller graph for this function:

const TDbiFieldType & TDbiRowStream::ColFieldType

(

UInt_t

col

)

const [virtual, inherited]

Definition at line 114 of file TDbiRowStream.cxx.

References TDbiTableMetaData::ColFieldType(), and TDbiRowStream::fMetaData.

                                                                 {
//
//
//  Purpose: Return specified column type, if defined
//
//  Arguments: None.

  return fMetaData->ColFieldType(col);
}

Here is the call graph for this function:

string TDbiRowStream::ColName

(

UInt_t

col

)

const [virtual, inherited]

Definition at line 125 of file TDbiRowStream.cxx.

References TDbiTableMetaData::ColName(), and TDbiRowStream::fMetaData.

Referenced by TDbiInRowStream::AsString().

                                              {
//
//
//  Purpose: Return specified column name, if defined

  return fMetaData->ColName(col);
}

Here is the call graph for this function:

Here is the caller graph for this function:

const TDbiFieldType & TDbiRowStream::CurColFieldType

(

)

const [virtual, inherited]

Definition at line 134 of file TDbiRowStream.cxx.

References TDbiTableMetaData::ColFieldType(), TDbiRowStream::fCurCol, and TDbiRowStream::fMetaData.

Referenced by TDbiConfigSet::Fill(), TDbiInRowStream::LoadCurValue(), Store(), and StoreDefaultIfInvalid().

                                                          {
//
//
//  Purpose: Return current column type, if defined
//
//  Arguments: None.
//
//  Return: Current column type, if defined. Unknown otherwise.
//
//  Contact:   N. West
//
//  Specification:-
//  =============
//
//  o Current column name, if defined. unknown otherwise.

//  Program Notes:-
//  =============

//  None.

  return fMetaData->ColFieldType(fCurCol);
}

Here is the call graph for this function:

Here is the caller graph for this function:

string TDbiRowStream::CurColName

(

)

const [virtual, inherited]

Definition at line 160 of file TDbiRowStream.cxx.

References TDbiTableMetaData::ColName(), TDbiRowStream::fCurCol, and TDbiRowStream::fMetaData.

Referenced by ClassImp(), TDbiConfigSet::Fill(), and StoreDefaultIfInvalid().

                                       {
//
//
//  Purpose: Return current column name, if defined
//
//  Arguments: None.
//
//  Return: Current column name, if defined. "Undefined" otherwise.
//
//  Contact:   N. West
//
//  Specification:-
//  =============
//
//  o Current column name, if defined. "Undefined" otherwise.

//  Program Notes:-
//  =============

//  None.

  return fMetaData->ColName(fCurCol);
}

Here is the call graph for this function:

Here is the caller graph for this function:

virtual UInt_t TDbiRowStream::CurColNum

(

)

const [inline, virtual, inherited]

Definition at line 45 of file TDbiRowStream.hxx.

References TDbiRowStream::fCurCol.

Referenced by TDbiInRowStream::AsString(), TDbiInRowStream::CurColExists(), TDbiInRowStream::CurColString(), IsComplete(), TDbiInRowStream::LoadCurValue(), Store(), and StoreDefaultIfInvalid().

{ return fCurCol;}

Here is the caller graph for this function:

virtual void TDbiRowStream::DecrementCurCol

(

)

[inline, virtual, inherited]

Definition at line 56 of file TDbiRowStream.hxx.

References TDbiRowStream::fCurCol.

Referenced by ClassImp().

                                  {
                            fCurCol = (fCurCol <= 1) ? 1 : fCurCol -1; }

Here is the caller graph for this function:

const string& TDbiOutRowStream::GetCSV

(

)

const [inline]

Definition at line 47 of file TDbiOutRowStream.hxx.

References fCSV.

Referenced by TDbiSqlValPacket::AddRow(), and TDbiSqlValPacket::Recreate().

{ return fCSV; }

Here is the caller graph for this function:

Bool_t TDbiRowStream::HasEpoch

(

)

const [inherited]

Definition at line 213 of file TDbiRowStream.cxx.

References TDbiRowStream::fMetaData, and TDbiTableMetaData::HasEpoch().

Referenced by TDbiValidityRec::Fill(), and TDbiValidityRec::Store().

                                     {
  return fMetaData->HasEpoch();
}

Here is the call graph for this function:

Here is the caller graph for this function:

Bool_t TDbiOutRowStream::HasGoodData

(

)

const [inline]

Definition at line 46 of file TDbiOutRowStream.hxx.

References fBadData, and IsComplete().

Referenced by TDbiSqlValPacket::AddRow().

{ return ! fBadData && IsComplete(); }

Here is the call graph for this function:

Here is the caller graph for this function:

Bool_t TDbiRowStream::HasRowCounter

(

)

const [inline, inherited]

Definition at line 47 of file TDbiRowStream.hxx.

References TDbiRowStream::fHasRowCounter.

{ return fHasRowCounter; }

virtual void TDbiRowStream::IncrementCurCol

(

)

[inline, virtual, inherited]

Definition at line 60 of file TDbiRowStream.hxx.

References TDbiRowStream::fCurCol.

Referenced by TDbiInRowStream::AsString(), ClassImp(), TDbiConfigSet::Fill(), and Store().

{ ++fCurCol; }

Here is the caller graph for this function:

Bool_t TDbiOutRowStream::IsComplete

(

)

const [inline]

Definition at line 48 of file TDbiOutRowStream.hxx.

References TDbiRowStream::CurColNum(), and TDbiRowStream::NumCols().

Referenced by TDbiSqlValPacket::AddRow(), and HasGoodData().

{ return CurColNum() == NumCols()+1; }

Here is the call graph for this function:

Here is the caller graph for this function:

Bool_t TDbiRowStream::IsVLDTable

(

)

const [inline, inherited]

Definition at line 48 of file TDbiRowStream.hxx.

References TDbiRowStream::fIsVLDTable.

Referenced by ClassImp().

{ return fIsVLDTable; }

Here is the caller graph for this function:

virtual const TDbiTableMetaData* TDbiRowStream::MetaData

(

)

const [inline, virtual, inherited]

Definition at line 53 of file TDbiRowStream.hxx.

References TDbiRowStream::fMetaData.

Referenced by TDbiInRowStream::AsString(), and TDbiInRowStream::RowAsCsv().

{ return fMetaData; }

Here is the caller graph for this function:

UInt_t TDbiRowStream::NumCols

(

)

const [virtual, inherited]

Definition at line 186 of file TDbiRowStream.cxx.

References TDbiRowStream::fMetaData, and TDbiTableMetaData::NumCols().

Referenced by TDbiInRowStream::CurColExists(), TDbiConfigSet::Fill(), IsComplete(), and TDbiInRowStream::RowAsCsv().

                                    {
//
//
//  Purpose: Return the number of columns.
//
//  Arguments: None.
//
//  Return: the number of columns
//
//  Contact:   N. West
//
//  Specification:-
//  =============
//
//  o Return the number of columns.

//  Program Notes:-
//  =============

//  None.

  return fMetaData->NumCols();

}

Here is the call graph for this function:

Here is the caller graph for this function:

TDbiOutRowStream & TDbiOutRowStream::operator<<

(

const TVldTimeStamp &

src

)

Definition at line 113 of file TDbiOutRowStream.cxx.

References TDbi::kDate, TDbi::MakeDateTimeString(), Store(), and StoreDefaultIfInvalid().

                                                                       {
  if ( ! StoreDefaultIfInvalid(TDbi::kDate) )
                          Store(TDbi::MakeDateTimeString(src).c_str());
  return *this;
}

Here is the call graph for this function:

TDbiOutRowStream & TDbiOutRowStream::operator<<

(

const string &

src

)

Definition at line 110 of file TDbiOutRowStream.cxx.

References TDbi::kString, and OUT.

                                                                {
                                    OUT(TDbi::kString,src); return *this;}

TDbiOutRowStream & TDbiOutRowStream::operator<<

(

Double_t

src

)

Definition at line 107 of file TDbiOutRowStream.cxx.

References TDbi::kDouble, and OUT.

                                                           {
                                     OUT(TDbi::kDouble,src);  return *this;}

TDbiOutRowStream & TDbiOutRowStream::operator<<

(

Float_t

src

)

Definition at line 104 of file TDbiOutRowStream.cxx.

References TDbi::kFloat, and OUT.

                                                          {
                                     OUT(TDbi::kFloat,src); return *this;}

TDbiOutRowStream & TDbiOutRowStream::operator<<

(

UInt_t

src

)

Definition at line 101 of file TDbiOutRowStream.cxx.

References TDbi::kUInt, and OUT2.

                                                         {
                                     OUT2(TDbi::kUInt,src);  return *this;}

TDbiOutRowStream & TDbiOutRowStream::operator<<

(

Int_t

src

)

Definition at line 98 of file TDbiOutRowStream.cxx.

References TDbi::kInt, and OUT.

                                                        {
                                     OUT(TDbi::kInt,src);  return *this;}

TDbiOutRowStream & TDbiOutRowStream::operator<<

(

UShort_t

src

)

Definition at line 95 of file TDbiOutRowStream.cxx.

References TDbi::kUShort, and OUT2.

                                                           {
                                     OUT2(TDbi::kUShort,src); return *this;}

TDbiOutRowStream & TDbiOutRowStream::operator<<

(

Short_t

src

)

Definition at line 92 of file TDbiOutRowStream.cxx.

References TDbi::kShort, and OUT.

                                                          {
                                     OUT(TDbi::kShort,src);  return *this;}

TDbiOutRowStream & TDbiOutRowStream::operator<<

(

const Char_t *

src

)

Definition at line 89 of file TDbiOutRowStream.cxx.

References TDbi::kString, and OUT.

                                                                {
                                     OUT(TDbi::kString,src);  return *this;}

TDbiOutRowStream & TDbiOutRowStream::operator<<

(

Char_t

src

)

Definition at line 86 of file TDbiOutRowStream.cxx.

References TDbi::kChar, and OUT.

                                                         {
                                     OUT(TDbi::kChar,src);  return *this;}

TDbiOutRowStream & TDbiOutRowStream::operator<<

(

Bool_t

src

)

Definition at line 83 of file TDbiOutRowStream.cxx.

References TDbi::kBool, and OUT.

                                                         {
                                     OUT(TDbi::kBool,src);  return *this;}

void TDbiOutRowStream::Store

(

const string &

str

)

[private]

Definition at line 167 of file TDbiOutRowStream.cxx.

References TDbiRowStream::CurColFieldType(), TDbiRowStream::CurColNum(), fCSV, TDbiFieldType::GetConcept(), TDbiRowStream::IncrementCurCol(), TDbi::kChar, TDbi::kDate, TDbi::kString, and UtilString::MakePrintable().

Referenced by operator<<(), TDbiConfigSet::Store(), and StoreDefaultIfInvalid().

                                               {
//
//
//  Purpose: Store string value as comma separated values but exclude SeqNo.
//
//  Arguments:
//    str          in    Value to be stored.
//
//  Return:
//
//  Contact:   N. West
//
//  Specification:-
//  =============
//
//  o Store string value in CSV with separator from
//    previous value and increment fNumValues.  If required
//    enclose value in quotes. If storing the SeqNo column then
//    store a single '?' instead which will be replace during
//    SQL generation - see

//  Program Notes:-
//  =============

//  None.

  UInt_t concept = CurColFieldType().GetConcept();
  string delim = "";
  if (    concept == TDbi::kString
       || concept == TDbi::kDate
       || concept == TDbi::kChar ) delim = "\'";

  if ( CurColNum()> 1 ) fCSV += ',';
  fCSV += delim;
  if ( concept != TDbi::kString ) fCSV += str;
//  When exporting strings, take care of special characters.
  else {
    UtilString::MakePrintable(str.c_str(),fCSV);
  }
  fCSV += delim;
  IncrementCurCol();
}

Here is the call graph for this function:

Here is the caller graph for this function:

Bool_t TDbiOutRowStream::StoreDefaultIfInvalid

(

TDbi::DataTypes

type

)

[private]

Definition at line 124 of file TDbiOutRowStream.cxx.

References TDbiFieldType::AsString(), TDbiRowStream::CurColFieldType(), TDbiRowStream::CurColName(), TDbiRowStream::CurColNum(), fBadData, TDbiFieldType::IsCompatible(), SK_DBI_Severe, Store(), TDbiRowStream::TableNameTc(), and TDbiFieldType::UndefinedValue().

Referenced by operator<<().

                                                                 {
//
//
//  Purpose:  Store default value if illegal type supplied.
//
//  Arguments:
//    type         in    Type of supplied value.
//
//  Return:    kTRUE if illegal type supplied.
//
//  Contact:   N. West
//
//  Specification:-
//  =============
//
//  o If type of supplied value is incompatible with current column
//    type store default value, report error and return kTRUE, otherwise
//    return kFALSE.

//  Program Notes:-
//  =============

//  None.

  TDbiFieldType typeSupplied(type);
  TDbiFieldType typeRequired(CurColFieldType());
  if ( typeSupplied.IsCompatible(typeRequired) ) return kFALSE;

  string udef = typeRequired.UndefinedValue();
     SK_DBI_Severe(  "In table " << TableNameTc()
      << " column "<< CurColNum()
      << " (" << CurColName() << ")"
      << " of type " << typeRequired.AsString()
      << " is incompatible with user type " << typeSupplied.AsString()
      << ", value \"" << udef
      << "\" will be substituted." <<  "  ");
  Store(udef.c_str());
  fBadData = kTRUE;
  return kTRUE;

}

Here is the call graph for this function:

Here is the caller graph for this function:

string TDbiRowStream::TableName

(

)

const [virtual, inherited]

Definition at line 219 of file TDbiRowStream.cxx.

References TDbiRowStream::fMetaData, TDbiTableMetaData::TableName(), and UtilString::ToUpper().

                                      {
//
//
//  Purpose: Return table name in upper case.
//

  return UtilString::ToUpper(fMetaData->TableName());
}

Here is the call graph for this function:

string TDbiRowStream::TableNameTc

(

)

const [virtual, inherited]

Definition at line 230 of file TDbiRowStream.cxx.

References TDbiRowStream::fMetaData, and TDbiTableMetaData::TableName().

Referenced by TDbiInRowStream::AsString(), TDbiInRowStream::CurColExists(), StoreDefaultIfInvalid(), and TDbiResultSet::TDbiResultSet().

                                        {
//
//
//  Purpose: Return table name in true case.

  return fMetaData->TableName();
}

Here is the call graph for this function:

Here is the caller graph for this function:

---

Friends And Related Function Documentation

friend class TDbiConfigSet [friend]

Definition at line 37 of file TDbiOutRowStream.hxx.

---

Member Data Documentation

Bool_t TDbiOutRowStream::fBadData [private]

Set KTRUE if streamed bad data.

Definition at line 79 of file TDbiOutRowStream.hxx.

Referenced by Clear(), HasGoodData(), and StoreDefaultIfInvalid().

string TDbiOutRowStream::fCSV [private]

Comma separated list of values.

Definition at line 82 of file TDbiOutRowStream.hxx.

Referenced by Clear(), GetCSV(), and Store().

---

The documentation for this class was generated from the following files:

• src/TDbiOutRowStream.hxx
• src/TDbiOutRowStream.cxx