% UTP_PZMODEL_BSUBMIT a set of UTPs for the pzmodel/bsubmit method
%
% M Hewitson 06-08-08
%
% $Id: utp_pzmodel_bsubmit.m,v 1.14 2010/08/18 09:25:55 ingo Exp $
%

% <MethodDescription>
%
% The bsubmit method of the pzmodel class submits a collection of objects
% in binary form to an LTPDA Repository. The type of the objects are
% independent.
%
% </MethodDescription>

function results = utp_pzmodel_bsubmit(varargin)
  
  % Check the inputs
  if nargin == 0
    
    % Some keywords
    class   = 'pzmodel';
    mthd    = 'bsubmit';
    
    results = [];
    disp('******************************************************');
    disp(['****  Running UTPs for ' class '/' mthd]);
    disp('******************************************************');
    
    [pz1, pz2, pz3, pz4, pz5, pzv, pzm] = get_test_objects_pzmodel;
    plForAutoTest = plist('no dialog', true, 'use selector', false);
    
    conn = utpGetConnection();
    try
      
      sinfo.conn                   = conn;
      sinfo.experiment_title       = 'utp_pzmodel_bsubmit: submit pzmodel';
      sinfo.experiment_description = 'utp_pzmodel_bsubmit: description';
      sinfo.analysis_description   = '<utp_pzmodel_bsubmit>';
      sinfo.quantity               = 'none';
      sinfo.keywords               = 'none';
      sinfo.reference_ids          = '';
      sinfo.additional_comments    = 'none';
      sinfo.additional_authors     = 'no one';
      
      % Exception list for the UTPs:
      [ple1,ple2,ple3,ple4,ple5,ple6] = get_test_ples();
      
      % Run the tests
      results = [results utp_01];    % getInfo call
      results = [results utp_02];    % Vector input
      results = [results utp_03];    % Matrix input
      results = [results utp_04];    % List input
      results = [results utp_05];    % Test with mixed input
      results = [results utp_06];    % Test history is working
      results = [results utp_07];    % Test output of the data
    catch
    end
    
    % Close connection
    utpCloseConnection(conn);
    
    disp('Done.');
    disp('******************************************************');
    
  elseif nargin == 1 % Check for UTP functions
    if strcmp(varargin{1}, 'isutp')
      results = 1;
    elseif strcmpi(varargin{1}, 'needs repository')
      results = 2;
    else
      results = 0;
    end
  else
    error('### Incorrect inputs')
  end
  
  %% UTP_01
  
  % <TestDescription>
  %
  % Tests that the getInfo call works for this method.
  %
  % </TestDescription>
  function result = utp_01
    
    
    % <SyntaxDescription>
    %
    % Test that the getInfo call works for no sets, all sets, and each set
    % individually.
    %
    % </SyntaxDescription>
    
    try
      % <SyntaxCode>
      % Call for no sets
      io(1) = eval([class '.getInfo(''' mthd ''', ''None'')']);
      % Call for all sets
      io(2) = eval([class '.getInfo(''' mthd ''')']);
      % Call for each set
      for kk=1:numel(io(2).sets)
        io(kk+2) = eval([class '.getInfo(''' mthd ''', ''' io(2).sets{kk} ''')']);
      end
      % </SyntaxCode>
      stest = true;
    catch err
      disp(err.message)
      stest = false;
    end
    
    % <AlgoDescription>
    %
    % 1) Check that getInfo call returned an minfo object in all cases.
    % 2) Check that all plists have the correct parameters.
    %
    % </AlgoDescription>
    
    atest = true;
    if stest
      % <AlgoCode>
      % check we have minfo objects
      if isa(io, 'minfo')
        prefs = getappdata(0, 'LTPDApreferences');
        hosts = utils.helper.jArrayList2CellArray(prefs.getRepoPrefs.getHostnames());
        % SET 'None'
        if ~isempty(io(1).sets), atest = false; end
        if ~isempty(io(1).plists), atest = false; end
        % Check all Sets
        if ~any(strcmpi(io(2).sets, 'Default')), atest = false; end
        if numel(io(2).plists) ~= numel(io(2).sets), atest = false; end
        % SET 'Default'
        % Check key
        if io(3).plists.nparams ~= 15, atest = false; end
        if ~io(3).plists.isparam('hostname'), atest = false; end
        if ~io(3).plists.isparam('database'), atest = false; end
        if ~io(3).plists.isparam('username'), atest = false; end
        if ~io(3).plists.isparam('password'), atest = false; end
        if ~io(3).plists.isparam('experiment title'), atest = false; end
        if ~io(3).plists.isparam('experiment description'), atest = false; end
        if ~io(3).plists.isparam('analysis description'), atest = false; end
        if ~io(3).plists.isparam('quantity'), atest = false; end
        if ~io(3).plists.isparam('keywords'), atest = false; end
        if ~io(3).plists.isparam('reference ids'), atest = false; end
        if ~io(3).plists.isparam('additional comments'), atest = false; end
        if ~io(3).plists.isparam('additional authors'), atest = false; end
        if ~io(3).plists.isparam('no dialog'), atest = false; end
        if ~io(3).plists.isparam('use selector'), atest = false; end
        if ~io(3).plists.isparam('sinfo filename'), atest = false; end
        % Check default value
        if ~isequal(io(3).plists.find('hostname'), hosts{1}), atest = false; end
        if ~isEmptyChar(io(3).plists.find('database')), atest = false; end
        if ~isEmptyChar(io(3).plists.find('username')), atest = false; end
        if ~isEmptyChar(io(3).plists.find('password')), atest = false; end
        if ~isEmptyChar(io(3).plists.find('experiment title')), atest = false; end
        if ~isEmptyChar(io(3).plists.find('experiment description')), atest = false; end
        if ~isEmptyChar(io(3).plists.find('analysis description')), atest = false; end
        if ~isEmptyChar(io(3).plists.find('quantity')), atest = false; end
        if ~isEmptyChar(io(3).plists.find('keywords')), atest = false; end
        if ~isEmptyChar(io(3).plists.find('reference ids')), atest = false; end
        if ~isEmptyChar(io(3).plists.find('additional comments')), atest = false; end
        if ~isEmptyChar(io(3).plists.find('additional authors')), atest = false; end
        if ~isequal(io(3).plists.find('no dialog'), false), atest = false; end
        if ~isequal(io(3).plists.find('use selector'), true), atest = false; end
        if ~isEmptyChar(io(3).plists.find('sinfo filename')), atest = false; end
      end
      % </AlgoCode>
    else
      atest = false;
    end
    
    % Return a result structure
    result = utp_prepare_result(atest, stest, dbstack, mfilename);
  end % END UTP_01
  
  %% UTP_02
  
  % <TestDescription>
  %
  % Tests that the bsubmit method works with a vector of PZMODEL objects as
  % input.
  %
  % </TestDescription>
  function result = utp_02
    
    % <SyntaxDescription>
    %
    % Test that the bsubmit method works for a vector of PZMODEL objects as
    % input.
    %
    % </SyntaxDescription>
    
    try
      % <SyntaxCode>
      [ids, cids] = bsubmit(pzv, sinfo, plForAutoTest);
      robjs1 = ltpda_uo.retrieve(conn, 'binary', 'Collection', cids);
      robjs2 = ltpda_uo.retrieve(conn, 'binary', ids);
      robjs3 = ltpda_uo.retrieve(conn, 'binary', ids(1), ids(2), ids(3));
      % </SyntaxCode>
      stest = true;
    catch err
      disp(err.message)
      stest = false;
    end
    
    % <AlgoDescription>
    %
    % 1) Check the number of retrieved objects.
    % 2) Check that the retrieved object is the same as the submitted
    %
    % </AlgoDescription>
    
    atest = true;
    if stest
      % <AlgoCode>
      % Check we have the correct number of outputs
      if numel(robjs1) ~= numel(pzv), atest = false; end
      if numel(robjs2) ~= numel(pzv), atest = false; end
      if numel(robjs3) ~= numel(pzv), atest = false; end
      % Check the retrieved object against the submitted
      if ~eq(pzv, [robjs1{:}]), atest = false; end
      if ~eq(pzv, [robjs2{:}]), atest = false; end
      if ~eq(pzv, [robjs3{:}]), atest = false; end
      % </AlgoCode>
    else
      atest = false;
    end
    
    % Return a result structure
    result = utp_prepare_result(atest, stest, dbstack, mfilename);
  end % END UTP_02
  
  %% UTP_03
  
  % <TestDescription>
  %
  % Tests that the bsubmit method works with a matrix of PZMODEL objects as
  % input.
  %
  % </TestDescription>
  function result = utp_03
    
    % <SyntaxDescription>
    %
    % Tests that the bsubmit method works with a matrix of PZMODEL objects
    % as input.
    %
    % </SyntaxDescription>
    
    try
      % <SyntaxCode>
      [ids, cids] = bsubmit(pzm, sinfo, plForAutoTest);
      robjs1 = ltpda_uo.retrieve(conn, 'binary', 'Collection', cids);
      robjs2 = ltpda_uo.retrieve(conn, 'binary', ids);
      robjs3 = ltpda_uo.retrieve(conn, 'binary', ids(1), ids(2), ids(3), ids(4), ids(5), ids(6));
      % </SyntaxCode>
      stest = true;
    catch err
      disp(err.message)
      stest = false;
    end
    
    % <AlgoDescription>
    %
    % 1) Check the number of retrieved objects.
    % 2) Check that the retrieved object is the same as the submitted
    %
    % </AlgoDescription>
    
    atest = true;
    if stest
      % <AlgoCode>
      % Check we have the correct number of outputs
      if numel(robjs1) ~= numel(pzm), atest = false; end
      if numel(robjs2) ~= numel(pzm), atest = false; end
      if numel(robjs3) ~= numel(pzm), atest = false; end
      % Check the retrieved object against the submitted
      if ~eq(pzm, reshape([robjs1{:}], size(pzm))), atest = false; end
      if ~eq(pzm, reshape([robjs2{:}], size(pzm))), atest = false; end
      if ~eq(pzm, reshape([robjs3{:}], size(pzm))), atest = false; end
      % </AlgoCode>
    else
      atest = false;
    end
    
    % Return a result structure
    result = utp_prepare_result(atest, stest, dbstack, mfilename);
  end % END UTP_03
  
  %% UTP_04
  
  % <TestDescription>
  %
  % Tests that the bsubmit method works with a list of PZMODEL objects as
  % input.
  %
  % </TestDescription>
  function result = utp_04
    
    % <SyntaxDescription>
    %
    % Tests that the bsubmit method works with a list of PZMODEL objects as
    % input. Use for this a mix of different object types.
    %
    % </SyntaxDescription>
    
    try
      % <SyntaxCode>
      pl  = plist('key1', 'val', 'key2', 2);
      iir = miir(plist('type', 'highpass'));
      [ids, cids] = bsubmit(pz1, pl, iir, sinfo, plForAutoTest);
      robjs1 = ltpda_uo.retrieve(conn, 'binary', 'Collection', cids);
      robjs2 = ltpda_uo.retrieve(conn, 'binary', ids);
      robjs3 = ltpda_uo.retrieve(conn, 'binary', ids(1), ids(2), ids(3));
      % </SyntaxCode>
      stest = true;
    catch err
      disp(err.message)
      stest = false;
    end
    
    % <AlgoDescription>
    %
    % 1) Check the number of retrieved objects.
    % 2) Check that the retrieved object is the same as the submitted
    %
    % </AlgoDescription>
    
    atest = true;
    if stest
      % <AlgoCode>
      % Check we have the correct number of outputs
      if numel(robjs1) ~= 3, atest = false; end
      if numel(robjs2) ~= 3, atest = false; end
      if numel(robjs3) ~= 3, atest = false; end
      % Check the retrieved object against the submitted
      % Check robjs1
      if ~eq(robjs1{1}, pz1), atest = false; end
      if ~eq(robjs1{3}, pl), atest = false; end
      if ~eq(robjs1{2}, iir), atest = false; end
      % Check robjs2
      if ~eq(robjs2{1}, pz1), atest = false; end
      if ~eq(robjs2{3}, pl), atest = false; end
      if ~eq(robjs2{2}, iir), atest = false; end
      % Check robjs3
      if ~eq(robjs3{1}, pz1), atest = false; end
      if ~eq(robjs3{3}, pl), atest = false; end
      if ~eq(robjs3{2}, iir), atest = false; end
      % </AlgoCode>
    else
      atest = false;
    end
    
    % Return a result structure
    result = utp_prepare_result(atest, stest, dbstack, mfilename);
  end % END UTP_04
  
  %% UTP_05
  
  % <TestDescription>
  %
  % Tests that the abs method works with a mix of different shaped PZMODEL
  % objects as input.
  %
  % </TestDescription>
  function result = utp_05
    
    % <SyntaxDescription>
    %
    % Tests that the bsubmit method works with a list of PZMODEL objects as
    % input. Use for this a mix of different object types.
    %
    % </SyntaxDescription>
    
    try
      % <SyntaxCode>
      pl  = plist('key1', 'val', 'key2', 2);
      iir = miir(plist('type', 'highpass'));
      [ids, cids] = bsubmit(pl, pzm, iir, pzv, sinfo, plForAutoTest);
      robjs1 = ltpda_uo.retrieve(conn, 'binary', 'Collection', cids);
      robjs2 = ltpda_uo.retrieve(conn, 'binary', ids);
      % </SyntaxCode>
      stest = true;
    catch err
      disp(err.message)
      stest = false;
    end
    
    % <AlgoDescription>
    %
    % 1) Check the number of retrieved objects.
    % 2) Check that the retrieved object is the same as the submitted
    %
    % </AlgoDescription>
    
    atest = true;
    if stest
      % <AlgoCode>
      % Check we have the correct number of outputs
      if numel(robjs1) ~= 2 + numel(pzm) + numel(pzv), atest = false; end
      if numel(robjs2) ~= 2 + numel(pzm) + numel(pzv), atest = false; end
      % Check the retrieved object against the submitted
      % Check robjs1
      if ~eq(robjs1{1}, pzm(1)), atest = false; end
      if ~eq(robjs1{2}, pzm(2)), atest = false; end
      if ~eq(robjs1{3}, pzm(3)), atest = false; end
      if ~eq(robjs1{4}, pzm(4)), atest = false; end
      if ~eq(robjs1{5}, pzm(5)), atest = false; end
      if ~eq(robjs1{6}, pzm(6)), atest = false; end
      if ~eq(robjs1{7}, iir), atest = false; end
      if ~eq(robjs1{8},  pzv(1)), atest = false; end
      if ~eq(robjs1{9}, pzv(2)), atest = false; end
      if ~eq(robjs1{10}, pzv(3)), atest = false; end
      if ~eq(robjs1{11}, pl), atest = false; end
      % Check robjs2
      if ~isequalwithequalnans(robjs1, robjs2), atest = false; end
      % </AlgoCode>
    else
      atest = false;
    end
    
    % Return a result structure
    result = utp_prepare_result(atest, stest, dbstack, mfilename);
  end % END UTP_05
  
  %% UTP_06
  
  % <TestDescription>
  %
  % Tthe bsubmit method properly applies history.
  %
  % </TestDescription>
  function result = utp_06
    
    % <SyntaxDescription>
    %
    % Tthe bsubmit method properly applies history.
    %
    % </SyntaxDescription>
    
    try
      % <SyntaxCode>
      % </SyntaxCode>
      stest = true;
    catch err
      disp(err.message)
      stest = false;
    end
    
    % <AlgoDescription>
    %
    % 1) Nothing to test.
    %
    % </AlgoDescription>
    
    atest = true;
    if stest
      % <AlgoCode>
      % </AlgoCode>
    else
      atest = false;
    end
    
    % Return a result structure
    result = utp_prepare_result(atest, stest, dbstack, mfilename);
  end % END UTP_06
  
  %% UTP_07
  
  % <TestDescription>
  %
  % Check that the bsubmit method pass back the output objects to a list of
  % output variables or to a single variable.
  %
  % </TestDescription>
  function result = utp_07
    
    % <SyntaxDescription>
    %
    % Call the method with a list of output variables and with a single
    % output variable. Additionaly check that the rebuild method works on
    % the output.
    %
    % </SyntaxDescription>
    
    try
      % <SyntaxCode>
      [ids, cids] = bsubmit(pz1, pz2, sinfo, plForAutoTest);
      
      [o1, o2] = ltpda_uo.retrieve(conn, 'binary', 'Collection', cids);
      o3  = ltpda_uo.retrieve(conn, 'binary', 'Collection', cids);
      % </SyntaxCode>
      stest = true;
    catch err
      disp(err.message)
      stest = false;
    end
    
    % <AlgoDescription>
    %
    % 1) Check that the output contains the right number of objects
    %
    % </AlgoDescription>
    
    atest = true;
    if stest
      % <AlgoCode>
      % Check the number of outputs
      if numel(o1) ~=1, atest = false; end
      if numel(o2) ~=1, atest = false; end
      if numel(o3) ~=2, atest = false; end
      % Check the output
      if ~eq(o1, pz1), atest = false; end
      if ~eq(o2, pz2), atest = false; end
      if ~eq(o3{1}, pz1), atest = false; end
      if ~eq(o3{2}, pz2), atest = false; end
      % </AlgoCode>
    else
      atest = false;
    end
    
    % Return a result structure
    result = utp_prepare_result(atest, stest, dbstack, mfilename);
  end % END UTP_07
  
end
