info.bioinfweb.libralign.alignmentarea.paintsettings

Class TokenPainterMap

java.lang.Object

info.bioinfweb.libralign.alignmentarea.paintsettings.TokenPainterMap

public class TokenPainterMap
extends java.lang.Object

Provides best matching token painters depending on the specified token set type.

For each CharacterStateSetType a separate token painter can be provided. If the map contains no matching painter, an instance of SingleColorTokenPainter without any entries in its color map is provided. By default NucleotideTokenPainter and AminoAcidTokenPainter are contained in the map, but this can be adjusted using putTokenPainter(CharacterStateSetType, TokenPainter).

Instances of this class are used to provide default painters by TokenPainterList.

Since:

0.6.0

Author:

Ben Stöver

Module:

info.bioinfweb.libralign.core

Constructor Summary

Constructors

Constructor and Description
TokenPainterMap() Creates a new instance of this class.

Method Summary

Modifier and Type	Method and Description
TokenPainter	getPainter(CharacterStateSetType type) Returns the best matching painter to specified token type.
TokenPainter	putTokenPainter(CharacterStateSetType type, TokenPainter painter) Specifies a new painter for a certain token type.
TokenPainter	removeTokenPainter(CharacterStateSetType type) Removes the painter mapping for the specified token type.

Methods inherited from class java.lang.Object

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

Constructor Detail

TokenPainterMap

public TokenPainterMap()

Creates a new instance of this class.

Method Detail

getPainter

public TokenPainter getPainter(CharacterStateSetType type)

Returns the best matching painter to specified token type. The mapping for CharacterStateSetType.NUCLEOTIDE are returned is no matching painter for CharacterStateSetType.DNA or CharacterStateSetType.RNA is found. The mapping for CharacterStateSetType.DISCRETE is returned for all discrete types for which no direct mapping is present.

Parameters:

type - the token type for which a painter is requested

Returns:

the best matching painter (never null)

putTokenPainter

public TokenPainter putTokenPainter(CharacterStateSetType type,
                                    TokenPainter painter)

Specifies a new painter for a certain token type.

Parameters:

type - the token type to map the painter to

painter - the new painter

Returns:

the painter previously mapped to type or null

Throws:

java.lang.NullPointerException - if type or painter are null

removeTokenPainter

public TokenPainter removeTokenPainter(CharacterStateSetType type)

Removes the painter mapping for the specified token type.

Parameters:

type - the token type to remove the mapping for

Returns:

the painter previously mapped to type or null