src/jalview/ws2/gui/AlignmentServiceGuiHandler.java

   1 package jalview.ws2.gui;
   2
   3 import static java.util.Objects.requireNonNullElse;
   4
   5 import java.util.ArrayList;
   6 import java.util.Arrays;
   7 import java.util.BitSet;
   8 import java.util.HashMap;
   9 import java.util.LinkedHashMap;
  10 import java.util.LinkedList;
  11 import java.util.List;
  12
  13 import javax.swing.JInternalFrame;
  14
  15 import jalview.bin.Cache;
  16 import jalview.datamodel.Alignment;
  17 import jalview.datamodel.AlignmentI;
  18 import jalview.datamodel.AlignmentOrder;
  19 import jalview.datamodel.HiddenColumns;
  20 import jalview.gui.AlignFrame;
  21 import jalview.gui.Desktop;
  22 import jalview.gui.JvOptionPane;
  23 import jalview.gui.SplitFrame;
  24 import jalview.gui.WebserviceInfo;
  25 import jalview.util.ArrayUtils;
  26 import jalview.util.MessageManager;
  27 import jalview.util.Pair;
  28 import jalview.ws2.actions.alignment.AlignmentAction;
  29 import jalview.ws2.actions.alignment.AlignmentResult;
  30 import jalview.ws2.actions.api.JobI;
  31 import jalview.ws2.actions.api.TaskEventListener;
  32 import jalview.ws2.actions.api.TaskI;
  33 import jalview.ws2.api.JobStatus;
  34 import jalview.ws2.api.WebService;
  35 import jalview.ws2.helpers.WSClientTaskWrapper;
  36
  37 class AlignmentServiceGuiHandler
  38     implements TaskEventListener<AlignmentResult>
  39 {
  40   private final WebService<?> service;
  41
  42   private final AlignFrame frame;
  43
  44   private WebserviceInfo infoPanel;
  45
  46   private String alnTitle; // title of the alignment used in new window
  47
  48   private JobI[] jobs = new JobI[0];
  49
  50   private int[] tabs = new int[0];
  51
  52   private int[] logOffset = new int[0];
  53
  54   private int[] errLogOffset = new int[0];
  55
  56   public AlignmentServiceGuiHandler(AlignmentAction action, AlignFrame frame)
  57   {
  58     this.service = action.getWebService();
  59     this.frame = frame;
  60     String panelInfo = String.format("%s using service hosted at %s%n%s",
  61         service.getName(), service.getUrl(), service.getDescription());
  62     infoPanel = new WebserviceInfo(service.getName(), panelInfo, false);
  63     String actionName = requireNonNullElse(action.getName(), "Alignment");
  64     alnTitle = String.format("%s %s of %s", service.getName(), actionName,
  65         frame.getTitle());
  66   }
  67
  68   @Override
  69   public void taskStatusChanged(TaskI<AlignmentResult> source, JobStatus status)
  70   {
  71     switch (status)
  72     {
  73     case INVALID:
  74       infoPanel.setVisible(false);
  75       JvOptionPane.showMessageDialog(frame,
  76           MessageManager.getString("info.invalid_msa_input_mininfo"),
  77           MessageManager.getString("info.invalid_msa_notenough"),
  78           JvOptionPane.INFORMATION_MESSAGE);
  79       break;
  80     case READY:
  81       infoPanel.setthisService(new WSClientTaskWrapper(source));
  82       infoPanel.setVisible(true);
  83       // intentional no break
  84     case SUBMITTED:
  85     case QUEUED:
  86       infoPanel.setStatus(WebserviceInfo.STATE_QUEUING);
  87       break;
  88     case RUNNING:
  89     case UNKNOWN: // unsure what to do with unknown
  90       infoPanel.setStatus(WebserviceInfo.STATE_RUNNING);
  91       break;
  92     case COMPLETED:
  93       infoPanel.setProgressBar(
  94           MessageManager.getString("status.collecting_job_results"),
  95           jobs[0].getInternalId());
  96       infoPanel.setStatus(WebserviceInfo.STATE_STOPPED_OK);
  97       break;
  98     case FAILED:
  99       infoPanel.removeProgressBar(jobs[0].getInternalId());
 100       infoPanel.setStatus(WebserviceInfo.STATE_STOPPED_ERROR);
 101       break;
 102     case CANCELLED:
 103       infoPanel.setStatus(WebserviceInfo.STATE_CANCELLED_OK);
 104       break;
 105     case SERVER_ERROR:
 106       infoPanel.removeProgressBar(jobs[0].getInternalId());
 107       infoPanel.setStatus(WebserviceInfo.STATE_STOPPED_SERVERERROR);
 108       break;
 109     }
 110   }
 111
 112   @Override
 113   public void taskStarted(TaskI<AlignmentResult> source, List<? extends JobI> subJobs)
 114   {
 115     jobs = subJobs.toArray(new JobI[0]);
 116     tabs = new int[subJobs.size()];
 117     logOffset = new int[subJobs.size()];
 118     errLogOffset = new int[subJobs.size()];
 119     for (int i = 0; i < subJobs.size(); i++)
 120     {
 121       JobI job = jobs[i];
 122       int tabIndex = infoPanel.addJobPane();
 123       tabs[i] = tabIndex;
 124       infoPanel.setProgressName(String.format("region %d", i), tabIndex);
 125       infoPanel.setProgressText(tabIndex, alnTitle + "\nJob details\n");
 126       // jobs should not have states other than invalid or ready at this point
 127       if (job.getStatus() == JobStatus.INVALID)
 128         infoPanel.setStatus(tabIndex, WebserviceInfo.STATE_STOPPED_OK);
 129       else if (job.getStatus() == JobStatus.READY)
 130         infoPanel.setStatus(tabIndex, WebserviceInfo.STATE_QUEUING);
 131     }
 132   }
 133
 134   @Override
 135   public void taskCompleted(TaskI<AlignmentResult> source, AlignmentResult result)
 136   {
 137     if (result == null)
 138     {
 139       infoPanel.setFinishedNoResults();
 140       return;
 141     }
 142     infoPanel.showResultsNewFrame.addActionListener(evt -> {
 143       var aln = result.getAlignment();
 144       // copy alignment for each frame to have its own isntance
 145       var alnCpy = new Alignment(aln);
 146       alnCpy.setGapCharacter(aln.getGapCharacter());
 147       alnCpy.setDataset(aln.getDataset());
 148       displayResultsNewFrame(alnCpy, result.getAlignmentOrders(),
 149           result.getHiddenColumns());
 150     });
 151     infoPanel.setResultsReady();
 152   }
 153
 154   private void displayResultsNewFrame(Alignment aln,
 155       List<AlignmentOrder> alorders, HiddenColumns hidden)
 156   {
 157     AlignFrame newFrame = new AlignFrame(aln, hidden, AlignFrame.DEFAULT_WIDTH,
 158         AlignFrame.DEFAULT_HEIGHT);
 159     newFrame.getFeatureRenderer().transferSettings(
 160         frame.getFeatureRenderer().getSettings());
 161     if (alorders.size() > 0)
 162     {
 163       addSortByMenuItems(newFrame, alorders);
 164     }
 165
 166     var requestingFrame = frame;
 167     var splitContainer = requestingFrame.getSplitViewContainer();
 168     if (splitContainer != null && splitContainer.getComplement(requestingFrame) != null)
 169     {
 170       AlignmentI complement = splitContainer.getComplement(requestingFrame);
 171       String complementTitle = splitContainer.getComplementTitle(requestingFrame);
 172       Alignment copyComplement = new Alignment(complement);
 173       copyComplement.setGapCharacter(complement.getGapCharacter());
 174       copyComplement.setDataset(complement.getDataset());
 175       copyComplement.alignAs(aln);
 176       if (copyComplement.getHeight() > 0)
 177       {
 178         newFrame.setTitle(alnTitle);
 179         AlignFrame newFrame2 = new AlignFrame(copyComplement,
 180             AlignFrame.DEFAULT_WIDTH, AlignFrame.DEFAULT_HEIGHT);
 181         newFrame2.setTitle(complementTitle);
 182         String linkedTitle = MessageManager.getString("label.linked_view_title");
 183         JInternalFrame splitFrame = new SplitFrame(
 184             aln.isNucleotide() ? newFrame : newFrame2,
 185             aln.isNucleotide() ? newFrame2 : newFrame);
 186         Desktop.addInternalFrame(splitFrame, linkedTitle, -1, -1);
 187         return;
 188       }
 189     }
 190     // no split frame or failed to create complementary alignment
 191     Desktop.addInternalFrame(frame, alnTitle, AlignFrame.DEFAULT_WIDTH,
 192         AlignFrame.DEFAULT_HEIGHT);
 193   }
 194
 195   private void addSortByMenuItems(AlignFrame frame, List<AlignmentOrder> alorders)
 196   {
 197     if (alorders.size() == 1)
 198     {
 199       frame.addSortByOrderMenuItem(service.getName() + " Ordering",
 200           alorders.get(0));
 201       return;
 202     }
 203     BitSet collected = new BitSet(alorders.size());
 204     for (int i = 0, N = alorders.size(); i < N; i++)
 205     {
 206       if (collected.get(i))
 207         continue;
 208       var regions = new ArrayList<String>();
 209       var order = alorders.get(i);
 210       for (int j = i; j < N; j++)
 211       {
 212         if (!collected.get(j) && alorders.get(j).equals(order))
 213         {
 214           regions.add(Integer.toString(j + 1));
 215           collected.set(j);
 216         }
 217       }
 218       var orderName = String.format("%s Region %s Ordering",
 219           service.getName(), String.join(",", regions));
 220       frame.addSortByOrderMenuItem(orderName, order);
 221     }
 222   }
 223
 224   @Override
 225   public void taskException(TaskI<AlignmentResult> source, Exception e)
 226   {
 227     Cache.log.error(String.format("Service %s raised an exception.", service.getName()), e);
 228     infoPanel.appendProgressText(e.getMessage());
 229   }
 230
 231   @Override
 232   public void taskRestarted(TaskI<AlignmentResult> source)
 233   {
 234     // alignment services are not restartable
 235   }
 236
 237   @Override
 238   public void subJobStatusChanged(TaskI<AlignmentResult> source, JobI job, JobStatus status)
 239   {
 240     int i = ArrayUtils.indexOf(jobs, job);
 241     assert i >= 0 : "job does not exist";
 242     if (i < 0)
 243       // safeguard that should not happen irl
 244       return;
 245     int wsStatus;
 246     switch (status)
 247     {
 248     case INVALID:
 249     case COMPLETED:
 250       wsStatus = WebserviceInfo.STATE_STOPPED_OK;
 251       break;
 252     case READY:
 253     case SUBMITTED:
 254     case QUEUED:
 255       wsStatus = WebserviceInfo.STATE_QUEUING;
 256       break;
 257     case RUNNING:
 258     case UNKNOWN:
 259       wsStatus = WebserviceInfo.STATE_RUNNING;
 260       break;
 261     case FAILED:
 262       wsStatus = WebserviceInfo.STATE_STOPPED_ERROR;
 263       break;
 264     case CANCELLED:
 265       wsStatus = WebserviceInfo.STATE_CANCELLED_OK;
 266       break;
 267     case SERVER_ERROR:
 268       wsStatus = WebserviceInfo.STATE_STOPPED_SERVERERROR;
 269       break;
 270     default:
 271       throw new AssertionError("Non-exhaustive switch statement");
 272     }
 273     infoPanel.setStatus(tabs[i], wsStatus);
 274   }
 275
 276   @Override
 277   public void subJobLogChanged(TaskI<AlignmentResult> source, JobI job, String log)
 278   {
 279     int i = ArrayUtils.indexOf(jobs, job);
 280     assert i >= 0 : "job does not exist";
 281     if (i < 0)
 282       // safeguard that should never happen
 283       return;
 284     infoPanel.appendProgressText(tabs[i], log.substring(logOffset[i]));
 285   }
 286
 287   @Override
 288   public void subJobErrorLogChanged(TaskI<AlignmentResult> source, JobI job, String log)
 289   {
 290     int i = ArrayUtils.indexOf(jobs, job);
 291     assert i >= 0 : "job does not exist";
 292     if (i < 0)
 293       // safeguard that should never happen
 294       return;
 295     infoPanel.appendProgressText(tabs[i], log.substring(errLogOffset[i]));
 296   }
 297
 298 }