Package eu.bandm.music.entities

Class MetrumSpecs

java.lang.Object

eu.bandm.music.entities.MetrumSpecs

public class MetrumSpecs
extends Object

Combines the data structures and evaluation rules for the metric specs in a "main/metric voice" (normally called "M") and local alternatives for a particular (sounding) voice.
The rules are complicated because they reflect the historic rules of CWN.
Basically: The M-voice gives in its main track the "name" of a metrum, which is CURRENTLY an arbitrary Rational value, possibly followed by a modifing character. At its FIRST appearance (in measure number order) this must be mapped to a MTreeSpec. This gives the meaning of this name, up to any re-definition (in measure number order).
ATTENTION only "mtrees" for the local voices is altered. All other information is cached based on bar numbers.

(This class combines the old deprecated "MeasureCollector" and "MTreeCollector".

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MetrumSpecs.Name

Field Summary

Fields

Modifier and Type	Field	Description
protected SortedMap<BigDecimal,Rational>	barnum2duration	Complete map, for opimized retrieval
protected SortedMap<BigDecimal,MTreeSpec>	barnum2mtree	Complete map, for opimized retrieval.
protected SortedMap<BigDecimal,Rational>	barnum2phase	Partial map.
protected SortedMap<BigDecimal,Rational>	barnum2startpos	complete map:
protected Map<Event,Rational>	durations
protected Map<Event,String>	endrun
protected Map<Event,MTreeSpec>	mtrees
final Translet.Parser<MetrumSpecs.Name>	nameParser
protected Map<Event,MetrumSpecs.Name>	names
final Translet.Parser<?>	parseMetrics
protected Map<Event,String>	run
protected Map<Event,String>	runrun

Constructor Summary

Constructors

Constructor	Description
MetrumSpecs()

Method Summary

Modifier and Type	Method	Description
(package private) void	barnumShouldBeBroken(MessageReceiver<SimpleMessage<XMLDocumentIdentifier>> msg, Event e, BigDecimal barnum)
(package private) void	barnumShouldBeInteger(MessageReceiver<SimpleMessage<XMLDocumentIdentifier>> msg, Event e, BigDecimal barnum)
void	checkAndCacheGlobalVoice(MessageReceiver<SimpleMessage<XMLDocumentIdentifier>> msg, Iterable<TpTop> topTps, Map<TpTop,BigDecimal> tp2barnum, Vox mainVox)	first step: every metrum name must have a preceding definition: check and expand.
(package private) void	checkNameConsistency(MessageReceiver<SimpleMessage<XMLDocumentIdentifier>> msg, Event e, MetrumSpecs.Name name, MTreeSpec mtree)
(package private) void	checkNotTop(MessageReceiver<SimpleMessage<XMLDocumentIdentifier>> msg, Vox voice, boolean isMain)	FIXME unvollständige takte aber doch noch erlaubt !?!
void	expandLocalVoice(MessageReceiver<SimpleMessage<XMLDocumentIdentifier>> msg, Iterable<TpTop> topTps, Map<TpTop,BigDecimal> tp2barnum, Vox globalVoice, Vox vox)	Distribute a local metric definition in "mtrees" to any subsequent measure (only those which have a TpTop-Event!), as long as it is "running".
MTreeSpec	getMTree(Vox vox, Event event)
MTreeSpec	getMTree(Vox vox, TpTop tpTop)	ATTENTION, only toTops are allowed in which an EVENT is defined! All other measures are NOT expanded above!
static boolean	isInteger(BigDecimal b)

Methods inherited from class java.lang.Object

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

Field Details

run

protected Map<Event,String> run

runrun

protected Map<Event,String> runrun

endrun

protected Map<Event,String> endrun

mtrees

protected Map<Event,MTreeSpec> mtrees

durations

protected Map<Event,Rational> durations

names

protected Map<Event,MetrumSpecs.Name> names

nameParser

public final Translet.Parser<MetrumSpecs.Name> nameParser

parseMetrics

public final Translet.Parser<?> parseMetrics

barnum2mtree

protected SortedMap<BigDecimal,MTreeSpec> barnum2mtree

Complete map, for opimized retrieval. For accessing the local overwrites, the retrieval methods (Vox, Event) and (Vox, TpTop) additionally consider mtrees.

barnum2duration

protected SortedMap<BigDecimal,Rational> barnum2duration

Complete map, for opimized retrieval

barnum2startpos

protected SortedMap<BigDecimal,Rational> barnum2startpos

complete map:

barnum2phase

protected SortedMap<BigDecimal,Rational> barnum2phase

Partial map. "not contains key" means a phase of Rational.ZERO, ie. end of a complete measure.

Constructor Details

MetrumSpecs

public MetrumSpecs()

Method Details

checkAndCacheGlobalVoice

public void checkAndCacheGlobalVoice(MessageReceiver<SimpleMessage<XMLDocumentIdentifier>> msg,
 Iterable<TpTop> topTps,
 Map<TpTop,BigDecimal> tp2barnum,
 Vox mainVox)

first step: every metrum name must have a preceding definition: check and expand.
second step: check whether explicit durations must sum up to a complete measure, and cache the measure durations (explicit and implicit).
OLD outputs (MeasureCollector): barnum2metric_explicit barnum2duration_explicit barnum2metric barnum2duration barnum2startpos

isInteger

public static boolean isInteger(BigDecimal b)

barnumShouldBeInteger

void barnumShouldBeInteger(MessageReceiver<SimpleMessage<XMLDocumentIdentifier>> msg,
 Event e,
 BigDecimal barnum)

barnumShouldBeBroken

void barnumShouldBeBroken(MessageReceiver<SimpleMessage<XMLDocumentIdentifier>> msg,
 Event e,
 BigDecimal barnum)

expandLocalVoice

public void expandLocalVoice(MessageReceiver<SimpleMessage<XMLDocumentIdentifier>> msg,
 Iterable<TpTop> topTps,
 Map<TpTop,BigDecimal> tp2barnum,
 Vox globalVoice,
 Vox vox)

Distribute a local metric definition in "mtrees" to any subsequent measure (only those which have a TpTop-Event!), as long as it is "running". (Optimization: for faster later retrieval.)

checkNameConsistency

void checkNameConsistency(MessageReceiver<SimpleMessage<XMLDocumentIdentifier>> msg,
 Event e,
 MetrumSpecs.Name name,
 MTreeSpec mtree)

checkNotTop

void checkNotTop(MessageReceiver<SimpleMessage<XMLDocumentIdentifier>> msg,
 Vox voice,
 boolean isMain)

FIXME unvollständige takte aber doch noch erlaubt !?!

getMTree

public MTreeSpec getMTree(Vox vox,
 TpTop tpTop)

ATTENTION, only toTops are allowed in which an EVENT is defined! All other measures are NOT expanded above!

Returns:

the MTreeSpec for a particular measure in a particular voice, by first considering the local overwrites, then the current global setting.

getMTree

public MTreeSpec getMTree(Vox vox,
 Event event)