public interface EditableSequenceListDocument extends SequenceListDocument
SequenceListDocument that can have its
internal lists of nucleotide and amino acid sequences reordered, added to, or removed from.
Most implementations should instead extend a ExtendedEditableSequenceListDocument
to allow modifying of individual sequences in a SequenceListDocument.| Modifier and Type | Method and Description |
|---|---|
void |
addAminoAcidSequence(AminoAcidSequenceDocument sequence)
Adds the given amino acid sequence to the end of the list of amino acid sequences in this document
Note that using this method will require loading the entire sequence list into memory, which
might not be possible on large sequence lists.
|
void |
addNucleotideSequence(NucleotideSequenceDocument sequence)
Adds the given nucleotide sequence to the end of the list of nucleotide sequences in this document
Note that using this method will require loading the entire sequence list into memory, which
might not be possible on large sequence lists.
|
int |
getOrderingRevisionNumber()
Return a revision number that is incremented each time sequences are reordered or removed from this sequence list.
|
void |
removeAminoAcidSequence(int index)
Removes the amino acid sequence at the given index from this sequence list and shifts any subsequent sequences to the left (subtracts one from their indices).
|
void |
removeNucleotideSequence(int index)
Removes the nucleotide sequence at the given index from this sequence list and shifts any subsequent sequences to the left (subtracts one from their indices).
|
void |
reorderAminoAcidSequences(int[] ordering)
Adjusts the ordering of sequences in this list according to the ordering array.
|
void |
reorderNucleotideSequences(int[] ordering)
Adjusts the ordering of sequences in this list according to the ordering array.
|
getAminoAcidSequences, getNucleotideSequencesvoid reorderNucleotideSequences(int[] ordering)
SequenceAlignmentDocument.reorderSequences(int[])
Note that using this method will require loading the entire sequence list into memory, which
might not be possible on large sequence lists. See DefaultSequenceListDocument.replaceContents for a discussion on efficiently
handling editing large sequence lists.ordering - Each integer between 0 and ordering.length - 1 inclusive should occur exactly once in this array.reorderAminoAcidSequences(int[]),
SequenceAlignmentDocument.reorderSequences(int[])void reorderAminoAcidSequences(int[] ordering)
DefaultAlignmentDocument.reorderSequences(int[])
Note that using this method will require loading the entire sequence list into memory, which
might not be possible on large sequence lists. See DefaultSequenceListDocument.replaceContents for a discussion on efficiently
handling editing large sequence lists.ordering - Each integer between 0 and ordering.length - 1 inclusive should occur exactly once in this array.reorderNucleotideSequences(int[]),
SequenceAlignmentDocument.reorderSequences(int[])void removeNucleotideSequence(int index)
DefaultSequenceListDocument.replaceContents for a discussion on efficiently
handling editing large sequence lists.index - the index of the nucleotide sequence to remove.void removeAminoAcidSequence(int index)
DefaultSequenceListDocument.replaceContents for a discussion on efficiently
handling editing large sequence lists.index - the index of the amino acid sequence to remove.void addNucleotideSequence(NucleotideSequenceDocument sequence)
DefaultSequenceListDocument.replaceContents for a discussion on efficiently
handling editing large sequence lists.sequence - the nucleotide sequence to addvoid addAminoAcidSequence(AminoAcidSequenceDocument sequence)
DefaultSequenceListDocument.replaceContents for a discussion on efficiently
handling editing large sequence lists.sequence - the amino acid sequence to addint getOrderingRevisionNumber()
DocumentField.SEQUENCE_LIST_ORDERING_REVISION_NUMBER