1 /****************************************************************************
3 ** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
4 ** Contact: http://www.qt-project.org/
6 ** This file is part of the test suite of the Qt Toolkit.
8 ** $QT_BEGIN_LICENSE:LGPL$
9 ** GNU Lesser General Public License Usage
10 ** This file may be used under the terms of the GNU Lesser General Public
11 ** License version 2.1 as published by the Free Software Foundation and
12 ** appearing in the file LICENSE.LGPL included in the packaging of this
13 ** file. Please review the following information to ensure the GNU Lesser
14 ** General Public License version 2.1 requirements will be met:
15 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
17 ** In addition, as a special exception, Nokia gives you certain additional
18 ** rights. These rights are described in the Nokia Qt LGPL Exception
19 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
21 ** GNU General Public License Usage
22 ** Alternatively, this file may be used under the terms of the GNU General
23 ** Public License version 3.0 as published by the Free Software Foundation
24 ** and appearing in the file LICENSE.GPL included in the packaging of this
25 ** file. Please review the following information to ensure the GNU General
26 ** Public License version 3.0 requirements will be met:
27 ** http://www.gnu.org/copyleft/gpl.html.
30 ** Alternatively, this file may be used in accordance with the terms and
31 ** conditions contained in a signed written agreement between you and Nokia.
40 ****************************************************************************/
42 #ifndef PatternistSDK_TestItem_H
43 #define PatternistSDK_TestItem_H
45 #include "TestResult.h"
52 template<typename A, typename B> struct QPair;
54 namespace QPatternistSDK
60 * @short base class for all classes which
61 * represent an element in an XQuery Test Suite catalog.
63 * @ingroup PatternistSDK
64 * @author Frans Englich <frans.englich@nokia.com>
66 class Q_PATTERNISTSDK_EXPORT TestItem : public TreeItem
71 * Determines how far an test case execution should go.
76 * The query will not be run. It will only go through the (whole) compilation stage.
81 * The query will be compiled and run, as ordinary.
87 * Represents a summary of test results for a collection
88 * of tests. QPair::first contains the amount of
89 * passed tests; QPair::second contains the count of
90 * all tests. For example TestCase::summary() returns
91 * ResultSummary(0, 1) or ResultSummary(1, 1) depending
92 * on whether the TestCase have succeeded or not.
94 typedef QPair<int, int> ResultSummary;
97 * Executes the test case(s) this TestItem represents,
98 * and return the TestResult. For example, the TestGroup
99 * returns the result of its children concatenated, while
100 * TestCase always returns a list containing one
101 * TestResult(what it evaluated to).
103 virtual TestResult::List execute(const ExecutionStage stage,
107 * @todo Rename this function. Perhaps create a type() hierarchy
110 virtual bool isFinalNode() const = 0;
113 * @returns a ResultSummary for this TestItem.
115 virtual ResultSummary resultSummary() const = 0;
118 * Serializes into the corresponding elements attributes
119 * specified in XQTSCatalog.xsd.
121 * @note Sub-classes must assume the XQTSCatalog namespace
122 * is the default namespace, and not add any namespace declarations.
124 //virtual void toXML(XMLWriter &receiver) const = 0;
133 // vim: et:ts=4:sw=4:sts=4