9859858140

Committed 09 Jul 2024 03:24PM UTC coverage: 56.679% (-0.2%) from 56.916%

Build # 9859858140

Build Type

push

github

Committed by

JFriel

Commit Message

update

Run Details

10912 of 20750 branches covered (52.59%)

Branch coverage included in aggregate %.

30965 of 53135 relevant lines covered (58.28%)

7908.05 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

45.95

/Rdmp.Core/QueryBuilding/AggregateCountColumn.cs

// Copyright (c) The University of Dundee 2018-2019
// This file is part of the Research Data Management Platform (RDMP).
// RDMP 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 3 of the License, or (at your option) any later version.
// RDMP 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 RDMP. If not, see <https://www.gnu.org/licenses/>.

using FAnsi.Discovery.QuerySyntax;
using Rdmp.Core.Curation.Data;
using Rdmp.Core.Curation.Data.Spontaneous;
using Rdmp.Core.MapsDirectlyToDatabaseTable;
using Rdmp.Core.MapsDirectlyToDatabaseTable.Attributes;
using Rdmp.Core.QueryBuilding.SyntaxChecking;
using Rdmp.Core.ReusableLibraryCode.Checks;

namespace Rdmp.Core.QueryBuilding;

/// <summary>
/// The count(*) column in an AggregateConfiguration, this is used by AggregateBuilder.  This can be any aggregate function such as 'sum', 'avg' etc.
/// </summary>
public class AggregateCountColumn : SpontaneousObject, IColumn
{
    private IQuerySyntaxHelper _syntaxHelper;
    private readonly string _sql;

    /// <summary>
    /// The default alias for unamed count columns
    /// </summary>
    public const string DefaultAliasName = "MyCount";

    /// <summary>
    /// Creates a new Aggregate Function (count / max etc) with the given line of SELECT SQL
    /// <para>Can include aliases e.g. count(*) as MyCount</para>
    /// </summary>
    /// <param name="sql"></param>
    public AggregateCountColumn(string sql) : base(new MemoryRepository())
    {
        _sql = sql;
    }

    /// <summary>
    /// Initializes the <see cref="IQuerySyntaxHelper"/> for the column and optionally ensures that it has an alias.  If no <see cref="Alias"/> has
    /// been specified or was found in the current sql then <see cref="DefaultAliasName"/> is set.
    /// </summary>
    /// <param name="syntaxHelper"></param>
    /// <param name="ensureAliasExists"></param>
    public void SetQuerySyntaxHelper(IQuerySyntaxHelper syntaxHelper, bool ensureAliasExists)
    {
        _syntaxHelper = syntaxHelper;

        //if alias exists
        if (_syntaxHelper.SplitLineIntoSelectSQLAndAlias(_sql, out var select, out var alias))
            Alias = alias; //use the users explicit alias
        else
            Alias = ensureAliasExists ? DefaultAliasName : null; //set an alias of MyCount

        SelectSQL = select;
    }

    /// <inheritdoc/>
    public string GetRuntimeName() =>
        _syntaxHelper == null
            ? throw new System.Exception("SyntaxHelper is null, call SetQuerySyntaxHelper first")
            : string.IsNullOrWhiteSpace(Alias)
                ? _syntaxHelper.GetRuntimeName(SelectSQL)
                : Alias;

    /// <summary>
    /// Combines the <see cref="SelectSQL"/> with the <see cref="Alias"/> for use in SELECT Sql
    /// </summary>
    /// <returns></returns>
    public string GetFullSelectLineStringForSavingIntoAnAggregate() => string.IsNullOrWhiteSpace(Alias)
        ? SelectSQL
        : SelectSQL + _syntaxHelper.AliasPrefix + Alias;

    /// <inheritdoc/>
    public ColumnInfo ColumnInfo => null;

    /// <inheritdoc/>
    public int Order { get; set; }

    /// <inheritdoc/>
    [Sql]
    public string SelectSQL { get; set; }

    /// <inheritdoc/>
    public string Alias { get; private set; }

    /// <inheritdoc/>
    public bool HashOnDataRelease => false;

    /// <inheritdoc/>
    public bool IsExtractionIdentifier => false;

    /// <inheritdoc/>
    public bool IsPrimaryKey => false;

    /// <inheritdoc/>
    public bool GroupBy => false;

    /// <inheritdoc/>
    public void Check(ICheckNotifier notifier)
    {
        new ColumnSyntaxChecker(this).Check(notifier);
    }
}

1	// Copyright (c) The University of Dundee 2018-2019
2	// This file is part of the Research Data Management Platform (RDMP).
3	// RDMP 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 3 of the License, or (at your option) any later version.
4	// RDMP 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.
5	// You should have received a copy of the GNU General Public License along with RDMP. If not, see <https://www.gnu.org/licenses/>.
6
7	using FAnsi.Discovery.QuerySyntax;
8	using Rdmp.Core.Curation.Data;
9	using Rdmp.Core.Curation.Data.Spontaneous;
10	using Rdmp.Core.MapsDirectlyToDatabaseTable;
11	using Rdmp.Core.MapsDirectlyToDatabaseTable.Attributes;
12	using Rdmp.Core.QueryBuilding.SyntaxChecking;
13	using Rdmp.Core.ReusableLibraryCode.Checks;
14
15	namespace Rdmp.Core.QueryBuilding;
16
17	/// <summary>
18	/// The count(*) column in an AggregateConfiguration, this is used by AggregateBuilder. This can be any aggregate function such as 'sum', 'avg' etc.
19	/// </summary>
20	public class AggregateCountColumn : SpontaneousObject, IColumn
21	{
22	private IQuerySyntaxHelper _syntaxHelper;
23	private readonly string _sql;
24
25	/// <summary>
26	/// The default alias for unamed count columns
27	/// </summary>
28	public const string DefaultAliasName = "MyCount";
29
30	/// <summary>
31	/// Creates a new Aggregate Function (count / max etc) with the given line of SELECT SQL
32	/// <para>Can include aliases e.g. count(*) as MyCount</para>
33	/// </summary>
34	/// <param name="sql"></param>
35	public AggregateCountColumn(string sql) : base(new MemoryRepository())	682✔
36	{
37	_sql = sql;	682✔
38	}	682✔
39
40	/// <summary>
41	/// Initializes the <see cref="IQuerySyntaxHelper"/> for the column and optionally ensures that it has an alias. If no <see cref="Alias"/> has
42	/// been specified or was found in the current sql then <see cref="DefaultAliasName"/> is set.
43	/// </summary>
44	/// <param name="syntaxHelper"></param>
45	/// <param name="ensureAliasExists"></param>
46	public void SetQuerySyntaxHelper(IQuerySyntaxHelper syntaxHelper, bool ensureAliasExists)
47	{
48	_syntaxHelper = syntaxHelper;	698✔
49
50	//if alias exists
51	if (_syntaxHelper.SplitLineIntoSelectSQLAndAlias(_sql, out var select, out var alias))	698!
52	Alias = alias; //use the users explicit alias	×
53	else
54	Alias = ensureAliasExists ? DefaultAliasName : null; //set an alias of MyCount	698✔
55
56	SelectSQL = select;	698✔
57	}	698✔
58
59	/// <inheritdoc/>
60	public string GetRuntimeName() =>
61	_syntaxHelper == null	×
62	? throw new System.Exception("SyntaxHelper is null, call SetQuerySyntaxHelper first")	×
63	: string.IsNullOrWhiteSpace(Alias)	×
64	? _syntaxHelper.GetRuntimeName(SelectSQL)	×
65	: Alias;	×
66
67	/// <summary>
68	/// Combines the <see cref="SelectSQL"/> with the <see cref="Alias"/> for use in SELECT Sql
69	/// </summary>
70	/// <returns></returns>
71	public string GetFullSelectLineStringForSavingIntoAnAggregate() => string.IsNullOrWhiteSpace(Alias)	×
72	? SelectSQL	×
73	: SelectSQL + _syntaxHelper.AliasPrefix + Alias;	×
74
75	/// <inheritdoc/>
76	public ColumnInfo ColumnInfo => null;	672✔
77
78	/// <inheritdoc/>
79	public int Order { get; set; }	1,570✔
80
81	/// <inheritdoc/>
82	[Sql]
83	public string SelectSQL { get; set; }	1,416✔
84
85	/// <inheritdoc/>
86	public string Alias { get; private set; }	1,564✔
87
88	/// <inheritdoc/>
89	public bool HashOnDataRelease => false;	688✔
90
91	/// <inheritdoc/>
92	public bool IsExtractionIdentifier => false;	×
93
94	/// <inheritdoc/>
95	public bool IsPrimaryKey => false;	×
96
97	/// <inheritdoc/>
98	public bool GroupBy => false;	20✔
99
100	/// <inheritdoc/>
101	public void Check(ICheckNotifier notifier)
102	{
103	new ColumnSyntaxChecker(this).Check(notifier);	×
104	}	×
105	}

HicServices / RDMP / 9859858140

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous