X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=src%2Fjalview%2Fdatamodel%2FAlignmentI.java;h=e99563b9586694800c734989812d3b84c655f9b1;hb=HEAD;hp=cfc45ae679cae36a5ea9487c99a646c0174c9b7a;hpb=09cce494f72431183bd3c37e77913170a08c3ac3;p=jalview.git diff --git a/src/jalview/datamodel/AlignmentI.java b/src/jalview/datamodel/AlignmentI.java index cfc45ae..e99563b 100755 --- a/src/jalview/datamodel/AlignmentI.java +++ b/src/jalview/datamodel/AlignmentI.java @@ -5,16 +5,16 @@ * 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 License + * 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 License for more details. + * PURPOSE. See the GNU General Public License for more details. * - * You should have received a copy of the GNU General License + * You should have received a copy of the GNU General Public License * along with Jalview. If not, see . * The Jalview Authors are detailed in the 'AUTHORS' file. */ @@ -48,15 +48,29 @@ public interface AlignmentI extends AnnotatedCollectionI /** * - * Calculates the maximum width of the alignment, including gaps. + * Answers the width of the alignment, including gaps, that is, the length of + * the longest sequence, or -1 if there are no sequences. Avoid calling this + * method repeatedly where possible, as it has to perform a calculation. Note + * that this width includes any hidden columns. * - * @return Greatest sequence length within alignment, or -1 if no sequences - * present + * @return + * @see AlignmentI#getVisibleWidth() */ @Override int getWidth(); /** + * + * Answers the visible width of the alignment, including gaps, that is, the + * length of the longest sequence, excluding any hidden columns. Answers -1 if + * there are no sequences. Avoid calling this method repeatedly where + * possible, as it has to perform a calculation. + * + * @return + */ + int getVisibleWidth(); + + /** * Calculates if this set of sequences (visible and invisible) are all the * same length * @@ -581,25 +595,32 @@ public interface AlignmentI extends AnnotatedCollectionI AlignedCodonFrame getMapping(SequenceI mapFrom, SequenceI mapTo); /** - * Calculate the visible start and end index of an alignment. The result is - * returned an int array where: int[0] = startIndex, and int[1] = endIndex. + * Set the hidden columns collection on the alignment. Answers true if the + * hidden column selection changed, else false. * - * @param hiddenCols + * @param cols * @return */ - public int[] getVisibleStartAndEndIndex(List hiddenCols); + public boolean setHiddenColumns(HiddenColumns cols); /** - * resolve a contact list instance (if any) associated with the annotation row - * and column position - * - * @param _aa - * @param column - * @return + * Set the first sequence as representative and hide its insertions. Typically + * used when loading JPred files. */ - ContactListI getContactListFor(AlignmentAnnotation _aa, int column); - - AlignmentAnnotation addContactList(ContactMatrixI cm); + public void setupJPredAlignment(); - public void setHiddenColumns(HiddenColumns cols); + /** + * Add gaps into the sequences aligned to profileseq under the given + * AlignmentView + * + * @param profileseq + * sequence in al which sequences are aligned to + * @param input + * alignment view where sequence corresponding to profileseq is first + * entry + * @return new HiddenColumns for new alignment view, with insertions into + * profileseq marked as hidden. + */ + public HiddenColumns propagateInsertions(SequenceI profileseq, + AlignmentView input); }