net.maizegenetics.analysis.gbs.neobio

Class ScoringScheme

java.lang.Object

net.maizegenetics.analysis.gbs.neobio.ScoringScheme

Direct Known Subclasses:

BasicScoringScheme, ScoringMatrix

public abstract class ScoringScheme
extends Object

This abstract class is the superclass of all scoring schemes. It defines basic operations that must be provided by all subclasses. Scoring schemes are used by sequence alignment algorithms to compute the score of an alignment.

Author:

Sergio A. de Carvalho Jr.

See Also:

PairwiseAlignmentAlgorithm

Constructor Summary

Constructors

Constructor and Description
ScoringScheme() Creates a new instance of an scoring scheme.
ScoringScheme(boolean case_sensitive) Creates a new instance of an scoring scheme.

Method Summary

Modifier and Type	Method and Description
boolean	isCaseSensitive() Tells whether this scoring scheme ignores the case of characters when computing their score.
abstract boolean	isPartialMatchSupported() Returns true if this scoring scheme supports partial matches, false otherwise.
abstract int	maxAbsoluteScore() Returns the maximum absolute score that this scoring scheme can return for any substitution, deletion or insertion.
abstract int	scoreDeletion(char a) Returns the score of a deletion of character a according to this scoring scheme.
abstract int	scoreInsertion(char a) Returns the score of an insertion of character a according to this scoring scheme.
abstract int	scoreSubstitution(char a, char b) Returns the score of a substitution of character a for character b according to this scoring scheme.

Methods inherited from class java.lang.Object

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

Constructor Detail

ScoringScheme

public ScoringScheme()

Creates a new instance of an scoring scheme. The case of characters is significant when subsequently computing their score.

ScoringScheme

public ScoringScheme(boolean case_sensitive)

Creates a new instance of an scoring scheme. If case_sensitive is true, the case of characters is significant when subsequently computing their score; otherwise the case is ignored.

Parameters:

case_sensitive - true if the case of characters must be significant, false otherwise

Method Detail

isCaseSensitive

public boolean isCaseSensitive()

Tells whether this scoring scheme ignores the case of characters when computing their score.

Returns:

true if the case of characters is significant, false otherwise

scoreSubstitution

public abstract int scoreSubstitution(char a,
                                      char b)
                               throws IncompatibleScoringSchemeException

Returns the score of a substitution of character a for character b according to this scoring scheme. If this substitution is not defined, an exception is raised.

Parameters:

a - first character

b - second character

Returns:

score of substitution of a for b

Throws:

IncompatibleScoringSchemeException - if this substitution is not defined

scoreInsertion

public abstract int scoreInsertion(char a)
                            throws IncompatibleScoringSchemeException

Returns the score of an insertion of character a according to this scoring scheme. If this character is not recognised, an exception is raised.

Parameters:

a - the character to be inserted

Returns:

score of insertion of a

Throws:

IncompatibleScoringSchemeException - if character is not recognised by this scoring scheme

scoreDeletion

public abstract int scoreDeletion(char a)
                           throws IncompatibleScoringSchemeException

Returns the score of a deletion of character a according to this scoring scheme. If this character is not recognised, an exception is raised.

Parameters:

a - the character to be deleted

Returns:

score of insertion of a

Throws:

IncompatibleScoringSchemeException - if character is not recognised by this scoring scheme

maxAbsoluteScore

public abstract int maxAbsoluteScore()

Returns the maximum absolute score that this scoring scheme can return for any substitution, deletion or insertion.

Returns:

maximum absolute score that can be returned

isPartialMatchSupported

public abstract boolean isPartialMatchSupported()

Returns true if this scoring scheme supports partial matches, false otherwise. A partial match is a situation when two characters are not equal but, for any reason, are regarded as similar by this scoring scheme, which then returns a positive score. This is common when for scoring schemes that implement amino acid scoring matrices.

Returns:

true if this scoring scheme supports partial matches, false otherwise