eu.bandm.tscore.model

Class Vox

java.lang.Object

eu.bandm.tscore.model.Container

eu.bandm.tscore.model.Vox

All Implemented Interfaces:

Formattable, Cloneable

public class Vox
extends Container

A voice, the central means for organizing events. For every combination of voice and timepoint, at most one event can happen, which in turn may carry arbitrary many parameters.

(This definition has been created by UMod from the source at SYSTEM "tscore.umod":62.3-81.7, see this pretty print.)

Field Summary

Fields

Modifier and Type	Field and Description
protected Container	context The part (or score) this voice is part of.
protected CheckedSet<Event>	events All events related to this voice.
protected String	name Name as it appears eg.
protected CheckedSet<String>	parameterNames All parameter names which appear in this voice.
protected CheckedList<Event>	sortedBySource All events related to this voice, in sequential order of the source text position, which in nearly all cases corresponds to temporal order.
protected CheckedMap_RD<Tp,Event>	sortedByStart All events related to this voice, sorted by their time point.

Fields inherited from class eu.bandm.tscore.model.Container

conform, timeless, voices, voicesBySource

Fields inherited from interface eu.bandm.tools.format.Formattable

format

Constructor Summary

Constructors

Constructor and Description
Vox()
Vox(Container context, String name) Constructor generated according to specification #0 Constructor defined according to directive "C 0/..".

Method Summary

Modifier and Type	Method and Description
boolean	containsKey_sortedByStart(Tp key0) Convenience un-Currying method.
void	descend_events(MATCH_ONLY_00 visitor)
void	descend_sortedBySource(MATCH_ONLY_00 visitor)
void	descend_sortedByStart(MATCH_ONLY_00 visitor)
Vox	doclone() Clones this object.
Format	format() Delivers a format object for pretty-printing by inheritance from some ancestor class.
Container	get_context() The part (or score) this voice is part of.
CheckedSet<Event>	get_events() All events related to this voice.
String	get_name() Name as it appears eg.
CheckedSet<String>	get_parameterNames() All parameter names which appear in this voice.
CheckedList<Event>	get_sortedBySource() All events related to this voice, in sequential order of the source text position, which in nearly all cases corresponds to temporal order.
CheckedMap_RD<Tp,Event>	get_sortedByStart() All events related to this voice, sorted by their time point.
Vox	initFrom(Object o0) Copies values of all common fields from the argument.
Event	newEvent(Location<XMLDocumentIdentifier> loc, Tp when)
void	put_sortedByStart(Tp key0, Event value) Convenience un-Currying method.
boolean	set_context(Container val) The part (or score) this voice is part of.
boolean	set_events(CheckedSet<Event> val) All events related to this voice.
boolean	set_name(String val) Name as it appears eg.
boolean	set_parameterNames(CheckedSet<String> val) All parameter names which appear in this voice.
boolean	set_sortedBySource(CheckedList<Event> val) All events related to this voice, in sequential order of the source text position, which in nearly all cases corresponds to temporal order.
boolean	set_sortedByStart(CheckedMap_RD<Tp,Event> val) All events related to this voice, sorted by their time point.

Methods inherited from class eu.bandm.tscore.model.Container

containsKey_timeless, containsKey_voices, descend_voices, descend_voicesBySource, get_conform, get_timeless, get_voices, get_voicesBySource, put_timeless, put_voices, set_conform, set_timeless, set_voices, set_voicesBySource

Methods inherited from class java.lang.Object

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

Field Detail

context

protected Container context

The part (or score) this voice is part of.

(This definition has been created by UMod from the source at SYSTEM "tscore.umod":66.7-67.7, see this pretty print.)
The type of this field is Container(never null)
It is set by every possible constructor.

See Also:

get_context(), set_context(eu.bandm.tscore.model.Container)

name

protected String name

Name as it appears eg. in a source file. The name establishes the voice's identity.

(This definition has been created by UMod from the source at SYSTEM "tscore.umod":68.7-69.7, see this pretty print.)
The type of this field is java.lang.String(never null)
It is set by every possible constructor.

See Also:

get_name(), set_name(java.lang.String)

events

protected CheckedSet<Event> events

All events related to this voice.

(This definition has been created by UMod from the source at SYSTEM "tscore.umod":70.7-71.7, see this pretty print.)
The type of this field is CheckedSet<Event(never null)>(never null)
Its value defaults to an empty collection.

See Also:

get_events(), set_events(eu.bandm.tools.umod.runtime.CheckedSet<eu.bandm.tscore.model.Event>)

sortedByStart

protected CheckedMap_RD<Tp,Event> sortedByStart

All events related to this voice, sorted by their time point.

(This definition has been created by UMod from the source at SYSTEM "tscore.umod":72.7-73.7, see this pretty print.)
The type of this field is CheckedMap_RD<Tp(never null),Event(never null)>(never null)
Its value defaults to an empty collection.

See Also:

get_sortedByStart(), set_sortedByStart(eu.bandm.tools.umod.runtime.CheckedMap_RD<eu.bandm.tscore.model.Tp, eu.bandm.tscore.model.Event>)

sortedBySource

protected CheckedList<Event> sortedBySource

All events related to this voice, in sequential order of the source text position, which in nearly all cases corresponds to temporal order.

(This definition has been created by UMod from the source at SYSTEM "tscore.umod":74.7-75.7, see this pretty print.)
The type of this field is CheckedList<Event(never null)>(never null)
Its value defaults to an empty collection.

See Also:

get_sortedBySource(), set_sortedBySource(eu.bandm.tools.umod.runtime.CheckedList<eu.bandm.tscore.model.Event>)

parameterNames

protected CheckedSet<String> parameterNames

All parameter names which appear in this voice.

(This definition has been created by UMod from the source at SYSTEM "tscore.umod":79.7-80.7, see this pretty print.)
The type of this field is CheckedSet<java.lang.String(never null)>(never null)
Its value defaults to an empty collection.

See Also:

get_parameterNames(), set_parameterNames(eu.bandm.tools.umod.runtime.CheckedSet<java.lang.String>)

Constructor Detail

Vox

public Vox(Container context,
           String name)

Constructor generated according to specification #0
Constructor defined according to directive "C 0/..".

Parameters:

context - is copied to field context

name - is copied to field name

Vox

Vox()

Method Detail

doclone

public Vox doclone()

Clones this object. Method never fails, since Cloneable is known to be implemented.

Overrides:

doclone in class Container

Returns:

a fresh copy.

format

public Format format()

Delivers a format object for pretty-printing by inheritance from some ancestor class.

Specified by:

format in interface Formattable

Overrides:

format in class Container

newEvent

public Event newEvent(Location<XMLDocumentIdentifier> loc,
                      Tp when)

initFrom

public Vox initFrom(Object o0)

Copies values of all common fields from the argument. All fields of this class definition are copied, iff the argument is of this class. Then the superclass method is invoked with the same argument.

Overrides:

initFrom in class Container

get_context

public Container get_context()

The part (or score) this voice is part of.

(This definition has been created by UMod from the source at SYSTEM "tscore.umod":66.7-67.7, see this pretty print.)
Generated getter method. @see #context

Returns:

The current field value of type Container(never null)

set_context

public boolean set_context(Container val)

The part (or score) this voice is part of.

(This definition has been created by UMod from the source at SYSTEM "tscore.umod":66.7-67.7, see this pretty print.)
Updates the (mutable) instance destructively.

Parameters:

val - the new value of type Container(never null)

Returns:

whether a change (w.r.t. ==) did actually happen.

See Also:

context

get_name

public String get_name()

Name as it appears eg. in a source file. The name establishes the voice's identity.

(This definition has been created by UMod from the source at SYSTEM "tscore.umod":68.7-69.7, see this pretty print.)
Generated getter method. @see #name

Returns:

The current field value of type java.lang.String(never null)

set_name

public boolean set_name(String val)

Name as it appears eg. in a source file. The name establishes the voice's identity.

(This definition has been created by UMod from the source at SYSTEM "tscore.umod":68.7-69.7, see this pretty print.)
Updates the (mutable) instance destructively.

Parameters:

val - the new value of type java.lang.String(never null)

Returns:

whether a change (w.r.t. ==) did actually happen.

See Also:

name

get_events

public CheckedSet<Event> get_events()

All events related to this voice.

(This definition has been created by UMod from the source at SYSTEM "tscore.umod":70.7-71.7, see this pretty print.)
Generated getter method. @see #events

Returns:

The current field value of type CheckedSet<Event(never null)>(never null)

set_events

public boolean set_events(CheckedSet<Event> val)

All events related to this voice.

(This definition has been created by UMod from the source at SYSTEM "tscore.umod":70.7-71.7, see this pretty print.)
Updates the (mutable) instance destructively.

Parameters:

val - the new value of type CheckedSet<Event(never null)>(never null)

Returns:

whether a change (w.r.t. ==) did actually happen.

See Also:

events

descend_events

public void descend_events(MATCH_ONLY_00 visitor)

get_sortedByStart

public CheckedMap_RD<Tp,Event> get_sortedByStart()

All events related to this voice, sorted by their time point.

(This definition has been created by UMod from the source at SYSTEM "tscore.umod":72.7-73.7, see this pretty print.)
Generated getter method. @see #sortedByStart

Returns:

The current field value of type CheckedMap_RD<Tp(never null),Event(never null)>(never null)

set_sortedByStart

public boolean set_sortedByStart(CheckedMap_RD<Tp,Event> val)

All events related to this voice, sorted by their time point.

(This definition has been created by UMod from the source at SYSTEM "tscore.umod":72.7-73.7, see this pretty print.)
Updates the (mutable) instance destructively.

Parameters:

val - the new value of type CheckedMap_RD<Tp(never null),Event(never null)>(never null)

Returns:

whether a change (w.r.t. ==) did actually happen.

See Also:

sortedByStart

put_sortedByStart

public void put_sortedByStart(Tp key0,
                              Event value)

Convenience un-Currying method.
Set the value at the given coordinate and automatically generate all intermediate collections, if not yet existing.

Parameters:

val - the new value of type Event(never null)

See Also:

sortedByStart

containsKey_sortedByStart

public boolean containsKey_sortedByStart(Tp key0)

Convenience un-Currying method.

Returns:

whether there exists a chain of collection objects to the given co-ordinate.

See Also:

sortedByStart

descend_sortedByStart

public void descend_sortedByStart(MATCH_ONLY_00 visitor)

get_sortedBySource

public CheckedList<Event> get_sortedBySource()

All events related to this voice, in sequential order of the source text position, which in nearly all cases corresponds to temporal order.

(This definition has been created by UMod from the source at SYSTEM "tscore.umod":74.7-75.7, see this pretty print.)
Generated getter method. @see #sortedBySource

Returns:

The current field value of type CheckedList<Event(never null)>(never null)

set_sortedBySource

public boolean set_sortedBySource(CheckedList<Event> val)

All events related to this voice, in sequential order of the source text position, which in nearly all cases corresponds to temporal order.

(This definition has been created by UMod from the source at SYSTEM "tscore.umod":74.7-75.7, see this pretty print.)
Updates the (mutable) instance destructively.

Parameters:

val - the new value of type CheckedList<Event(never null)>(never null)

Returns:

whether a change (w.r.t. ==) did actually happen.

See Also:

sortedBySource

descend_sortedBySource

public void descend_sortedBySource(MATCH_ONLY_00 visitor)

get_parameterNames

public CheckedSet<String> get_parameterNames()

All parameter names which appear in this voice.

(This definition has been created by UMod from the source at SYSTEM "tscore.umod":79.7-80.7, see this pretty print.)
Generated getter method. @see #parameterNames

Returns:

The current field value of type CheckedSet<java.lang.String(never null)>(never null)

set_parameterNames

public boolean set_parameterNames(CheckedSet<String> val)

All parameter names which appear in this voice.

(This definition has been created by UMod from the source at SYSTEM "tscore.umod":79.7-80.7, see this pretty print.)
Updates the (mutable) instance destructively.

Parameters:

val - the new value of type CheckedSet<java.lang.String(never null)>(never null)

Returns:

whether a change (w.r.t. ==) did actually happen.

See Also:

parameterNames