File: CommandStudyMetaDataFileValidate.cxx

package info (click to toggle)
caret 5.6.1.3~dfsg.1-4
  • links: PTS, VCS
  • area: main
  • in suites: squeeze
  • size: 23,352 kB
  • ctags: 27,394
  • sloc: cpp: 363,314; python: 6,718; ansic: 5,507; makefile: 227; sh: 9
file content (132 lines) | stat: -rw-r--r-- 4,167 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
/*LICENSE_START*/
/*
 *  Copyright 1995-2002 Washington University School of Medicine
 *
 *  http://brainmap.wustl.edu
 *
 *  This file is part of CARET.
 *
 *  CARET is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2 of the License, or
 *  (at your option) any later version.
 *
 *  CARET 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 General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with CARET; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 */
/*LICENSE_END*/

#include <iostream>

#include "CommandStudyMetaDataFileValidate.h"
#include "FileFilters.h"
#include "ProgramParameters.h"
#include "ScriptBuilderParameters.h"
#include "StudyMetaDataFile.h"
#include "TextFile.h"

/**
 * constructor.
 */
CommandStudyMetaDataFileValidate::CommandStudyMetaDataFileValidate()
   : CommandBase("-study-metadata-file-validate",
                 "STUDY METADATA FILE VALIDATION")
{
}

/**
 * destructor.
 */
CommandStudyMetaDataFileValidate::~CommandStudyMetaDataFileValidate()
{
}

/**
 * get the script builder parameters.
 */
void 
CommandStudyMetaDataFileValidate::getScriptBuilderParameters(ScriptBuilderParameters& paramsOut) const
{                     
   paramsOut.clear();

   paramsOut.addFile("Study Metadata File", FileFilters::getStudyMetaDataFileFilter());
   paramsOut.addVariableListOfParameters("Output Text File Name");
}

/**
 * get full help information.
 */
QString 
CommandStudyMetaDataFileValidate::getHelpInformation() const
{
   QString helpInfo =
      (indent3 + getShortDescription() + "\n"
       + indent6 + parameters->getProgramNameWithoutPath() + " " + getOperationSwitch() + "  \n"
       + indent9 + "<input-study-metatdata-file>\n"
       + indent9 + "[-output  output-text-file]\n"
       + indent9 + "\n"
       + indent9 + "Validate a study metadata file by searching for missing \n"
       + indent9 + "or duplicate PubMed ID's or Study Names, missing figure \n"
       + indent9 + "numbers, figure panel numbers, page reference numbers, \n"
       + indent9 + "page reference subheader numbers or short names, table\n"
       + indent9 + "numbers, and table subheader numbers or short names.\n"
       + indent9 + "\n"
       + indent9 + "If there are any errors, they are written to the output\n"
       + indent9 + "text file if it is provided.  Otherwise, results are \n"
       + indent9 + "written to the terminal.\n"
       + indent9 + "\n");
      
   return helpInfo;
}

/**
 * execute the command.
 */
void 
CommandStudyMetaDataFileValidate::executeCommand() throw (BrainModelAlgorithmException,
                                     CommandException,
                                     FileException,
                                     ProgramParametersException,
                                     StatisticException)
{
   const QString studyFileName =
      parameters->getNextParameterAsString("Input Study Metadata File");
   QString textFileName;
   while (parameters->getParametersAvailable()) {
      QString paramName = parameters->getNextParameterAsString("Opt Param");
      if (paramName == "-output") {
         textFileName = parameters->getNextParameterAsString("Text File Name");
      }
      else {
         throw CommandException("Unexpected Parameter: " + paramName);
      }
   }
   
   StudyMetaDataFile smdf;
   smdf.readFile(studyFileName);
   QStringList sl = smdf.validStudyMetaDataFile();
   if (sl.count() <= 0) {
      std::cout << "No study problems were found." << std::endl;
   }
   else {
      const QString msg(sl.join("\n"));
      if (textFileName.isEmpty() == false) {
         TextFile tf;
         tf.setText(msg);
         tf.writeFile(textFileName);
      }
      else {
         std::cout << msg.toAscii().constData() << std::endl;
      }
   }
}