X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=src%2Fjalview%2Fdatamodel%2FAlignmentI.java;h=975f9facf8100307be69035eb9986ab74ca132c1;hb=b2f9a8d7bce642ff4011bc6d49e02bb0569fbb11;hp=05d3a1046efd17e956d0a52cc330f67f56f0e70a;hpb=478701c9ed0354b27e4cd74789f8c01a5c9ff004;p=jalview.git diff --git a/src/jalview/datamodel/AlignmentI.java b/src/jalview/datamodel/AlignmentI.java index 05d3a10..975f9fa 100755 --- a/src/jalview/datamodel/AlignmentI.java +++ b/src/jalview/datamodel/AlignmentI.java @@ -1,19 +1,20 @@ /* - * Jalview - A Sequence Alignment Editor and Viewer (Version 2.6) - * Copyright (C) 2010 J Procter, AM Waterhouse, G Barton, M Clamp, S Searle + * Jalview - A Sequence Alignment Editor and Viewer (Version 2.8.1) + * Copyright (C) 2014 The Jalview Authors * * 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 . + * The Jalview Authors are detailed in the 'AUTHORS' file. */ package jalview.datamodel; @@ -22,7 +23,7 @@ import java.util.*; /** * Data structure to hold and manipulate a multiple sequence alignment */ -public interface AlignmentI +public interface AlignmentI extends AnnotatedCollectionI { /** * Calculates the number of sequences in an alignment @@ -36,6 +37,7 @@ public interface AlignmentI * * @return Greatest sequence length within alignment. */ + @Override public int getWidth(); /** @@ -56,11 +58,12 @@ public interface AlignmentI public boolean isAligned(boolean includeHidden); /** - * Gets sequences as a Vector + * Gets sequences as a Synchronized collection * * @return All sequences in alignment. */ - public Vector getSequences(); + @Override + public List getSequences(); /** * Gets sequences as a SequenceI[] @@ -175,9 +178,9 @@ public interface AlignmentI /** * Get all the groups associated with this alignment. * - * @return All groups as a Vector. + * @return All groups as a list. */ - public Vector getGroups(); + public List getGroups(); /** * Deletes all groups from this alignment. @@ -236,6 +239,7 @@ public interface AlignmentI * * @return array of AlignmentAnnotation objects */ + @Override public AlignmentAnnotation[] getAlignmentAnnotation(); /** @@ -431,4 +435,45 @@ public interface AlignmentI * @param i */ public void addAnnotation(AlignmentAnnotation consensus, int i); + + /** + * search for or create a specific annotation row on the alignment + * + * @param name + * name for annotation (must match) + * @param calcId + * calcId for the annotation (null or must match) + * @param autoCalc + * - value of autocalc flag for the annotation + * @param seqRef + * - null or specific sequence reference + * @param groupRef + * - null or specific group reference + * @param method + * - CalcId for the annotation (must match) + * + * @return existing annotation matching the given attributes + */ + public AlignmentAnnotation findOrCreateAnnotation(String name, + String calcId, boolean autoCalc, SequenceI seqRef, + SequenceGroup groupRef); + + /** + * move the given group up or down in the alignment by the given number of + * rows. Implementor assumes given group is already present on alignment - no + * recalculations are triggered. + * + * @param sg + * @param map + * @param up + * @param i + */ + public void moveSelectedSequencesByOne(SequenceGroup sg, + Map map, boolean up); + + /** + * validate annotation after an edit and update any alignment state flags accordingly + * @param alignmentAnnotation + */ + public void validateAnnotation(AlignmentAnnotation alignmentAnnotation); }