de.zimek.proteinfeatures.groups
Interface Group

All Known Implementing Classes:

AbstractGroup, CharGroup

public interface Group

Author:

Arthur Zimek

Method Summary

java.lang.String	getAttributeNamePrefix() Returns a prefix for attribute description
java.lang.String[]	getGroups() Returns a name for each group
int	mapping(char aa) Returns the index of the given amino acid in the current group.

Method Detail

mapping

public int mapping(char aa)
            throws java.lang.IllegalArgumentException

Returns the index of the given amino acid in the current group.

Parameters:

aa - the aminoacid to return the index of

Returns:

int -1 if the aa is not assigned to a group, the index within the group otherwise

Throws:

java.lang.IllegalArgumentException - if the symbol aa is not known by the mapping

getGroups

public java.lang.String[] getGroups()

Returns a name for each group

Returns:

String[] array of names for each group

getAttributeNamePrefix

public java.lang.String getAttributeNamePrefix()

Returns a prefix for attribute description

Returns:

String