Tulip  5.2.1
Large graphs analysis and drawing
CSVContentHandler.h
1 /*
2  *
3  * This file is part of Tulip (http://tulip.labri.fr)
4  *
5  * Authors: David Auber and the Tulip development Team
6  * from LaBRI, University of Bordeaux
7  *
8  * Tulip is free software; you can redistribute it and/or modify
9  * it under the terms of the GNU Lesser General Public License
10  * as published by the Free Software Foundation, either version 3
11  * of the License, or (at your option) any later version.
12  *
13  * Tulip is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
16  * See the GNU General Public License for more details.
17  *
18  */
19 ///@cond DOXYGEN_HIDDEN
20 #ifndef CSVCONTENTHANDLER_H_
21 #define CSVCONTENTHANDLER_H_
22 
23 #include <string>
24 #include <vector>
25 
26 #include <tulip/tulipconf.h>
27 
28 namespace tlp {
29 /**
30  * @brief Interface to inherit to get and treat data from csv files with CSVParser object.
31  */
32 class TLP_QT_SCOPE CSVContentHandler {
33 public:
34  virtual ~CSVContentHandler() {}
35  /**
36  * Function called at the beginning of the file parsing.
37  */
38  virtual bool begin() = 0;
39 
40  /**
41  * Function called for each line in the file.
42  * @param row The number of the row.
43  * @param lineTokens The tokens.
44  */
45  virtual bool line(unsigned int row, const std::vector<std::string> &lineTokens) = 0;
46 
47  /**
48  * Function called at the end of the parsing.
49  * @param rowNumber the number of row read in the file.
50  * @param columnNumber The column number for the line with the greatest column number.
51  */
52  virtual bool end(unsigned int rowNumber, unsigned int columnNumber) = 0;
53 };
54 } // namespace tlp
55 #endif /* CSVCONTENTHANDLER_H_ */
56 ///@endcond