Package eu.bandm.music.entities

Class FunctionalPitchModOctave

java.lang.Object

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

eu.bandm.music.entities.PitchModOctave<FunctionalPitchModOctave>

eu.bandm.music.entities.FunctionalPitchModOctave

All Implemented Interfaces:

PitchIndication, Translet.Parseable<FunctionalPitchModOctave>, Comparable<FunctionalPitchModOctave>

public class FunctionalPitchModOctave
extends PitchModOctave<FunctionalPitchModOctave>
implements PitchIndication, Comparable<FunctionalPitchModOctave>

A pitch class mod octave which combines a "natural" note name [German "Stammton"], given as an instance of WhiteKeyModOctave, with an alteration (normally in the range -2 to +2). These instances are in many cases the fundamental means for speficying pitch inputs, e.g. by parsing source texts. They can be accessed by very different names in different (human) languages. Named instances are pre-constructed in the conventional range, from zero to two accidentals, but this is not a limit for the construction of accidentals and functional pitches. Currently only the German language names are supported. Many languages do not have dedicated names, but append some representation of the accidental to the name of the white key, like "c#" or "c sharp" in English.

Field Summary

Fields

Modifier and Type	Field	Description
protected final Accidental	alteration	The alteration, normally only in the range -2 to 2.
(package private) static Map<WhiteKeyModOctave,List<FunctionalPitchModOctave>>	byWhiteKeys	Holds all functional pitches by the white key they are derived from
static final FunctionalPitchModOctave	c
static final EntityCatalog<FunctionalPitchModOctave>	catalog	Catalog for all named functional pitches.
protected final WhiteKeyModOctave	natural	The white key / "natural" pitch from which this functional pitch is derived.

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

documentations

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	FunctionalPitchModOctave(WhiteKeyModOctave wk, int alt, EntityCatalog<FunctionalPitchModOctave> catalog, String lang, String name)	Auxilliary constructor, accidental shift given directly by integer value (normally in the range -2..+2).
protected	FunctionalPitchModOctave(WhiteKeyModOctave wk, Accidental alt, EntityCatalog<FunctionalPitchModOctave> catalog, @Opt String lang, @Opt String name)	Full constructor, setting all Parameters.

Method Summary

Modifier and Type	Method	Description
protected static Translet.Parser<FunctionalPitchModOctave>	_x_upperInitialParser(String lang, boolean upper)	Deliver a parser with lower or upper initial characters, in the given language only.
int	compareTo(FunctionalPitchModOctave other)	Technically required, to make "TreeMaps" etc.
Accidental	get_accidental()	Return the accidental.
int	get_fifthsFromC()	Return the distance from c in fifth.
int	get_halfTonesFromC()	Return the distance from c in half tones.
WhiteKeyModOctave	get_natural()	Return the natural key from which this pitch class is derived.
static Translet.Parser<FunctionalPitchModOctave>	lowerInitialParser(String lang)	Deliver a parser with lower initial characters, in the given language.
FunctionalInterval	minus(FunctionalPitchModOctave other)	The interval we have to transpose upward some pitch of the given parameter pitch class to get to the nearest pitch of this pitch class.
String	toString()	Get any name, preferable in the EntityCatalog.SYMBOLIC language, as defined in MuLi.get(String...).
static Translet.Parser<FunctionalPitchModOctave>	upperInitialParser(String lang)	Deliver a parser with upper initial characters, in the given language.
static FunctionalPitchModOctave	valueOf(int wk, int alt)	Deliver the functional pitch class derived from the given white key mod octave and the given chromatic shift by accidental.
static FunctionalPitchModOctave	valueOf(WhiteKeyModOctave wk, int alt)	Deliver the functional pitch class derived from the given white key mod octave and the given chromatic shift by accidental.
static FunctionalPitchModOctave	valueOf(WhiteKeyModOctave wk, Accidental alt)	Deliver the functional pitch class derived from the given white key mod octave and the given chromatic shift by accidental.

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

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

Methods inherited from class java.lang.Object

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

Field Details

natural

protected final WhiteKeyModOctave natural

The white key / "natural" pitch from which this functional pitch is derived.

alteration

protected final Accidental alteration

The alteration, normally only in the range -2 to 2.

catalog

public static final EntityCatalog<FunctionalPitchModOctave> catalog

Catalog for all named functional pitches. There is no name for e.g. "c###"

byWhiteKeys

static Map<WhiteKeyModOctave,List<FunctionalPitchModOctave>> byWhiteKeys

Holds all functional pitches by the white key they are derived from

c

public static final FunctionalPitchModOctave c

Constructor Details

FunctionalPitchModOctave

protected FunctionalPitchModOctave(WhiteKeyModOctave wk,
 int alt,
 EntityCatalog<FunctionalPitchModOctave> catalog,
 String lang,
 String name)

Auxilliary constructor, accidental shift given directly by integer value (normally in the range -2..+2).

See Also:

• FunctionalPitchModOctave(WhiteKeyModOctave,Accidental, EntityCatalog,String,String)

FunctionalPitchModOctave

protected FunctionalPitchModOctave(WhiteKeyModOctave wk,
 Accidental alt,
 EntityCatalog<FunctionalPitchModOctave> catalog,
 @Opt
 @Opt String lang,
 @Opt
 @Opt String name)

Full constructor, setting all Parameters. If name==null, this is a synthetic pitch class with more than two chromatic shifts ("f triple sharp" / "fisisis") which will not be adressable by a name but only by "valueOf()".

Parameters:

wk - the white key from which this pitch is derived.

alt - the accidental to apply, may by Accidental.natural

catalog - where to store this new Entity

lang - language of the given name

name - given name

Method Details

get_natural

public WhiteKeyModOctave get_natural()

Return the natural key from which this pitch class is derived.

get_accidental

public Accidental get_accidental()

Return the accidental. Will be Accidental.natural if no shift by accidental applies.

compareTo

public int compareTo(FunctionalPitchModOctave other)

Technically required, to make "TreeMaps" etc. Semantically not very sensible, because very different comparison orders are sensible.

Specified by:

compareTo in interface Comparable<FunctionalPitchModOctave>

get_halfTonesFromC

public int get_halfTonesFromC()

Return the distance from c in half tones. This is a rather arbitrary measure, and is valid only modulo 12.

get_fifthsFromC

public int get_fifthsFromC()

Return the distance from c in fifth. This is a precise measure and not subject to any modulo.

minus

public FunctionalInterval minus(FunctionalPitchModOctave other)

The interval we have to transpose upward some pitch of the given parameter pitch class to get to the nearest pitch of this pitch class.

lowerInitialParser

public static Translet.Parser<FunctionalPitchModOctave> lowerInitialParser(String lang)

Deliver a parser with lower initial characters, in the given language.

upperInitialParser

public static Translet.Parser<FunctionalPitchModOctave> upperInitialParser(String lang)

Deliver a parser with upper initial characters, in the given language.

_x_upperInitialParser

protected static Translet.Parser<FunctionalPitchModOctave> _x_upperInitialParser(String lang,
 boolean upper)

Deliver a parser with lower or upper initial characters, in the given language only. If no name in the language is given, the item is excluded. FIXME currently without warning !?! with a warning.

toString

public String toString()

Description copied from class: Entity

Get any name, preferable in the EntityCatalog.SYMBOLIC language, as defined in MuLi.get(String...). If this fails, get built-in Object.toString() conversion result.

Overrides:

toString in class Entity<FunctionalPitchModOctave>

valueOf

public static FunctionalPitchModOctave valueOf(int wk,
 int alt)

Deliver the functional pitch class derived from the given white key mod octave and the given chromatic shift by accidental. If no such instance exists, a new one (synthetic and adressable only by a "valueOf()" method) is created and cached.

Parameters:

wk - the white key by its distance from c (from 0 to 6)

alt - the alteration, given numerically.

valueOf

public static FunctionalPitchModOctave valueOf(WhiteKeyModOctave wk,
 Accidental alt)

Deliver the functional pitch class derived from the given white key mod octave and the given chromatic shift by accidental. If no such instance exists, a new one (synthetic and adressable only by a "valueOf()" method) is created and cached.

Parameters:

wk - the white key, given as an object.

alt - the alteration, given as an object.

valueOf

public static FunctionalPitchModOctave valueOf(WhiteKeyModOctave wk,
 int alt)

Deliver the functional pitch class derived from the given white key mod octave and the given chromatic shift by accidental.

Parameters:

wk - the white key given as an object.

alt - the alteration, given numerically.