% UTP_PLIST_UPDATE a set of UTPs for the plist/update method
%
% M Hewitson 06-08-08
%
% $Id: utp_plist_update.m,v 1.13 2010/08/18 09:25:55 ingo Exp $
%

% <MethodDescription>
%
% The update method of the plist class updates (replace) an LTPDA object
% in the repository with the given replacement object. It is only possible
% to update one object. This is the reason why the general UTPs are not
% possible.
%
% </MethodDescription>

function results = utp_plist_update(varargin)
  
  % Check the inputs
  if nargin == 0
    
    % Some keywords
    class   = 'plist';
    mthd    = 'update';
    
    results = [];
    disp('******************************************************');
    disp(['****  Running UTPs for ' class '/' mthd]);
    disp('******************************************************');
    
    c  = 'string';
    n  = 123+5i;
    l  = true;
    sy = sym('symbol');
    t  = time('14:00:00');
    s  = struct('a', c, 'b', n, 'c', l, 'd', sy, 'time', t);
    ce = {'asd', [1 2 3; 4 5i 6], [true false], [sym('a'); sym('B')], s};
    
    obj = plist('char', c, 'number', n, 'logical', l, 'symbolic', sy, 'struct', s, 'cell', ce);
    obj.setName();
    
    plForAutoTest = plist('no dialog', true, 'use selector', false);
    
    try
      conn = utpGetConnection();
      
      sinfo.conn                   = conn;
      sinfo.experiment_title       = 'utp_plist_update: update plist';
      sinfo.experiment_description = 'utp_plist_update: description';
      sinfo.analysis_description   = '<utp_plist_update>';
      sinfo.quantity               = 'none';
      sinfo.keywords               = 'none';
      sinfo.reference_ids          = '';
      sinfo.additional_comments    = 'none';
      sinfo.additional_authors     = 'no one';
      
      [ids, cids] = submit(obj, sinfo, plForAutoTest);
      
      % 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];    % Test with conn
      results = [results utp_03];    % Test with sinfo
      results = [results utp_04];    % Test update of an binary file
      results = [results utp_05];    % Test replace with other object
    catch
    end
    
    % Close connection
    utpCloseConnection(conn)
    
    disp('Done.');
    disp('******************************************************');
    
  elseif nargin == 1 % Check for UTP functions
    if strcmp(varargin{1}, 'isutp')
      results = 1;
    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('binary'), 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 ~isequal(io(3).plists.find('binary'), false), 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 update method updates the repository at the given
  % position 'ids' with the new object.
  %
  % </TestDescription>
  function result = utp_02
    
    % <SyntaxDescription>
    %
    % Tests that the update method updates the repository at the given
    % position 'ids' with the new object.
    % Use a database object (conn) to establish the connection.
    %
    % </SyntaxDescription>
    
    try
      % <SyntaxCode>
      % Make some changes to the object.
      uobj = obj.setName('I was updated (conn)');
      update(uobj, ids, conn, plForAutoTest);
      % Retrieve the object from the repository position 'ids'
      robj = ltpda_uo.retrieve(conn, ids);
      % </SyntaxCode>
      stest = true;
    catch err
      disp(err.message)
      stest = false;
    end
    
    % <AlgoDescription>
    %
    % 1) Check that the updated object 'uobj' and the retrieved object
    %    'robj' are the same.
    %
    % </AlgoDescription>
    
    atest = true;
    if stest
      % <AlgoCode>
      if ~eq(uobj, robj), 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 update method updates the repository at the given
  % position 'ids' with the new object.
  %
  % </TestDescription>
  function result = utp_03
    
    % <SyntaxDescription>
    %
    % Tests that the update method updates the repository at the given
    % position 'ids' with the new object.
    % Use a database info structure (sinfo) to establish the connection.
    %
    % </SyntaxDescription>
    
    try
      % <SyntaxCode>
      % Make some changes to the object.
      uobj = obj.setName('I was updated (sinfo)');
      update(uobj, ids, sinfo, plForAutoTest);
      % Retrieve the object from the repository position 'ids'
      robj = ltpda_uo.retrieve(conn, ids);
      % </SyntaxCode>
      stest = true;
    catch err
      disp(err.message)
      stest = false;
    end
    
    % <AlgoDescription>
    %
    % 1) Check that the updated object 'uobj' and the retrieved object
    %    'robj' are the same.
    %
    % </AlgoDescription>
    
    atest = true;
    if stest
      % <AlgoCode>
      if ~eq(uobj, robj), 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 update method updates the repository at the given
  % position 'ids' with the new object.
  %
  % </TestDescription>
  function result = utp_04
    
    % <SyntaxDescription>
    %
    % Tests that the update method updates the repository at the given
    % position 'ids' with the new object.
    % Check that the update method also updates objects which are stored as
    % a binary file.
    %
    % </SyntaxDescription>
    
    try
      % <SyntaxCode>
      % Submit the object as a binary
      [ids_bin, cids] = bsubmit(obj, sinfo, plForAutoTest);
      % Make some changes to the object.
      uobj = obj.setName('I was updated (sinfo)');
      update(uobj, ids_bin, sinfo, plForAutoTest);
      % Retrieve the object from the repository position 'ids_bin'
      robj = ltpda_uo.retrieve(conn, ids_bin);
      % </SyntaxCode>
      stest = true;
    catch err
      disp(err.message)
      stest = false;
    end
    
    % <AlgoDescription>
    %
    % 1) Check that the updated object 'uobj' and the retrieved object
    %    'robj' are the same.
    %
    % </AlgoDescription>
    
    atest = true;
    if stest
      % <AlgoCode>
      if ~eq(uobj, robj), 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 update method replaces the object in the repository with
  % a completely other object.
  %
  % </TestDescription>
  function result = utp_05
    
    % <SyntaxDescription>
    %
    % Tests that the update method replaces the object in the repository
    % with a completely other object.
    % Replace the plist object with a filter object.
    %
    % </SyntaxDescription>
    
    try
      % <SyntaxCode>
      % Make some changes to the object.
      uobj = miir(plist('type', 'lowpass'));
      update(uobj, ids, sinfo, plForAutoTest);
      % Retrieve the object from the repository position 'ids'
      robj = ltpda_uo.retrieve(conn, ids);
      % </SyntaxCode>
      stest = true;
    catch err
      disp(err.message)
      stest = false;
    end
    
    % <AlgoDescription>
    %
    % 1) Check that the updated object 'uobj' and the retrieved object
    %    'robj' are the same.
    %
    % </AlgoDescription>
    
    atest = true;
    if stest
      % <AlgoCode>
      if ~eq(uobj, robj), atest = false; end
      % </AlgoCode>
    else
      atest = false;
    end
    
    % Return a result structure
    result = utp_prepare_result(atest, stest, dbstack, mfilename);
  end % END UTP_05
  
end