info.bioinfweb.libralign.model.tokenset

Class DefaultTokenSet<T>

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractSet<E>

java.util.HashSet<T>

info.bioinfweb.libralign.model.tokenset.AbstractTokenSet<T>

info.bioinfweb.libralign.model.tokenset.DefaultTokenSet<T>

Type Parameters:

T - the type of token in this token set

All Implemented Interfaces:

TokenSet<T>, java.io.Serializable, java.lang.Cloneable, java.lang.Iterable<T>, java.util.Collection<T>, java.util.Set<T>

public class DefaultTokenSet<T>
extends AbstractTokenSet<T>

Basic implementation of a discrete token set. It can contain any set of objects and returns their string representations for representationByToken(Object) and descriptionByToken(Object).

In many cases a more specific implementation of TokenSet may be preferable.

Since:

0.4.0

Author:

Ben Stöver

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
DefaultTokenSet(CharacterStateSetType type) Returns a new instance of this class.

Method Summary

Modifier and Type	Method and Description
DefaultTokenSet<T>	clone() Inherited classes have to overwrite this method and create a deep copy of AbstractTokenSet.getKeyMap().
java.lang.String	descriptionByToken(T token) An description of the specified token (e.g.
int	maxRepresentationLength() Calculates the maximal length of a representation returned by TokenSet.representationByToken(Object) of all tokens contained in this set.
java.lang.String	representationByToken(T token) Returns the representation string of the specified token that shall be displayed in an AlignmentArea or written into an alignment file.
boolean	representationLengthEqual() Checks if all representation strings returned by TokenSet.representationByToken(Object) have the same length.
T	tokenByRepresentation(java.lang.String representation) Returns the first token in this set returned by HashSet.iterator() with a string representation equal to representation.

Methods inherited from class info.bioinfweb.libralign.model.tokenset.AbstractTokenSet

addSpaceKeyForGaps, getGapToken, getKeyMap, getMeaning, getMissingInformationToken, getSymbolType, getType, isGapToken, isMissingInformationToken, isSpaceForGap, setSpaceForGap, tokenByKeyStroke

Methods inherited from class java.util.HashSet

add, clear, contains, isEmpty, iterator, remove, size, spliterator

Methods inherited from class java.util.AbstractSet

equals, hashCode, removeAll

Methods inherited from class java.util.AbstractCollection

addAll, containsAll, retainAll, toArray, toArray, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Set

add, addAll, clear, contains, containsAll, equals, hashCode, isEmpty, iterator, remove, removeAll, retainAll, size, spliterator, toArray, toArray

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Constructor Detail

DefaultTokenSet

public DefaultTokenSet(CharacterStateSetType type)

Returns a new instance of this class.

Parameters:

type - the token type of the new instance

Method Detail

representationByToken

public java.lang.String representationByToken(T token)

Description copied from interface: TokenSet

Returns the representation string of the specified token that shall be displayed in an AlignmentArea or written into an alignment file.

Note that some CharSequenceAdapters and StringAdapters only use the first character of the returned string to represent a token.

Parameters:

token - the token associated with the representation

Returns:

a string which is at least one character long an empty string if no token in this set has the specified representation

tokenByRepresentation

public T tokenByRepresentation(java.lang.String representation)

Returns the first token in this set returned by HashSet.iterator() with a string representation equal to representation.

Inherited classes might want to overwrite this method to achieve a better performance for large token sets.

Parameters:

representation - the string representation of the token

Returns:

the according token or null if none is defined

maxRepresentationLength

public int maxRepresentationLength()

Description copied from interface: TokenSet

Calculates the maximal length of a representation returned by TokenSet.representationByToken(Object) of all tokens contained in this set.

Returns:

a value >= 1 (since all representations must be at least one character long)

representationLengthEqual

public boolean representationLengthEqual()

Description copied from interface: TokenSet

Checks if all representation strings returned by TokenSet.representationByToken(Object) have the same length.

Returns:

true if all lengths are equal, false otherwise

descriptionByToken

public java.lang.String descriptionByToken(T token)

Description copied from interface: TokenSet

An description of the specified token (e.g. the full name of the compound like "Adenine").

Parameters:

token - the token that shall be described

Returns:

a string containing no line breaks

clone

public DefaultTokenSet<T> clone()

Description copied from class: AbstractTokenSet

Inherited classes have to overwrite this method and create a deep copy of AbstractTokenSet.getKeyMap().

Specified by:

clone in interface TokenSet<T>

Specified by:

clone in class AbstractTokenSet<T>

Returns:

an identical token set