X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;ds=inline;f=src%2Fjalview%2Fdatamodel%2FAlignedCodonFrame.java;h=335621f77221ff4f841f6885a6aca2061bf3e70f;hb=aeb173dd7daa4559e760548d955ee83aac6828d8;hp=6c6c26eb7b53a8b5b5b0e3a46c81a0f2b73f045a;hpb=6bbd76f4f20e5a69aa4359837af78474144877fc;p=jalview.git
diff --git a/src/jalview/datamodel/AlignedCodonFrame.java b/src/jalview/datamodel/AlignedCodonFrame.java
index 6c6c26e..335621f 100644
--- a/src/jalview/datamodel/AlignedCodonFrame.java
+++ b/src/jalview/datamodel/AlignedCodonFrame.java
@@ -1,3 +1,20 @@
+/*
+ * Jalview - A Sequence Alignment Editor and Viewer (Version 2.7)
+ * Copyright (C) 2011 J Procter, AM Waterhouse, J Engelhardt, LM Lui, G Barton, M Clamp, S Searle
+ *
+ * This file is part of Jalview.
+ *
+ * Jalview 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.
+ *
+ * Jalview 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 Jalview. If not, see .
+ */
package jalview.datamodel;
import java.util.Enumeration;
@@ -13,25 +30,29 @@ import jalview.util.MapList;
public class AlignedCodonFrame
{
/**
- * array of nucleotide positions for aligned codons at column of aligned proteins.
+ * array of nucleotide positions for aligned codons at column of aligned
+ * proteins.
*/
public int[][] codons = null;
+
/**
- * width of protein sequence alignement
- * implicit assertion that codons.length >= aaWidth
+ * width of protein sequence alignement implicit assertion that codons.length
+ * >= aaWidth
*/
- public int aaWidth=0;
+ public int aaWidth = 0;
+
/**
* initialise codon frame with a nominal alignment width
+ *
* @param aWidth
*/
public AlignedCodonFrame(int aWidth)
{
- if (aWidth<=0)
- {
- codons=null;
+ if (aWidth <= 0)
+ {
+ codons = null;
return;
- }
+ }
codons = new int[aWidth][];
for (int res = 0; res < aWidth; res++)
codons[res] = null;
@@ -39,6 +60,7 @@ public class AlignedCodonFrame
/**
* ensure that codons array is at least as wide as aslen residues
+ *
* @param aslen
* @return (possibly newly expanded) codon array
*/
@@ -57,29 +79,37 @@ public class AlignedCodonFrame
}
return codons;
}
+
/**
- * @return width of aligned translated amino acid residues
+ * @return width of aligned translated amino acid residues
*/
public int getaaWidth()
{
return aaWidth;
}
+
/**
- * TODO: not an ideal solution - we reference the aligned amino acid sequences in order to make insertions on them
- * Better would be dnaAlignment and aaAlignment reference....
+ * TODO: not an ideal solution - we reference the aligned amino acid sequences
+ * in order to make insertions on them Better would be dnaAlignment and
+ * aaAlignment reference....
*/
- Vector a_aaSeqs=new Vector();
+ Vector a_aaSeqs = new Vector();
+
/**
- * increase aaWidth by one and insert a new aligned codon position space at aspos.
+ * increase aaWidth by one and insert a new aligned codon position space at
+ * aspos.
+ *
* @param aspos
*/
public void insertAAGap(int aspos, char gapCharacter)
- {
- // this aa appears before the aligned codons at aspos - so shift them in each pair of mapped sequences
+ {
+ // this aa appears before the aligned codons at aspos - so shift them in
+ // each pair of mapped sequences
aaWidth++;
- if (a_aaSeqs!=null)
+ if (a_aaSeqs != null)
{
- // we actually have to modify the aligned sequences here, so use the a_aaSeqs vector
+ // we actually have to modify the aligned sequences here, so use the
+ // a_aaSeqs vector
Enumeration sq = a_aaSeqs.elements();
while (sq.hasMoreElements())
{
@@ -87,11 +117,11 @@ public class AlignedCodonFrame
}
}
checkCodonFrameWidth(aspos);
- if (aspos