eu.bandm.music.entities

Class FunctionalKey

java.lang.Object

eu.bandm.tscore.base.Entity<FunctionalKey>

eu.bandm.music.entities.FunctionalKey

All Implemented Interfaces:

Translet.Parseable<FunctionalKey>

public class FunctionalKey
extends Entity<FunctionalKey>

Indicates a tonal key (/"Tonart"/"diatonics") in tonal theory.

Field Summary

Fields

Modifier and Type	Field and Description
protected FunctionalPitchModOctave	base The root or base tone of this key.
static EntityCatalog<FunctionalKey>	catalog Catalog of all defined keys.
protected FunctionalGender	gender The gender(/"mode") of this key.

Fields inherited from class eu.bandm.tscore.base.Entity

documentations

Method Summary

Modifier and Type	Method and Description
FunctionalPitchModOctave	get_base() Return the base pitch of the key.
int	get_fifthsFromC() Get the distance of the base (in case of major) or the base of the relative key (/"parallele Durtonart") in case of minor, from the pitch class of "C".
FunctionalGender	get_gender() Return the gender of the key.
static Translet.Parser<FunctionalKey>	getCapitalizationAdjustedParser(String lang, String delim) Delivers a parser which accepts the lower-initial variant of a pitch class followed by the word for minor, and the upper-initial variant for major.
static Translet.Parser<FunctionalKey>	getCapitalizationOnlyParser(String lang) Delivers a parser which accepts only the pitch class names and derives the gender/mode from the case of the initial character.
static Translet.Parser<FunctionalKey>	getExplicitParser(String lang, String delim) Delivers a parser which accepts the names of the pitch classes (only) as they were defined.
String	toString()
String	toString(String lang) Returns a name in the given language.
static FunctionalKey	valueOf(FunctionalPitchModOctave base, FunctionalGender gender)

Methods inherited from class eu.bandm.tscore.base.Entity

addName, dump, dump, getCatalog, getDocumentation, getDocumentation, getDocumentations, getName, getName, getNames, getParser, getParser, setDocumentation, toString

Methods inherited from class java.lang.Object

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

Field Detail

base

protected FunctionalPitchModOctave base

The root or base tone of this key.

gender

protected FunctionalGender gender

The gender(/"mode") of this key.

catalog

public static final EntityCatalog<FunctionalKey> catalog

Catalog of all defined keys.

Method Detail

get_gender

public FunctionalGender get_gender()

Return the gender of the key.

get_base

public FunctionalPitchModOctave get_base()

Return the base pitch of the key.

get_fifthsFromC

public int get_fifthsFromC()

Get the distance of the base (in case of major) or the base of the relative key (/"parallele Durtonart") in case of minor, from the pitch class of "C". This is the fundamentel means of sorting keys in the so-called "Circle of Fifths" (which is indeed per se a spiral and not a circle.)

valueOf

public static FunctionalKey valueOf(FunctionalPitchModOctave base,
                                    FunctionalGender gender)

toString

public String toString(String lang)

Returns a name in the given language. This algorithm follows the tradition to write major keys capitalized and minor keys with lower case initials.

toString

public String toString()

Overrides:

toString in class Object

getExplicitParser

public static Translet.Parser<FunctionalKey> getExplicitParser(String lang,
                                                               String delim)

Delivers a parser which accepts the names of the pitch classes (only) as they were defined. These are followed by the delimiter (which may be the empty string) and the explict word for major/minor selection,

getCapitalizationAdjustedParser

public static Translet.Parser<FunctionalKey> getCapitalizationAdjustedParser(String lang,
                                                                             String delim)

Delivers a parser which accepts the lower-initial variant of a pitch class followed by the word for minor, and the upper-initial variant for major. Separaterd by the string delim, which may be the empty string.

getCapitalizationOnlyParser

public static Translet.Parser<FunctionalKey> getCapitalizationOnlyParser(String lang)

Delivers a parser which accepts only the pitch class names and derives the gender/mode from the case of the initial character.