info.bioinfweb.libralign.model.events

Class TokenChangeEvent<T>

java.lang.Object

java.util.EventObject

javax.swing.event.ChangeEvent

info.bioinfweb.libralign.model.events.AlignmentModelChangeEvent<T>

info.bioinfweb.libralign.model.events.SequenceChangeEvent<T>

info.bioinfweb.libralign.model.events.TokenChangeEvent<T>

Type Parameters:

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

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class TokenChangeEvent<T>
extends SequenceChangeEvent<T>

Event object that indicates that tokens in a sequence provided by an instance of AlignmentModel were inserted, removed or replaced.

Since:

0.0.0

Author:

Ben Stöver

See Also:

Serialized Form

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	TokenChangeEvent(AlignmentModel<T> source, java.lang.String sequenceID, ListChangeType type, int startIndex, java.util.Collection<? extends T> affectedTokens) Creates a new instance of this class.

Method Summary

Modifier and Type	Method and Description
TokenChangeEvent<T>	clone()
TokenChangeEvent<T>	cloneWithNewSource(AlignmentModel<T> source) Creates a copy of this event with all properties set to identical values but with a different source.
java.lang.Object	getAffectedToken() Returns the first affected token.
java.util.Collection<? extends T>	getAffectedTokens() Returns a collection of tokens that have been affected by this operation.
int	getStartIndex() Returns the (former) index of the first affected token.
static <T> TokenChangeEvent<T>	newInsertInstance(AlignmentModel<T> source, java.lang.String sequenceID, int startIndex, java.util.Collection<? extends T> newTokens) Creates a new instance of this class that represents an insertion of a list of tokens.
static <T> TokenChangeEvent<T>	newInsertInstance(AlignmentModel<T> source, java.lang.String sequenceID, int index, T newToken) Creates a new instance of this class that represents an insertion of a single token.
static <T> TokenChangeEvent<T>	newRemoveInstance(AlignmentModel<T> source, java.lang.String sequenceID, int startIndex, java.util.Collection<? extends T> removedTokens) Creates a new instance of this class that represents a deletion of a list of tokens.
static <T> TokenChangeEvent<T>	newRemoveInstance(AlignmentModel<T> source, java.lang.String sequenceID, int index, T removedToken) Creates a new instance of this class that represents a deletion of a single token.
static <T> TokenChangeEvent<T>	newReplaceInstance(AlignmentModel<T> source, java.lang.String sequenceID, int startIndex, java.util.Collection<? extends T> replacedTokens) Creates a new instance of this class that represents a replacement of a list of tokens.
static <T> TokenChangeEvent<T>	newReplaceInstance(AlignmentModel<T> source, java.lang.String sequenceID, int index, T replacedToken) Creates a new instance of this class that represents a replacement of a single token.

Methods inherited from class info.bioinfweb.libralign.model.events.SequenceChangeEvent

getType, newInsertInstance, newRemoveInstance

Methods inherited from class info.bioinfweb.libralign.model.events.AlignmentModelChangeEvent

getSequenceID, getSource

Methods inherited from class java.util.EventObject

toString

Methods inherited from class java.lang.Object

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

Constructor Detail

TokenChangeEvent

protected TokenChangeEvent(AlignmentModel<T> source,
                           java.lang.String sequenceID,
                           ListChangeType type,
                           int startIndex,
                           java.util.Collection<? extends T> affectedTokens)

Creates a new instance of this class.

Parameters:

source - the sequence data provider that fires this event

sequenceID - the ID of the affected sequence

type - the type of change that happened

startIndex - the index of the first affected token in the sequence

affectedTokens - a list of the affected tokens

Method Detail

newInsertInstance

public static <T> TokenChangeEvent<T> newInsertInstance(AlignmentModel<T> source,
                                                        java.lang.String sequenceID,
                                                        int startIndex,
                                                        java.util.Collection<? extends T> newTokens)

Creates a new instance of this class that represents an insertion of a list of tokens.

Parameters:

source - the sequence data provider that fires this event

sequenceID - the ID of the affected sequence

startIndex - the index where the first token was inserted into the sequence

newTokens - the list of the tokens to be inserted

Returns:

a new instance with the same token type as source

newInsertInstance

public static <T> TokenChangeEvent<T> newInsertInstance(AlignmentModel<T> source,
                                                        java.lang.String sequenceID,
                                                        int index,
                                                        T newToken)

Creates a new instance of this class that represents an insertion of a single token.

Parameters:

source - the sequence data provider that fires this event

sequenceID - the ID of the affected sequence

index - the index where the new token was inserted

newToken - the token to be inserted

Returns:

a new instance with the same token type as source

newRemoveInstance

public static <T> TokenChangeEvent<T> newRemoveInstance(AlignmentModel<T> source,
                                                        java.lang.String sequenceID,
                                                        int startIndex,
                                                        java.util.Collection<? extends T> removedTokens)

Creates a new instance of this class that represents a deletion of a list of tokens.

Parameters:

source - the sequence data provider that fires this event

sequenceID - the ID of the affected sequence

startIndex - the index where the first token has been deleted from the sequence

removedTokens - the tokens that have been deleted

Returns:

a new instance with the same token type as source

newRemoveInstance

public static <T> TokenChangeEvent<T> newRemoveInstance(AlignmentModel<T> source,
                                                        java.lang.String sequenceID,
                                                        int index,
                                                        T removedToken)

Creates a new instance of this class that represents a deletion of a single token.

Parameters:

source - the sequence data provider that fires this event

sequenceID - the ID of the affected sequence

index - the index where the token has been deleted from the sequence

removedToken - the token that has been deleted

Returns:

a new instance with the same token type as source

newReplaceInstance

public static <T> TokenChangeEvent<T> newReplaceInstance(AlignmentModel<T> source,
                                                         java.lang.String sequenceID,
                                                         int startIndex,
                                                         java.util.Collection<? extends T> replacedTokens)

Creates a new instance of this class that represents a replacement of a list of tokens.

Parameters:

source - the sequence data provider that fires this event

sequenceID - the ID of the affected sequence

startIndex - the index where the first token was replaced in the sequence

replacedTokens - the list of tokens that have been replaced

Returns:

a new instance with the same token type as source

newReplaceInstance

public static <T> TokenChangeEvent<T> newReplaceInstance(AlignmentModel<T> source,
                                                         java.lang.String sequenceID,
                                                         int index,
                                                         T replacedToken)

Creates a new instance of this class that represents a replacement of a single token.

Parameters:

source - the sequence data provider that fires this event

sequenceID - the ID of the affected sequence

index - the index where the token shall be inserted into the sequence

replacedToken - the list of tokens that have been replaced

Returns:

a new instance with the same token type as source

getStartIndex

public int getStartIndex()

Returns the (former) index of the first affected token.

Returns:

a value greater or equal to zero (The first token of sequence has the index 0.)

getAffectedTokens

public java.util.Collection<? extends T> getAffectedTokens()

Returns a collection of tokens that have been affected by this operation. For insertions this would be the new tokens and for replacements and deletions this would be the removed tokens.

Returns:

a collection of sequence elements

getAffectedToken

public java.lang.Object getAffectedToken()

Returns the first affected token. Convenience method if only one element is affected.

Returns:

the fist affected element or null if #getAffectedElements() return an empty list

cloneWithNewSource

public TokenChangeEvent<T> cloneWithNewSource(AlignmentModel<T> source)

Description copied from class: AlignmentModelChangeEvent

Creates a copy of this event with all properties set to identical values but with a different source.

Overrides:

cloneWithNewSource in class SequenceChangeEvent<T>

Parameters:

source - the source model to be used for the created copy

Returns:

the modified copy of this instance

clone

public TokenChangeEvent<T> clone()

Overrides:

clone in class SequenceChangeEvent<T>