info.bioinfweb.libralign.model.implementations.swingundo

Class SwingUndoAlignmentModel<T>

java.lang.Object

info.bioinfweb.libralign.model.implementations.AbstractAlignmentModel<T>

info.bioinfweb.libralign.model.implementations.swingundo.SwingUndoAlignmentModel<T>

Type Parameters:

T - the type of sequence elements (tokens) the implementing provider object works with

All Implemented Interfaces:

AlignmentModel<T>, AlignmentModelView<T,T>, BasicAlignmentModelView<T>

public class SwingUndoAlignmentModel<T>
extends AbstractAlignmentModel<T>
implements AlignmentModel<T>, AlignmentModelView<T,T>

An implementation of AlignmentModel that creates an UndoableEdit object for every modification that is made to the underlying data source using any of the methods specified by AlignmentModel. These edit objects are created every time a modification method is called and delegate to the modification methods of another implementation of AlignmentModel which has to be provided on creation. This second instance is responsible for the actual manipulation of the underlying data source. (All non-modifying methods are directly delegated to the underlying instance.)

Important: The modification methods of the specified underlying AlignmentModel implementation that performs the actual data manipulation must never be called directly, because that would change the state of the data without generating an edit object. In that case the undo methods of the edit objects would be useless because the would work on an unexpected data state.

This class does not store an UndoManager. It has to be provided by the inherited class or the application using the inherited class.

By default this class generated default edit objects included in LibrAlign. If you want it to generate custom edit objects (e.g. wrappers around the LibrAlign edit objects matching the needs of your application) you would have to provide an SwingEditFactory which creates custom objects.

Since UndoableEdit and UndoManager have not really any Swing specific prerequisites, these classes could also be used to track the undo history in an SWT application.

Since:

0.1.0

Author:

Ben Stöver

Field Summary

Fields

Modifier and Type	Field and Description
protected AlignmentModel<T>	underlyingModel

Constructor Summary

Constructors

Constructor and Description
SwingUndoAlignmentModel(AlignmentModel<T> underlyingModel, javax.swing.undo.UndoManager undoManager) Creates a new instance of this class which creates default LibrAlign edit objects.
SwingUndoAlignmentModel(AlignmentModel<T> underlyingModel, javax.swing.undo.UndoManager undoManager, SwingEditFactory<T> editFactory) Creates a new instance of this class which creates new edit objects using the provided SwingEditFactory.

Method Summary

Modifier and Type	Method and Description
java.lang.String	addSequence(java.lang.String sequenceName) Adds a new empty sequence to the underlying data source and generates an ID for it.
java.lang.String	addSequence(java.lang.String sequenceName, java.lang.String sequenceID) Adds a new empty sequence to the underlying data source assigning the specified ID to it.
void	appendToken(java.lang.String sequenceID, T token) Appends a token at the end of the sequence.
void	appendTokens(java.lang.String sequenceID, java.util.Collection<? extends T> tokens) Appends a sequence of tokens starting at the end of the current sequence.
boolean	containsSequence(java.lang.String sequenceID) Checks if a sequence associated with the specified unique identifier is contained in this model.
SwingEditFactory<T>	getEditFactory() Returns the edit factory used by this instance to create new edit objects, if one was passed to when this instance was created.
java.lang.String	getLabel() Returns a string labeling this alignment.
int	getMaxSequenceLength() Returns the length of the longest sequence in the alignment which is equivalent to the length of the alignment.
int	getSequenceCount() Returns the number of sequences in the underlying data source.
int	getSequenceLength(java.lang.String sequenceID) Returns the length of the specified sequence.
T	getTokenAt(java.lang.String sequenceID, int index) Returns the token at the specified position.
TokenSet<T>	getTokenSet() Returns the token set which is supported by the implementation.
AlignmentModel<T>	getUnderlyingModel() Returns the underlying sequence data provider used to perform the actual manipulation of the data.
javax.swing.undo.UndoManager	getUndoManager() Returns the undo manager used by this instance.
AlignmentModelWriteType	getWriteType() Returns a value that specifies if whole sequences or single tokens can be edited in the underlying data source.
boolean	hasEditFactory() Checks if this instance uses a custom edit factory to create new edit objects.
void	insertTokenAt(java.lang.String sequenceID, int index, T token) Inserts a token at the specified position.
void	insertTokensAt(java.lang.String sequenceID, int beginIndex, java.util.Collection<? extends T> tokens) Inserts a sequence of tokens starting at the specified position.
boolean	isSequencesReadOnly() Checks of whole sequences can be changed in the underlying data source
boolean	isTokensReadOnly() Checks of tokens can be changed in the underlying data source
void	registerDocumentChange() This method is called every time the redo or undo methods of any of the edit objects generated by this class are executed.
boolean	removeSequence(java.lang.String sequenceID) Removes the specified sequence from the underlying data source.
void	removeTokenAt(java.lang.String sequenceID, int index) Removes the token at the specified position from the underlying data source.
void	removeTokensAt(java.lang.String sequenceID, int beginIndex, int endIndex) Removes the token inside the specified interval from the underlying data source.
java.lang.String	renameSequence(java.lang.String sequenceID, java.lang.String newSequenceName) Renames a sequence in the underlying data source.
java.util.Iterator<java.lang.String>	sequenceIDIterator() Returns an iterator over unique IDs of all sequences contained in the underlying data source in the order they are stored in this model.
java.util.Set<java.lang.String>	sequenceIDsByName(java.lang.String sequenceName) Returns the set of unique sequence IDs associated with the specified name.
java.lang.String	sequenceNameByID(java.lang.String sequenceID) Returns the sequence name (that would be visible to the application user) associated with the specified unique ID.
void	setLabel(java.lang.String label) Allows to specify a new label for this alignment.
void	setTokenAt(java.lang.String sequenceID, int index, T token) Replaces the token at the specified position by the passed token.
void	setTokensAt(java.lang.String sequenceID, int beginIndex, java.util.Collection<? extends T> tokens) Replaces a sequence of tokens starting at the specified position.
void	setTokenSet(TokenSet<T> set) Replaces the current token set with the specified one.

Methods inherited from class info.bioinfweb.libralign.model.implementations.AbstractAlignmentModel

fireAfterSequenceChange, fireAfterSequenceRenamed, fireAfterTokenChange, getChangeListeners, getID, setID

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface info.bioinfweb.libralign.model.AlignmentModel

getChangeListeners, getID, setID

Field Detail

underlyingModel

protected AlignmentModel<T> underlyingModel

Constructor Detail

SwingUndoAlignmentModel

public SwingUndoAlignmentModel(AlignmentModel<T> underlyingModel,
                               javax.swing.undo.UndoManager undoManager,
                               SwingEditFactory<T> editFactory)

Creates a new instance of this class which creates new edit objects using the provided SwingEditFactory.

Parameters:

underlyingModel - the alignment model used to perform the actual manipulation of the data (It must be able to write at least one of sequences or tokens.)

undoManager - the undo manager that will store the generated edit objects

editFactory - the custom edit factory that shall be used to create new edit objects

Throws:

java.lang.IllegalArgumentException - if provider does not allow to write sequences and tokens (If only one of both is forbidden no exception will be thrown.)

java.lang.NullPointerException - if null is specified for undoManager

SwingUndoAlignmentModel

public SwingUndoAlignmentModel(AlignmentModel<T> underlyingModel,
                               javax.swing.undo.UndoManager undoManager)

Creates a new instance of this class which creates default LibrAlign edit objects.

Parameters:

underlyingModel - the alignment model used to perform the actual manipulation of the data (It must be able to write at least one of sequences or tokens.)

undoManager - the undo manager that will store the generated edit objects

Throws:

java.lang.IllegalArgumentException - if provider does not allow to write sequences and tokens (If only one of both is forbidden no exception will be thrown.)

java.lang.NullPointerException - if null is specified for undoManager

Method Detail

getUnderlyingModel

public AlignmentModel<T> getUnderlyingModel()

Returns the underlying sequence data provider used to perform the actual manipulation of the data.

Specified by:

getUnderlyingModel in interface BasicAlignmentModelView<T>

Returns:

an instance of a class implementing AlignmentModel

getUndoManager

public javax.swing.undo.UndoManager getUndoManager()

Returns the undo manager used by this instance.

Returns:

an instance of UndoManager or an inherited class

getEditFactory

public SwingEditFactory<T> getEditFactory()

Returns the edit factory used by this instance to create new edit objects, if one was passed to when this instance was created.

Returns:

the used edit factory or null if default LibrAlign edit objects are created

hasEditFactory

public boolean hasEditFactory()

Checks if this instance uses a custom edit factory to create new edit objects.

Returns:

true if an edit factory is used, false otherwise.

registerDocumentChange

public void registerDocumentChange()

This method is called every time the redo or undo methods of any of the edit objects generated by this class are executed. This default implementation is empty but inheriting classes could overwrite it in order to react to document changes. (This would be an alternative to registering a AlignmentModelChangeListener.)

See Also:

AbstractDocumentEdit.registerDocumentChange()

getLabel

public java.lang.String getLabel()

Description copied from interface: AlignmentModel

Returns a string labeling this alignment.

Specified by:

getLabel in interface AlignmentModel<T>

Overrides:

getLabel in class AbstractAlignmentModel<T>

Returns:

the name or title of this alignment

setLabel

public void setLabel(java.lang.String label)
              throws java.lang.UnsupportedOperationException

Description copied from class: AbstractAlignmentModel

Allows to specify a new label for this alignment. This implementation allows to edit the label and will never throw an UnsupportedOperationException in this method.

Specified by:

setLabel in interface AlignmentModel<T>

Overrides:

setLabel in class AbstractAlignmentModel<T>

Parameters:

label - the new label

Throws:

java.lang.UnsupportedOperationException - if this implementation does not allow to change labels

getTokenSet

public TokenSet<T> getTokenSet()

Description copied from interface: AlignmentModel

Returns the token set which is supported by the implementation.

Specified by:

getTokenSet in interface AlignmentModel<T>

Returns:

a token set containing all valid tokens

setTokenSet

public void setTokenSet(TokenSet<T> set)

Description copied from interface: AlignmentModel

Replaces the current token set with the specified one.

Specified by:

setTokenSet in interface AlignmentModel<T>

Parameters:

set - the new token set to be used

getTokenAt

public T getTokenAt(java.lang.String sequenceID,
                    int index)

Description copied from interface: AlignmentModel

Returns the token at the specified position.

Specified by:

getTokenAt in interface AlignmentModel<T>

Parameters:

sequenceID - the identifier the sequence where the token is contained

index - the index of the element contained in the specified sequence (The first element has the index 0.)

Returns:

the token to be displayed in the GUI alignment view

setTokenAt

public void setTokenAt(java.lang.String sequenceID,
                       int index,
                       T token)
                throws AlignmentSourceNotWritableException

Description copied from interface: AlignmentModel

Replaces the token at the specified position by the passed token.

Specified by:

setTokenAt in interface AlignmentModel<T>

Parameters:

sequenceID - the identifier the sequence where the token is contained

index - the index of the element to be replaced (The first element has the index 0.)

token - the new token for the specified position

Throws:

AlignmentSourceNotWritableException - if the underlying data source is not writable for tokens

setTokensAt

public void setTokensAt(java.lang.String sequenceID,
                        int beginIndex,
                        java.util.Collection<? extends T> tokens)
                 throws AlignmentSourceNotWritableException

Description copied from interface: AlignmentModel

Replaces a sequence of tokens starting at the specified position. If the specified collection contains more tokens than the currently present in the sequence at the specified start position the additional tokens are appended.

Specified by:

setTokensAt in interface AlignmentModel<T>

Parameters:

sequenceID - the identifier the sequence where the token is contained

beginIndex - the index of the first element to be replaced (The first element in the sequence has the index 0.)

tokens - the new tokens for the specified position

Throws:

AlignmentSourceNotWritableException - if the underlying data source is not writable for tokens

See Also:

AlignmentModelUtils.charSequenceToTokenList(CharSequence, TokenSet)

appendToken

public void appendToken(java.lang.String sequenceID,
                        T token)
                 throws AlignmentSourceNotWritableException

Description copied from interface: AlignmentModel

Appends a token at the end of the sequence.

Specified by:

appendToken in interface AlignmentModel<T>

Parameters:

sequenceID - the identifier the sequence in the alignment

token - the token to be inserted

Throws:

AlignmentSourceNotWritableException - if the underlying data source is not writable for tokens

appendTokens

public void appendTokens(java.lang.String sequenceID,
                         java.util.Collection<? extends T> tokens)
                  throws AlignmentSourceNotWritableException

Description copied from interface: AlignmentModel

Appends a sequence of tokens starting at the end of the current sequence.

Specified by:

appendTokens in interface AlignmentModel<T>

Parameters:

sequenceID - the identifier the sequence where the token is contained

tokens - the new tokens for the specified position

Throws:

AlignmentSourceNotWritableException - if the underlying data source is not writable for tokens

See Also:

AlignmentModelUtils.charSequenceToTokenList(CharSequence, TokenSet)

insertTokenAt

public void insertTokenAt(java.lang.String sequenceID,
                          int index,
                          T token)
                   throws AlignmentSourceNotWritableException

Description copied from interface: AlignmentModel

Inserts a token at the specified position. All tokens located behind the specified index are moved by 1.

Specified by:

insertTokenAt in interface AlignmentModel<T>

Parameters:

sequenceID - the identifier the sequence in the alignment

index - the new index the inserted element will have (0 <= elementIndex < sequenceLength)

token - the token to be inserted

Throws:

AlignmentSourceNotWritableException - if the underlying data source is not writable for tokens

insertTokensAt

public void insertTokensAt(java.lang.String sequenceID,
                           int beginIndex,
                           java.util.Collection<? extends T> tokens)
                    throws AlignmentSourceNotWritableException

Description copied from interface: AlignmentModel

Inserts a sequence of tokens starting at the specified position. All tokens located behind the specified index are moved by the number of tokens that are contained in tokens.

Specified by:

insertTokensAt in interface AlignmentModel<T>

Parameters:

sequenceID - the identifier the sequence where the token is contained

beginIndex - the index of the first element to be replaced (The first element in the sequence has the index 0.)

tokens - the new tokens for the specified position

Throws:

AlignmentSourceNotWritableException - if the underlying data source is not writable for tokens

See Also:

AlignmentModelUtils.charSequenceToTokenList(CharSequence, TokenSet)

removeTokenAt

public void removeTokenAt(java.lang.String sequenceID,
                          int index)
                   throws AlignmentSourceNotWritableException

Description copied from interface: AlignmentModel

Removes the token at the specified position from the underlying data source.

Specified by:

removeTokenAt in interface AlignmentModel<T>

Parameters:

sequenceID - the identifier the sequence in the alignment

index - the index of the element to be removed (The first element has the index 0.)

Throws:

AlignmentSourceNotWritableException - if the underlying data source is not writable for tokens

removeTokensAt

public void removeTokensAt(java.lang.String sequenceID,
                           int beginIndex,
                           int endIndex)
                    throws AlignmentSourceNotWritableException

Description copied from interface: AlignmentModel

Removes the token inside the specified interval from the underlying data source. The subsequence to be removed begins at the specified beginIndex and extends to the token at index endIndex - 1). Thus the length of the subsequence is {@code endIndex - beginIndex}.

Specified by:

removeTokensAt in interface AlignmentModel<T>

Parameters:

sequenceID - the identifier the sequence in the alignment

beginIndex - the beginning index, inclusive

endIndex - the ending index, exclusive

Throws:

AlignmentSourceNotWritableException - if the underlying data source is not writable for tokens

getSequenceLength

public int getSequenceLength(java.lang.String sequenceID)

Description copied from interface: AlignmentModel

Returns the length of the specified sequence.

Specified by:

getSequenceLength in interface AlignmentModel<T>

Parameters:

sequenceID - the identifier the sequence in the alignment

Returns:

the length of the sequence or -1 if no sequence with the specified name exists

getMaxSequenceLength

public int getMaxSequenceLength()

Description copied from interface: AlignmentModel

Returns the length of the longest sequence in the alignment which is equivalent to the length of the alignment.

Note that this value represents the number of compounds of the specified data type. If e.g. a DNA data source is viewed as amino acid data this method would still return the number of nucleotides in the longest sequence.

Specified by:

getMaxSequenceLength in interface AlignmentModel<T>

Returns:

the number of columns in the alignment or 0 if there are not sequences contained in the underlying data source

getWriteType

public AlignmentModelWriteType getWriteType()

Description copied from interface: AlignmentModel

Returns a value that specifies if whole sequences or single tokens can be edited in the underlying data source. s

Specified by:

getWriteType in interface AlignmentModel<T>

Returns:

the write type of this data source

isTokensReadOnly

public boolean isTokensReadOnly()

Description copied from interface: AlignmentModel

Checks of tokens can be changed in the underlying data source

Specified by:

isTokensReadOnly in interface AlignmentModel<T>

Returns:

true if token can be written or removed, false otherwise

isSequencesReadOnly

public boolean isSequencesReadOnly()

Description copied from interface: AlignmentModel

Checks of whole sequences can be changed in the underlying data source

Specified by:

isSequencesReadOnly in interface AlignmentModel<T>

Returns:

true if sequences can be written, renamed or removed, false otherwise

containsSequence

public boolean containsSequence(java.lang.String sequenceID)

Description copied from interface: AlignmentModel

Checks if a sequence associated with the specified unique identifier is contained in this model.

Specified by:

containsSequence in interface AlignmentModel<T>

Parameters:

sequenceID - the ID of the sequence to checked on

Returns:

true if an according sequence was found, false otherwise

sequenceIDsByName

public java.util.Set<java.lang.String> sequenceIDsByName(java.lang.String sequenceName)

Description copied from interface: AlignmentModel

Returns the set of unique sequence IDs associated with the specified name.

Specified by:

sequenceIDsByName in interface AlignmentModel<T>

Parameters:

sequenceName - the name of the sequence that would be visible to the application user

Returns:

the set of sequence IDs (The returned set maybe unmodifiable (depending on the implementation) and empty if no sequence with the specified name is present in this model.)

sequenceNameByID

public java.lang.String sequenceNameByID(java.lang.String sequenceID)

Description copied from interface: AlignmentModel

Returns the sequence name (that would be visible to the application user) associated with the specified unique ID.

Specified by:

sequenceNameByID in interface AlignmentModel<T>

Parameters:

sequenceID - the unique unmodifiable ID the sequence is identified by

Returns:

the sequence name or null if no sequence with this ID is contained in this model

addSequence

public java.lang.String addSequence(java.lang.String sequenceName)

Description copied from interface: AlignmentModel

Adds a new empty sequence to the underlying data source and generates an ID for it.

Specified by:

addSequence in interface AlignmentModel<T>

Parameters:

sequenceName - the name of the new sequence

Returns:

the unique ID of the new sequence

addSequence

public java.lang.String addSequence(java.lang.String sequenceName,
                                    java.lang.String sequenceID)

Description copied from interface: AlignmentModel

Adds a new empty sequence to the underlying data source assigning the specified ID to it.

Specified by:

addSequence in interface AlignmentModel<T>

Parameters:

sequenceName - the name of the new sequence

sequenceID - the ID the new sequence shall have

Returns:

the unique ID of the new sequence (identical with sequenceID)

removeSequence

public boolean removeSequence(java.lang.String sequenceID)

Description copied from interface: AlignmentModel

Removes the specified sequence from the underlying data source.

Specified by:

removeSequence in interface AlignmentModel<T>

Parameters:

sequenceID - the unique ID of the sequence to be removed

Returns:

true if an sequence with the specified ID was removed, false if no sequence with the specified ID was contained in this model

renameSequence

public java.lang.String renameSequence(java.lang.String sequenceID,
                                       java.lang.String newSequenceName)

Description copied from interface: AlignmentModel

Renames a sequence in the underlying data source.

Specified by:

renameSequence in interface AlignmentModel<T>

Parameters:

sequenceID - the ID of the sequence to be renamed

newSequenceName - the new name the sequence shall have

Returns:

the name the sequence had until now

sequenceIDIterator

public java.util.Iterator<java.lang.String> sequenceIDIterator()

Description copied from interface: AlignmentModel

Returns an iterator over unique IDs of all sequences contained in the underlying data source in the order they are stored in this model.

Specified by:

sequenceIDIterator in interface AlignmentModel<T>

Returns:

an iterator over the IDs

getSequenceCount

public int getSequenceCount()

Description copied from interface: AlignmentModel

Returns the number of sequences in the underlying data source.

Specified by:

getSequenceCount in interface AlignmentModel<T>