STK_ReadWriteCsv.h

Go to the documentation of this file.

/*--------------------------------------------------------------------*/
/*     Copyright (C) 2004-2007  Serge Iovleff

    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU Lesser General Public License as
    published by the Free Software Foundation; either version 2 of the
    License, or (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU Lesser General Public License for more details.

    You should have received a copy of the GNU Lesser General Public
    License along with this program; if not, write to the
    Free Software Foundation, Inc.,
    59 Temple Place,
    Suite 330,
    Boston, MA 02111-1307
    USA

    Contact : Serge.Iovleff@stkpp.org
*/

/*
 * Project:  stkpp::DManager
 * Purpose:  Declaration of the class ReaWriteCsv.
 * Author:   Serge Iovleff, serge.iovleff@stkpp.org
 *
 **/

#ifndef READWRITECSV_H
#define READWRITECSV_H

#include "STK_Variable.h"
#include "../../Arrays/include/STK_Array1D.h"

namespace STK
{

namespace Csv
{
  static const Integer   DEFAULT_RESERVE    = Integer(0x0FFFF);

  static const Char* DEFAULT_DELIMITER  =     _T(",");

  enum readflags
  {
    RF_APPEND_DATA    = 0x00000004,
    RF_REPLACE_DATA   = 0x00000008
  };
}


class ReadWriteCsv
{
  public:
    ReadWriteCsv(bool read_names = true);

    ReadWriteCsv( std::string const& file_name
                , bool read_names = true
                , String const& delimiter = Csv::DEFAULT_DELIMITER
                , Integer const&  reserve   = Csv::DEFAULT_RESERVE
                );

    ReadWriteCsv(ReadWriteCsv const& df);

    ~ReadWriteCsv();

    void clear();

    inline Integer first() const
    { return str_data_.first(); }

    inline Integer last() const
    { return str_data_.last(); }

    inline Integer size() const
    { return str_data_.size(); }

     inline Integer firstVe( Integer const& icol) const
     { return str_data_.at(icol).first();}

     inline Integer lastVe( Integer const& icol) const
     { return str_data_.at(icol).last();}

    inline Integer sizeVe( Integer const& icol) const
    { return str_data_.at(icol).size();}

    Integer firstVe() const;

    Integer lastVe() const;

    inline String const& error() const
    { return msg_error_; }

    inline Variable<String>& at(Integer icol)
    { return str_data_.at(icol); }

    inline const Variable<String>& at(Integer icol) const
    { return str_data_.at(icol); }

    inline Variable<String>& operator[](Integer const& icol)
    { return str_data_.at(icol); }

    inline const Variable<String>& operator[](Integer const& icol) const
    { return str_data_.at(icol); }

    inline Variable<String>& front()
    { return str_data_.at(first());}

    inline const Variable<String>& front() const
    { return str_data_.at(first());}

    inline Variable<String>& back()
    { return str_data_.at(last());}

    inline const Variable<String>& back() const
    { return str_data_.at(last());}

    bool read();

    bool push_back(const Variable<String>& data = Variable<String>());

    bool push_front(const Variable<String>& data = Variable<String>());

    Integer colIndex( const String  &variable_name
                    , Integer const& iStartingIndex = 0) const;

    Integer colIndex( String const& variable_name
                    , std::string const& sourceFilename
                    , Integer const& iStartingIndex = 0) const;

    Integer name( Integer const& icol, String& rStr) const;

    bool setName( Integer const& icol, String const& name);

    Integer data( Integer const& icol, Integer const& irow, String &lpStr) const;

    Integer data( String const& variable_name, Integer const& irow, String &lpStr) const;

    Integer data( Integer const& icol, Variable<String>& rVector) const;

    Integer data( String const& variable_name, Variable<String>& rVector) const;

    inline void setDelimiters( String const& delimiters) const
    { delimiter_ = delimiters; }

    inline void setWithNames( bool with_names = true) const
    { with_names_ = with_names; }

    inline void setReserve(Integer const& reserve) const
    { reserve_ = reserve; }

    bool setData( Integer const& icol, Integer const& irow, String const& value);

    bool appendData( Integer const& icol, String const& value);

    bool appendData( Integer const& icol, const Variable<String>& data);

    bool eraseColumn(Integer const& icol);

    bool read(std::string const& file_name);

    ReadWriteCsv& operator=( ReadWriteCsv const& df);

    ReadWriteCsv& operator+=( ReadWriteCsv const& df);

    ReadWriteCsv operator+( ReadWriteCsv const& df) const;

    bool write( std::string const& file_name) const;

    void write( ostream& os) const;

    void writeSelection( ostream& os
                       , Integer const& top
                       , Integer const& bottom
                       , Integer const& left
                       , Integer const& right
                       ) const;

    inline String& operator()( Integer const& icol, Integer const& irow)
    { return str_data_.at(icol).at(irow);}

    inline String const& operator()( Integer const& icol
                                   , Integer const& irow) const
    { return str_data_.at(icol).at(irow);}

  protected:
    mutable std::string  file_name_;
    mutable bool with_names_;
    mutable String  delimiter_;
    mutable Integer reserve_;
    mutable String msg_error_;

    Array1D<std::string> source_file_names_;
    Array1D< Variable<String> > str_data_;

    Integer lookupVariableIndex( String const& name
                               , Integer const& offset=0) const;

    Integer largestNumberOfRows() const;

    // friend operators
    friend istream& operator>>( istream& is, ReadWriteCsv& df);
    friend ostream& operator<<( ostream& os, ReadWriteCsv const& df);
};

istream& operator>>( istream& is, ReadWriteCsv& df);

ostream& operator<<( ostream& os, ReadWriteCsv const& df);

} // Namespace STK

#endif // READWRITECSV_H