JAL-1919 PDBfile and JmolParser refactor
[jalview.git] / src / jalview / ext / jmol / JmolParser.java
index dcbd6ad..668457b 100644 (file)
@@ -27,18 +27,18 @@ import jalview.datamodel.DBRefSource;
 import jalview.datamodel.PDBEntry;
 import jalview.datamodel.Sequence;
 import jalview.datamodel.SequenceI;
-import jalview.io.AlignFile;
 import jalview.io.FileParse;
+import jalview.io.StructureFile;
 import jalview.schemes.ResidueProperties;
 import jalview.util.Comparison;
 import jalview.util.MessageManager;
 
 import java.io.IOException;
 import java.util.ArrayList;
-import java.util.Collection;
 import java.util.Hashtable;
 import java.util.List;
 import java.util.Map;
+import java.util.Vector;
 
 import javajs.awt.Dimension;
 
@@ -54,30 +54,38 @@ import org.jmol.modelsetbio.BioPolymer;
 import org.jmol.modelsetbio.Monomer;
 import org.jmol.viewer.Viewer;
 
+import MCview.Atom;
 import MCview.PDBChain;
+import MCview.Residue;
 
 /**
- * Import and process files with Jmol for file like PDB, mmCIF 
+ * Import and process files with Jmol for file like PDB, mmCIF
  * 
  * @author jprocter
  * 
  */
-public class JmolParser extends AlignFile implements
-        JmolStatusListener
+public class JmolParser extends StructureFile implements JmolStatusListener
 {
   Viewer viewer = null;
 
-  private Collection<PDBChain> chains;
-
-  /*
-   * Set true to predict secondary structure (using JMol for protein, Annotate3D
-   * for RNA)
-   */
-  private boolean predictSecondaryStructure = true;
-
-  public JmolParser(String inFile, String type) throws IOException
+  public JmolParser(boolean addAlignmentAnnotations,
+          boolean predictSecondaryStructure, boolean externalSecStr,
+          String inFile, String type) throws IOException
   {
     super(inFile, type);
+    this.visibleChainAnnotation = addAlignmentAnnotations;
+    this.predictSecondaryStructure = predictSecondaryStructure;
+    this.externalSecondaryStructure = externalSecStr;
+  }
+
+  public JmolParser(boolean addAlignmentAnnotations,
+          boolean predictSecondaryStructure, boolean externalSecStr,
+          FileParse fp) throws IOException
+  {
+    super(fp);
+    this.visibleChainAnnotation = addAlignmentAnnotations;
+    this.predictSecondaryStructure = predictSecondaryStructure;
+    this.externalSecondaryStructure = externalSecStr;
   }
 
   public JmolParser(FileParse fp) throws IOException
@@ -85,11 +93,43 @@ public class JmolParser extends AlignFile implements
     super(fp);
   }
 
+  public JmolParser(String inFile, String type) throws IOException
+  {
+    super(inFile, type);
+  }
+
   public JmolParser()
   {
   }
 
   /**
+   * Calls the Jmol library to parse the PDB/mmCIF file, and then inspects the
+   * resulting object model to generate Jalview-style sequences, with secondary
+   * structure annotation added where available (i.e. where it has been computed
+   * by Jmol using DSSP).
+   * 
+   * @see jalview.io.AlignFile#parse()
+   */
+  @Override
+  public void parse() throws IOException
+  {
+
+    setChains(new Vector<PDBChain>());
+    Viewer jmolModel = getJmolData();
+    jmolModel.openReader(getDataName(), getDataName(), getReader());
+    waitForScript(jmolModel);
+
+    /*
+     * Convert one or more Jmol Model objects to Jalview sequences
+     */
+    if (jmolModel.ms.mc > 0)
+    {
+      parseBiopolymer(jmolModel.ms);
+      // transformJmolModelToJalview(jmolModel.ms);
+    }
+  }
+
+  /**
    * create a headless jmol instance for dataprocessing
    * 
    * @return
@@ -114,326 +154,231 @@ public class JmolParser extends AlignFile implements
     return viewer;
   }
 
-  private void waitForScript(Viewer jmd)
+  public void transformJmolModelToJalview(ModelSet ms) throws IOException
   {
-    while (jmd.isScriptExecuting())
+    try
     {
-      try
+      String lastID = "";
+      List<SequenceI> rna = new ArrayList<SequenceI>();
+      List<SequenceI> prot = new ArrayList<SequenceI>();
+      PDBChain tmpchain;
+      String pdbId = (String) ms.getInfo(0, "title");
+      setId(pdbId);
+      List<Atom> significantAtoms = convertSignificantAtoms(ms);
+      for (Atom tmpatom : significantAtoms)
       {
-        Thread.sleep(50);
+        try
+        {
+          tmpchain = findChain(tmpatom.chain);
+          if (tmpatom.resNumIns.trim().equals(lastID))
+          {
+            // phosphorylated protein - seen both CA and P..
+            continue;
+          }
+          tmpchain.atoms.addElement(tmpatom);
+        } catch (Exception e)
+        {
+          tmpchain = new PDBChain(pdbId, tmpatom.chain);
+          getChains().add(tmpchain);
+          tmpchain.atoms.addElement(tmpatom);
+        }
+        lastID = tmpatom.resNumIns.trim();
+      }
+      makeResidueList();
+      makeCaBondList();
 
-      } catch (InterruptedException x)
+      if (getId() == null)
+      {
+        setId(inFile.getName());
+      }
+      for (PDBChain chain : getChains())
       {
+        SequenceI chainseq = postProcessChain(chain);
+        createAnnotation(chainseq, chain, ms.at);
+        if (isRNA(chainseq))
+        {
+          rna.add(chainseq);
+        }
+        else
+        {
+          prot.add(chainseq);
+        }
       }
+    } catch (OutOfMemoryError er)
+    {
+      System.out
+              .println("OUT OF MEMORY LOADING TRANSFORMING JMOL MODEL TO JALVIEW MODEL");
+      throw new IOException(
+              MessageManager
+                      .getString("exception.outofmemory_loading_mmcif_file"));
     }
   }
 
-  /**
-   * Convert Jmol's secondary structure code to Jalview's, and stored it in the
-   * secondary structure arrays at the given sequence position
-   * 
-   * @param proteinStructureSubType
-   * @param pos
-   * @param secstr
-   * @param secstrcode
-   */
-  protected void setSecondaryStructure(STR proteinStructureSubType,
-          int pos, char[] secstr, char[] secstrcode)
+  private List<Atom> convertSignificantAtoms(ModelSet ms)
   {
-    switch (proteinStructureSubType)
+    List<Atom> significantAtoms = new ArrayList<Atom>();
+    for (org.jmol.modelset.Atom atom : ms.at)
     {
-    case HELIX310:
-      secstr[pos] = '3';
-      break;
-    case HELIX:
-    case HELIXALPHA:
-      secstr[pos] = 'H';
-      break;
-    case HELIXPI:
-      secstr[pos] = 'P';
-      break;
-    case SHEET:
-      secstr[pos] = 'E';
-      break;
-    default:
-      secstr[pos] = 0;
+      if (atom.getAtomName().equalsIgnoreCase("CA")
+              || atom.getAtomName().equalsIgnoreCase("P"))
+      {
+        Atom curAtom = new Atom(atom.x, atom.y, atom.z);
+        curAtom.atomIndex = atom.getIndex();
+        curAtom.chain = atom.getChainIDStr();
+        curAtom.insCode = atom.group.getInsertionCode();
+        curAtom.name = atom.getAtomName();
+        curAtom.number = atom.getAtomNumber();
+        curAtom.resName = atom.getGroup3(true);
+        curAtom.resNumber = atom.getResno();
+        curAtom.ss = getSecondayStructure(atom.group
+                .getProteinStructureSubType());
+        curAtom.occupancy = ms.occupancies != null ? ms.occupancies[atom
+                .getIndex()] : Float.valueOf(atom.getOccupancy100());
+        curAtom.resNumIns = "" + curAtom.resNumber + curAtom.insCode;
+        // curAtom.tfactor = atom.group.;
+        curAtom.type = 0;
+        significantAtoms.add(curAtom);
+      }
     }
+    return significantAtoms;
+  }
 
-    switch (proteinStructureSubType)
+  private void createAnnotation(SequenceI sequence, PDBChain chain,
+          org.jmol.modelset.Atom[] jmolAtoms)
+  {
+    char[] secstr = new char[sequence.getLength()];
+    char[] secstrcode = new char[sequence.getLength()];
+    for (Residue residue : chain.residues)
     {
-    case HELIX310:
-    case HELIXALPHA:
-    case HELIXPI:
-    case HELIX:
-      secstrcode[pos] = 'H';
-      break;
-    case SHEET:
-      secstrcode[pos] = 'E';
-      break;
-    default:
-      secstrcode[pos] = 0;
+
     }
+    addSecondaryStructureAnnotation(chain.pdbid, sequence, secstr,
+            secstrcode, chain.id, sequence.getStart());
   }
 
   /**
-   * Convert any non-standard peptide codes to their standard code table
-   * equivalent. (Initial version only does Selenomethionine MSE->MET.)
+   * Process the Jmol BioPolymer array and generate a Jalview sequence for each
+   * chain found (including any secondary structure annotation from DSSP)
    * 
-   * @param threeLetterCode
-   * @param seq
-   * @param pos
+   * @param ms
+   * @throws IOException
    */
-  protected void replaceNonCanonicalResidue(String threeLetterCode,
-          char[] seq, int pos)
+  public void parseBiopolymer(ModelSet ms) throws IOException
   {
-    String canonical = ResidueProperties
-            .getCanonicalAminoAcid(threeLetterCode);
-    if (canonical != null && !canonical.equalsIgnoreCase(threeLetterCode))
+    int modelIndex = -1;
+    for (Model model : ms.am)
     {
-      seq[pos] = ResidueProperties.getSingleCharacterCode(canonical);
+      modelIndex++;
+      String modelTitle = (String) ms.getInfo(modelIndex, "title");
+      /*
+       * Chains can span BioPolymers, so first make a flattened list, and then
+       * work out the lengths of chains present
+       */
+      List<Monomer> monomers = getMonomers(ms, (BioModel) model);
+      List<Integer> chainLengths = getChainLengths(monomers);
+
+      /*
+       * now chop up the Monomer list to make Jalview Sequences
+       */
+      int from = 0;
+      for (int length : chainLengths)
+      {
+        buildSequenceFromChain(monomers.subList(from, from + length),
+                modelTitle);
+        from += length;
+      }
     }
   }
 
   /**
-   * Not implemented - returns null
+   * Returns a flattened list of Monomer (residues) in order, across all
+   * BioPolymers in the model. This simplifies assembling chains which span
+   * BioPolymers. The result omits any alternate residues reported for the same
+   * sequence position (RESNUM value).
+   * 
+   * @param ms
+   * @param model
+   * @return
    */
-  @Override
-  public String print()
+  protected List<Monomer> getMonomers(ModelSet ms, BioModel model)
   {
-    return null;
+    List<Monomer> result = new ArrayList<Monomer>();
+    int lastResNo = Integer.MIN_VALUE;
+
+    for (BioPolymer bp : model.bioPolymers)
+    {
+      for (int groupLeadAtoms : bp.getLeadAtomIndices())
+      {
+        Group group = ms.at[groupLeadAtoms].group;
+        if (group instanceof Monomer)
+        {
+          /*
+           * ignore alternate residue at same position example: 1ejg has
+           * residues A:LEU, B:ILE at RESNUM=25
+           */
+          int resNo = group.getResno();
+          if (lastResNo != resNo)
+          {
+            result.add((Monomer) group);
+          }
+          lastResNo = resNo;
+        }
+      }
+    }
+    return result;
   }
 
   /**
-   * Not implemented
+   * Scans the list of Monomers (residue models), inspecting the chain id for
+   * each, and returns an array whose length is the number of chains, and values
+   * the length of each chain
+   * 
+   * @param monomers
+   * @return
    */
-  @Override
-  public void setCallbackFunction(String callbackType,
-          String callbackFunction)
+  protected List<Integer> getChainLengths(List<Monomer> monomers)
   {
-  }
+    List<Integer> chainLengths = new ArrayList<Integer>();
+    int lastChainId = -1;
+    int length = 0;
 
-  @Override
-  public void notifyCallback(CBK cbType, Object[] data)
-  {
-    String strInfo = (data == null || data[1] == null ? null : data[1]
-            .toString());
-    switch (cbType)
+    for (Monomer monomer : monomers)
     {
-    case ECHO:
-      sendConsoleEcho(strInfo);
-      break;
-    case SCRIPT:
-      notifyScriptTermination((String) data[2],
-              ((Integer) data[3]).intValue());
-      break;
-    case MEASURE:
-      String mystatus = (String) data[3];
-      if (mystatus.indexOf("Picked") >= 0
-              || mystatus.indexOf("Sequence") >= 0)
-      {
-        // Picking mode
-        sendConsoleMessage(strInfo);
-      }
-      else if (mystatus.indexOf("Completed") >= 0)
+      int chainId = monomer.chain.chainID;
+      if (chainId != lastChainId && length > 0)
       {
-        sendConsoleEcho(strInfo.substring(strInfo.lastIndexOf(",") + 2,
-                strInfo.length() - 1));
+        /*
+         * change of chain - record the length of the last one
+         */
+        chainLengths.add(length);
+        length = 0;
       }
-      break;
-    case MESSAGE:
-      sendConsoleMessage(data == null ? null : strInfo);
-      break;
-    case PICK:
-      sendConsoleMessage(strInfo);
-      break;
-    default:
-      break;
+      lastChainId = chainId;
+      length++;
+    }
+    if (length > 0)
+    {
+      /*
+       * record the length of the final chain
+       */
+      chainLengths.add(length);
     }
-  }
-
-  String lastConsoleEcho = "";
 
-  private void sendConsoleEcho(String string)
-  {
-    lastConsoleEcho += string;
-    lastConsoleEcho += "\n";
+    return chainLengths;
   }
 
-  String lastConsoleMessage = "";
-
-  private void sendConsoleMessage(String string)
+  /**
+   * Helper method to construct a sequence for one chain and add it to the seqs
+   * list
+   * 
+   * @param monomers
+   *          a list of all monomers in the chain
+   * @param modelTitle
+   */
+  protected void buildSequenceFromChain(List<Monomer> monomers,
+          String modelTitle)
   {
-    lastConsoleMessage += string;
-    lastConsoleMessage += "\n";
-  }
-
-  int lastScriptTermination = -1;
-
-  String lastScriptMessage = "";
-
-  private void notifyScriptTermination(String string, int intValue)
-  {
-    lastScriptMessage += string;
-    lastScriptMessage += "\n";
-    lastScriptTermination = intValue;
-  }
-
-  @Override
-  public boolean notifyEnabled(CBK callbackPick)
-  {
-    switch (callbackPick)
-    {
-    case MESSAGE:
-    case SCRIPT:
-    case ECHO:
-    case LOADSTRUCT:
-    case ERROR:
-      return true;
-    default:
-      return false;
-    }
-  }
-
-  /**
-   * Not implemented - returns null
-   */
-  @Override
-  public String eval(String strEval)
-  {
-    return null;
-  }
-
-  /**
-   * Not implemented - returns null
-   */
-  @Override
-  public float[][] functionXY(String functionName, int x, int y)
-  {
-    return null;
-  }
-
-  /**
-   * Not implemented - returns null
-   */
-  @Override
-  public float[][][] functionXYZ(String functionName, int nx, int ny, int nz)
-  {
-    return null;
-  }
-
-  /**
-   * Not implemented - returns null
-   */
-  @Override
-  public String createImage(String fileName, String imageType,
-          Object text_or_bytes, int quality)
-  {
-    return null;
-  }
-
-  /**
-   * Not implemented - returns null
-   */
-  @Override
-  public Map<String, Object> getRegistryInfo()
-  {
-    return null;
-  }
-
-  /**
-   * Not implemented
-   */
-  @Override
-  public void showUrl(String url)
-  {
-  }
-
-  /**
-   * Not implemented - returns null
-   */
-  @Override
-  public Dimension resizeInnerPanel(String data)
-  {
-    return null;
-  }
-
-  @Override
-  public Map<String, Object> getJSpecViewProperty(String arg0)
-  {
-    return null;
-  }
-
-  /**
-   * Calls the Jmol library to parse the PDB file, and then inspects the
-   * resulting object model to generate Jalview-style sequences, with secondary
-   * structure annotation added where available (i.e. where it has been computed
-   * by Jmol using DSSP).
-   * 
-   * @see jalview.io.AlignFile#parse()
-   */
-  @Override
-  public void parse() throws IOException
-  {
-
-    chains = new ArrayList<PDBChain>();
-    Viewer jmolModel = getJmolData();
-    jmolModel.openReader(getDataName(), getDataName(), getReader());
-    waitForScript(jmolModel);
-
-    /*
-     * Convert one or more Jmol Model objects to Jalview sequences
-     */
-    if (jmolModel.ms.mc > 0)
-    {
-      parseBiopolymers(jmolModel.ms);
-    }
-  }
-
-  /**
-   * Process the Jmol BioPolymer array and generate a Jalview sequence for each
-   * chain found (including any secondary structure annotation from DSSP)
-   * 
-   * @param ms
-   * @throws IOException
-   */
-  public void parseBiopolymers(ModelSet ms) throws IOException
-  {
-    int modelIndex = -1;
-    for (Model model : ms.am)
-    {
-      modelIndex++;
-      String modelTitle = (String) ms.getInfo(modelIndex, "title");
-
-      /*
-       * Chains can span BioPolymers, so first make a flattened list, 
-       * and then work out the lengths of chains present
-       */
-      List<Monomer> monomers = getMonomers(ms, (BioModel) model);
-      List<Integer> chainLengths = getChainLengths(monomers);
-
-      /*
-       * now chop up the Monomer list to make Jalview Sequences
-       */
-      int from = 0;
-      for (int length : chainLengths)
-      {
-        buildSequenceFromChain(monomers.subList(from, from + length), modelTitle);
-        from += length;
-      }
-    }
-  }
-
-  /**
-   * Helper method to construct a sequence for one chain and add it to the seqs
-   * list
-   * 
-   * @param monomers
-   *          a list of all monomers in the chain
-   * @param modelTitle
-   */
-  protected void buildSequenceFromChain(List<Monomer> monomers, String modelTitle)
-  {
-    final int length = monomers.size();
+    final int length = monomers.size();
 
     /*
      * arrays to hold sequence and secondary structure
@@ -468,8 +413,7 @@ public class JmolParser extends AlignFile implements
     /*
      * construct and add the Jalview sequence
      */
-    String seqName = "" + modelTitle + "|"
-            + chainId;
+    String seqName = "" + modelTitle + "|" + chainId;
     int start = firstResNum;
     int end = firstResNum + length - 1;
 
@@ -481,25 +425,68 @@ public class JmolParser extends AlignFile implements
 
     seqs.add(sq);
 
-    addChainMetaData(sq, monomers, chainId);
-
     /*
      * add secondary structure predictions (if any)
      */
-    if (isPredictSecondaryStructure())
-    {
       addSecondaryStructureAnnotation(modelTitle, sq, secstr, secstrcode,
-            chainId, firstResNum);
-    }
+              chainId, firstResNum);
 
   }
 
-  public void addChainMetaData(SequenceI sq, List<Monomer> monomers,
-          String chainId)
+  /**
+   * Scans the list of (Jmol) Monomer objects, and adds the residue for each to
+   * the sequence array, and any converted secondary structure prediction to the
+   * secondary structure arrays
+   * 
+   * @param monomers
+   * @param seq
+   * @param secstr
+   * @param secstrcode
+   */
+  protected void extractJmolChainData(List<Monomer> monomers, char[] seq,
+          char[] secstr, char[] secstrcode)
   {
-    for (char res : sq.getSequence())
+    int pos = 0;
+    for (Monomer monomer : monomers)
     {
+      seq[pos] = monomer.getGroup1();
+
+      /*
+       * JAL-1828 replace a modified amino acid with its standard equivalent
+       * (e.g. MSE with MET->M) to maximise sequence matching
+       */
+      replaceNonCanonicalResidue(monomer.getGroup3(), seq, pos);
+
+      /*
+       * if Jmol has derived a secondary structure prediction for this position,
+       * convert it to Jalview equivalent and save it
+       */
+      setSecondaryStructure(monomer.getProteinStructureSubType(), pos,
+              secstr, secstrcode);
+      pos++;
+    }
+  }
+
+  /**
+   * Replace any non-gap miscellaneous characters with 'X'
+   * 
+   * @param seq
+   * @return
+   */
+  protected void convertNonGapCharacters(char[] seq)
+  {
+    boolean isNa = Comparison.areNucleotide(new char[][] { seq });
+    int[] cinds = isNa ? ResidueProperties.nucleotideIndex
+            : ResidueProperties.aaIndex;
+    int nonGap = isNa ? ResidueProperties.maxNucleotideIndex
+            : ResidueProperties.maxProteinIndex;
 
+    for (int p = 0; p < seq.length; p++)
+    {
+      if (cinds[seq[p]] == nonGap)
+      {
+        seq[p] = 'X';
+      }
     }
   }
 
@@ -523,7 +510,6 @@ public class JmolParser extends AlignFile implements
     sq.addDBRef(sourceDBRef);
   }
 
-
   /**
    * Add a PDBEntry giving the source of PDB data to the sequence
    * 
@@ -555,39 +541,6 @@ public class JmolParser extends AlignFile implements
     sq.addPDBId(entry);
   }
 
-  /**
-   * Scans the list of (Jmol) Monomer objects, and adds the residue for each to
-   * the sequence array, and any converted secondary structure prediction to the
-   * secondary structure arrays
-   * 
-   * @param monomers
-   * @param seq
-   * @param secstr
-   * @param secstrcode
-   */
-  protected void extractJmolChainData(List<Monomer> monomers, char[] seq,
-          char[] secstr, char[] secstrcode)
-  {
-    int pos = 0;
-    for (Monomer monomer : monomers)
-    {
-      seq[pos] = monomer.getGroup1();
-
-      /*
-       * JAL-1828 replace a modified amino acid with its standard
-       * equivalent (e.g. MSE with MET->M) to maximise sequence matching
-       */
-      replaceNonCanonicalResidue(monomer.getGroup3(), seq, pos);
-
-      /*
-       * if Jmol has derived a secondary structure prediction for
-       * this position, convert it to Jalview equivalent and save it
-       */
-      setSecondaryStructure(monomer.getProteinStructureSubType(), pos,
-              secstr, secstrcode);
-      pos++;
-    }
-  }
 
   /**
    * Helper method that adds an AlignmentAnnotation for secondary structure to
@@ -603,8 +556,8 @@ public class JmolParser extends AlignFile implements
    * @return
    */
   protected void addSecondaryStructureAnnotation(String modelTitle,
-          SequenceI sq, char[] secstr, char[] secstrcode,
-          String chainId, int firstResNum)
+          SequenceI sq, char[] secstr, char[] secstrcode, String chainId,
+          int firstResNum)
   {
     char[] seq = sq.getSequence();
     boolean ssFound = false;
@@ -637,125 +590,281 @@ public class JmolParser extends AlignFile implements
     }
   }
 
-  /**
-   * Replace any non-gap miscellaneous characters with 'X'
-   * 
-   * @param seq
-   * @return
-   */
-  protected void convertNonGapCharacters(char[] seq)
+  private void waitForScript(Viewer jmd)
   {
-    boolean isNa = Comparison.areNucleotide(new char[][] { seq });
-    int[] cinds = isNa ? ResidueProperties.nucleotideIndex
-            : ResidueProperties.aaIndex;
-    int nonGap = isNa ? ResidueProperties.maxNucleotideIndex
-            : ResidueProperties.maxProteinIndex;
-
-    for (int p = 0; p < seq.length; p++)
+    while (jmd.isScriptExecuting())
     {
-      if (cinds[seq[p]] == nonGap)
+      try
+      {
+        Thread.sleep(50);
+
+      } catch (InterruptedException x)
       {
-        seq[p] = 'X';
       }
     }
   }
 
-
   /**
-   * Scans the list of Monomers (residue models), inspecting the chain id for
-   * each, and returns an array whose length is the number of chains, and values
-   * the length of each chain
+   * Convert Jmol's secondary structure code to Jalview's, and stored it in the
+   * secondary structure arrays at the given sequence position
    * 
-   * @param monomers
-   * @return
+   * @param proteinStructureSubType
+   * @param pos
+   * @param secstr
+   * @param secstrcode
    */
-  protected List<Integer> getChainLengths(List<Monomer> monomers)
+  protected void setSecondaryStructure(STR proteinStructureSubType,
+          int pos, char[] secstr, char[] secstrcode)
   {
-    List<Integer> chainLengths = new ArrayList<Integer>();
-    int lastChainId = -1;
-    int length = 0;
-
-    for (Monomer monomer : monomers)
+    switch (proteinStructureSubType)
     {
-      int chainId = monomer.chain.chainID;
-      if (chainId != lastChainId && length > 0)
-      {
-        /*
-         * change of chain - record the length of the last one
-         */
-        chainLengths.add(length);
-        length = 0;
-      }
-      lastChainId = chainId;
-      length++;
+    case HELIX310:
+      secstr[pos] = '3';
+      break;
+    case HELIX:
+    case HELIXALPHA:
+      secstr[pos] = 'H';
+      break;
+    case HELIXPI:
+      secstr[pos] = 'P';
+      break;
+    case SHEET:
+      secstr[pos] = 'E';
+      break;
+    default:
+      secstr[pos] = 0;
     }
-    if (length > 0)
+
+    switch (proteinStructureSubType)
     {
-      /*
-       * record the length of the final chain
-       */
-      chainLengths.add(length);
+    case HELIX310:
+    case HELIXALPHA:
+    case HELIXPI:
+    case HELIX:
+      secstrcode[pos] = 'H';
+      break;
+    case SHEET:
+      secstrcode[pos] = 'E';
+      break;
+    default:
+      secstrcode[pos] = 0;
     }
+  }
 
-    return chainLengths;
+  private char getSecondayStructure(STR proteinStructureSubType)
+  {
+    switch (proteinStructureSubType)
+    {
+    case HELIX310:
+      return '3';
+    case HELIX:
+    case HELIXALPHA:
+      return 'H';
+    case HELIXPI:
+      return 'P';
+    case SHEET:
+      return 'E';
+    default:
+      return 0;
+    }
   }
 
   /**
-   * Returns a flattened list of Monomer (residues) in order, across all
-   * BioPolymers in the model. This simplifies assembling chains which span
-   * BioPolymers. The result omits any alternate residues reported for the same
-   * sequence position (RESNUM value).
+   * Convert any non-standard peptide codes to their standard code table
+   * equivalent. (Initial version only does Selenomethionine MSE->MET.)
    * 
-   * @param ms
-   * @param model
-   * @return
+   * @param threeLetterCode
+   * @param seq
+   * @param pos
    */
-  protected List<Monomer> getMonomers(ModelSet ms, BioModel model)
+  protected void replaceNonCanonicalResidue(String threeLetterCode,
+          char[] seq, int pos)
   {
-    List<Monomer> result = new ArrayList<Monomer>();
-    int lastResNo = Integer.MIN_VALUE;
+    String canonical = ResidueProperties
+            .getCanonicalAminoAcid(threeLetterCode);
+    if (canonical != null && !canonical.equalsIgnoreCase(threeLetterCode))
+    {
+      seq[pos] = ResidueProperties.getSingleCharacterCode(canonical);
+    }
+  }
 
-    for (BioPolymer bp : model.bioPolymers)
+  /**
+   * Not implemented - returns null
+   */
+  @Override
+  public String print()
+  {
+    return null;
+  }
+
+  /**
+   * Not implemented
+   */
+  @Override
+  public void setCallbackFunction(String callbackType,
+          String callbackFunction)
+  {
+  }
+
+  @Override
+  public void notifyCallback(CBK cbType, Object[] data)
+  {
+    String strInfo = (data == null || data[1] == null ? null : data[1]
+            .toString());
+    switch (cbType)
     {
-      for (int groupLeadAtoms : bp.getLeadAtomIndices())
+    case ECHO:
+      sendConsoleEcho(strInfo);
+      break;
+    case SCRIPT:
+      notifyScriptTermination((String) data[2],
+              ((Integer) data[3]).intValue());
+      break;
+    case MEASURE:
+      String mystatus = (String) data[3];
+      if (mystatus.indexOf("Picked") >= 0
+              || mystatus.indexOf("Sequence") >= 0)
       {
-        Group group = ms.at[groupLeadAtoms].group;
-        if (group instanceof Monomer)
-        {
-          /*
-           * ignore alternate residue at same position
-           * example: 1ejg has residues A:LEU, B:ILE at RESNUM=25
-           */
-          int resNo = group.getResno();
-          if (lastResNo != resNo)
-          {
-            result.add((Monomer) group);
-          }
-          lastResNo = resNo;
-        }
+        // Picking mode
+        sendConsoleMessage(strInfo);
+      }
+      else if (mystatus.indexOf("Completed") >= 0)
+      {
+        sendConsoleEcho(strInfo.substring(strInfo.lastIndexOf(",") + 2,
+                strInfo.length() - 1));
       }
+      break;
+    case MESSAGE:
+      sendConsoleMessage(data == null ? null : strInfo);
+      break;
+    case PICK:
+      sendConsoleMessage(strInfo);
+      break;
+    default:
+      break;
     }
-    return result;
   }
 
-  public boolean isPredictSecondaryStructure()
+  String lastConsoleEcho = "";
+
+  private void sendConsoleEcho(String string)
   {
-    return predictSecondaryStructure;
+    lastConsoleEcho += string;
+    lastConsoleEcho += "\n";
   }
 
-  public void setPredictSecondaryStructure(boolean predictSecondaryStructure)
+  String lastConsoleMessage = "";
+
+  private void sendConsoleMessage(String string)
   {
-    this.predictSecondaryStructure = predictSecondaryStructure;
+    lastConsoleMessage += string;
+    lastConsoleMessage += "\n";
+  }
+
+  int lastScriptTermination = -1;
+
+  String lastScriptMessage = "";
+
+  private void notifyScriptTermination(String string, int intValue)
+  {
+    lastScriptMessage += string;
+    lastScriptMessage += "\n";
+    lastScriptTermination = intValue;
   }
 
-  public Collection<PDBChain> getChains()
+  @Override
+  public boolean notifyEnabled(CBK callbackPick)
   {
-    return chains;
+    switch (callbackPick)
+    {
+    case MESSAGE:
+    case SCRIPT:
+    case ECHO:
+    case LOADSTRUCT:
+    case ERROR:
+      return true;
+    default:
+      return false;
+    }
   }
 
-  public void setChains(Collection<PDBChain> chains)
+  /**
+   * Not implemented - returns null
+   */
+  @Override
+  public String eval(String strEval)
   {
-    this.chains = chains;
+    return null;
+  }
+
+  /**
+   * Not implemented - returns null
+   */
+  @Override
+  public float[][] functionXY(String functionName, int x, int y)
+  {
+    return null;
+  }
+
+  /**
+   * Not implemented - returns null
+   */
+  @Override
+  public float[][][] functionXYZ(String functionName, int nx, int ny, int nz)
+  {
+    return null;
+  }
+
+  /**
+   * Not implemented - returns null
+   */
+  @Override
+  public String createImage(String fileName, String imageType,
+          Object text_or_bytes, int quality)
+  {
+    return null;
+  }
+
+  /**
+   * Not implemented - returns null
+   */
+  @Override
+  public Map<String, Object> getRegistryInfo()
+  {
+    return null;
+  }
+
+  /**
+   * Not implemented
+   */
+  @Override
+  public void showUrl(String url)
+  {
+  }
+
+  /**
+   * Not implemented - returns null
+   */
+  @Override
+  public Dimension resizeInnerPanel(String data)
+  {
+    return null;
+  }
+
+  @Override
+  public Map<String, Object> getJSpecViewProperty(String arg0)
+  {
+    return null;
+  }
+
+  public boolean isPredictSecondaryStructure()
+  {
+    return predictSecondaryStructure;
+  }
+
+  public void setPredictSecondaryStructure(boolean predictSecondaryStructure)
+  {
+    this.predictSecondaryStructure = predictSecondaryStructure;
   }
 
 }