11592322517

Committed 30 Oct 2024 11:31AM UTC coverage: 57.276% (-0.1%) from 57.386%

Build # 11592322517

Build Type

Pull #2050

github

Committed by

JFriel

Commit Message

add missing file

Pull Request Pull Request #2050: Catalogue Overview

Run Details

11218 of 21084 branches covered (53.21%)

Branch coverage included in aggregate %.

30 of 172 new or added lines in 5 files covered. (17.44%)

29 existing lines in 5 files now uncovered.

31759 of 53951 relevant lines covered (58.87%)

8186.01 hits per line

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

61.29

/Rdmp.Core/Curation/Data/Spontaneous/SpontaneouslyInventedFilter.cs

// Copyright (c) The University of Dundee 2018-2024
// 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 System;
using System.Collections.Generic;
using Rdmp.Core.Curation.FilterImporting.Construction;
using Rdmp.Core.Repositories;

namespace Rdmp.Core.Curation.Data.Spontaneous;

/// <summary>
/// Spontaneous (memory only) implementation of IFilter.  This is the preferred method of injecting lines of WHERE Sql into an ISqlQueryBuilder dynamically in code
/// (as opposed to ones the user has created).  This can be used to for example enforce additional constraints on the query e.g. 'generate this Aggregate Graph but
/// restrict the results to patients appearing in my cohort list X' (in this case the SpontaneouslyInventedFilter would be the 'patients appearing in my cohort list X'
/// 
/// <para>The other way to inject sql code into an ISqlQueryBuilder is via CustomLine but that's less precise.</para>
/// </summary>
public class SpontaneouslyInventedFilter : ConcreteFilter
{
    private readonly MemoryCatalogueRepository _repo;
    private readonly ISqlParameter[] _filterParametersIfAny;
    private int _order =0;

    /// <summary>
    /// Creates a new temporary (unsaveable) filter in the given memory <paramref name="repo"/>
    /// </summary>
    /// <param name="repo">The repository to store the temporary object in</param>
    /// <param name="notionalParent"></param>
    /// <param name="whereSql"></param>
    /// <param name="name"></param>
    /// <param name="description"></param>
    /// <param name="filterParametersIfAny"></param>
    public SpontaneouslyInventedFilter(MemoryCatalogueRepository repo, IContainer notionalParent, string whereSql,
        string name, string description, ISqlParameter[] filterParametersIfAny)
    {
        _repo = repo;
        _filterParametersIfAny = filterParametersIfAny;
        WhereSQL = whereSql;
        Name = name;
        Description = description;

        repo.InsertAndHydrate(this, new Dictionary<string, object>());

        if (notionalParent != null)
        {
            repo.AddChild(notionalParent, this);
            FilterContainer_ID = notionalParent.ID;
        }
    }

    /// <summary>
    /// Constructs a new filter by copying out the values from the supplied IFilter
    /// </summary>
    /// <param name="repo">The repository to store the temporary object in</param>
    /// <param name="copyFrom"></param>
    public SpontaneouslyInventedFilter(MemoryCatalogueRepository repo, IFilter copyFrom) : this(repo, null,
        copyFrom.WhereSQL, copyFrom.Name, copyFrom.Description, copyFrom.GetAllParameters())
    {
    }

    public override int? ClonedFromExtractionFilter_ID { get; set; }
    public override int? FilterContainer_ID { get; set; }
    public override ISqlParameter[] GetAllParameters() => _filterParametersIfAny ?? Array.Empty<ISqlParameter>();

    public override IContainer FilterContainer => FilterContainer_ID.HasValue
        ? _repo.GetObjectByID<IContainer>(FilterContainer_ID.Value)
        : null;

    public override int Order { get => _order; set => SetField(ref _order, value); }

    public override ColumnInfo GetColumnInfoIfExists() => null;

    public override IFilterFactory GetFilterFactory() => null;

    public override Catalogue GetCatalogue() => null;
}

1	// Copyright (c) The University of Dundee 2018-2024
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 System;
8	using System.Collections.Generic;
9	using Rdmp.Core.Curation.FilterImporting.Construction;
10	using Rdmp.Core.Repositories;
11
12	namespace Rdmp.Core.Curation.Data.Spontaneous;
13
14	/// <summary>
15	/// Spontaneous (memory only) implementation of IFilter. This is the preferred method of injecting lines of WHERE Sql into an ISqlQueryBuilder dynamically in code
16	/// (as opposed to ones the user has created). This can be used to for example enforce additional constraints on the query e.g. 'generate this Aggregate Graph but
17	/// restrict the results to patients appearing in my cohort list X' (in this case the SpontaneouslyInventedFilter would be the 'patients appearing in my cohort list X'
18	///
19	/// <para>The other way to inject sql code into an ISqlQueryBuilder is via CustomLine but that's less precise.</para>
20	/// </summary>
21	public class SpontaneouslyInventedFilter : ConcreteFilter
22	{
23	private readonly MemoryCatalogueRepository _repo;
24	private readonly ISqlParameter[] _filterParametersIfAny;
25	private int _order =0;
26
27	/// <summary>
28	/// Creates a new temporary (unsaveable) filter in the given memory <paramref name="repo"/>
29	/// </summary>
30	/// <param name="repo">The repository to store the temporary object in</param>
31	/// <param name="notionalParent"></param>
32	/// <param name="whereSql"></param>
33	/// <param name="name"></param>
34	/// <param name="description"></param>
35	/// <param name="filterParametersIfAny"></param>
36	public SpontaneouslyInventedFilter(MemoryCatalogueRepository repo, IContainer notionalParent, string whereSql,	66✔
37	string name, string description, ISqlParameter[] filterParametersIfAny)	66✔
38	{
39	_repo = repo;	66✔
40	_filterParametersIfAny = filterParametersIfAny;	66✔
41	WhereSQL = whereSql;	66✔
42	Name = name;	66✔
43	Description = description;	66✔
44
45	repo.InsertAndHydrate(this, new Dictionary<string, object>());	66✔
46
47	if (notionalParent != null)	66✔
48	{
49	repo.AddChild(notionalParent, this);	58✔
50	FilterContainer_ID = notionalParent.ID;	58✔
51	}
52	}	66✔
53
54	/// <summary>
55	/// Constructs a new filter by copying out the values from the supplied IFilter
56	/// </summary>
57	/// <param name="repo">The repository to store the temporary object in</param>
58	/// <param name="copyFrom"></param>
UNCOV 59	public SpontaneouslyInventedFilter(MemoryCatalogueRepository repo, IFilter copyFrom) : this(repo, null,	×
60	copyFrom.WhereSQL, copyFrom.Name, copyFrom.Description, copyFrom.GetAllParameters())	×
61	{
UNCOV 62	}	×
63
UNCOV 64	public override int? ClonedFromExtractionFilter_ID { get; set; }	×
65	public override int? FilterContainer_ID { get; set; }	446✔
66	public override ISqlParameter[] GetAllParameters() => _filterParametersIfAny ?? Array.Empty<ISqlParameter>();	92✔
67
UNCOV 68	public override IContainer FilterContainer => FilterContainer_ID.HasValue	×
69	? _repo.GetObjectByID<IContainer>(FilterContainer_ID.Value)	×
70	: null;	×
71
NEW 72	public override int Order { get => _order; set => SetField(ref _order, value); }	×
73
74	public override ColumnInfo GetColumnInfoIfExists() => null;	28✔
75
UNCOV 76	public override IFilterFactory GetFilterFactory() => null;	×
77
UNCOV 78	public override Catalogue GetCatalogue() => null;	×
79	}

HicServices / RDMP / 11592322517

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