eu.bandm.tscore.base

Class ParameterCollector

java.lang.Object

eu.bandm.tscore.base.ParameterCollector

Direct Known Subclasses:

GroupCollector, MixedAlternativesCollector, MultipleAttributeCollector, PatternDistributor, RunningOctaveCollector, SingleAttributeCollector, TendencyCollector

public abstract class ParameterCollector
extends Object

Abstract superclass for all processes which parse parameter string values into domain semantic values. This class manages the environment for parameter decoding, esp. the text string concatenation and error location translation. The following discipline has to be followed:

1. Nearly all parameters are set up with the constructor ParameterCollector(MuLiMessageReceiver,String)
2. Only allowed entry point for the calling code is parseVoice(Vox). Its code steps through the events, concatenates all parameter text and prepares the error location map.
3. Then in a loop the CALL-BACK function parseEvent(Event, ULex.State) is called internally. If the State==null, then no parameter is defined for this event
4. In the same loop for each event finalizeEvent(Event) is called.
5. After the loop one finalizeTrack() is called.

The abstract methods parseEvent(Event, ULex.State), finalizeEvent(Event) and finalizeTrack() must be overridden by every derived specialization.
error(int, String, Object...) and warning(int, String, Object...) are "callbacks" for these methods. They translate from string buffer positions (as found in ULex.State) into source file locations (as stored with the Event under processing) and propagate the message to msg.

Field Summary

Fields

Modifier and Type	Field and Description
protected Event	event
protected MuLiMessageReceiver<XMLDocumentIdentifier>	msg The message receiver determined with the constructor.
protected String	paramName
static ULex<String>	parser_text_separator
protected ParameterCollector	sourceContext
protected SortedMap<Integer,Location<XMLDocumentIdentifier>>	startLoc
protected ULex.State	state
static String	text_separator
protected Vox	vox

Constructor Summary

Constructors

Constructor and Description
ParameterCollector(MuLiMessageReceiver<XMLDocumentIdentifier> msg, String paramName)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	error(int loc, String text, Object... args) Translate the text position from buffer index back to source file posistion and generate an error message to msg.
abstract void	finalizeEvent(Event event) Must be specialized for parsing the parameter values for one single event, but may never be called directly.
abstract void	finalizeTrack() Must be specialized for finalzing the parsing process of a whole voice, but may never be called directly.
protected Location<XMLDocumentIdentifier>	findLocation(int loc)
abstract void	parseEvent(Event event, ULex.State state) Must be specialized for parsing the parameter values for one single event, but may never be called directly.
void	parseVoice(Vox voice) The only public entry method.
protected void	setSourceContext(ParameterCollector sourceContext)
protected void	warning(int loc, String text, Object... args) Translate the text position from buffer index back to source file posistion and generate a warning message to msg.

Methods inherited from class java.lang.Object

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

Field Detail

text_separator

public static final String text_separator

See Also:

Constant Field Values

parser_text_separator

public static final ULex<String> parser_text_separator

msg

protected final MuLiMessageReceiver<XMLDocumentIdentifier> msg

The message receiver determined with the constructor.

paramName

protected final String paramName

vox

protected Vox vox

event

protected Event event

startLoc

protected final SortedMap<Integer,Location<XMLDocumentIdentifier>> startLoc

sourceContext

protected ParameterCollector sourceContext

state

protected ULex.State state

Constructor Detail

ParameterCollector

public ParameterCollector(MuLiMessageReceiver<XMLDocumentIdentifier> msg,
                  String paramName)

Method Detail

setSourceContext

protected void setSourceContext(ParameterCollector sourceContext)

parseEvent

public abstract void parseEvent(Event event,
              ULex.State state)

Must be specialized for parsing the parameter values for one single event, but may never be called directly.

Parameters:

event - the event to process

state - the input data

finalizeEvent

public abstract void finalizeEvent(Event event)

Must be specialized for parsing the parameter values for one single event, but may never be called directly.

finalizeTrack

public abstract void finalizeTrack()

Must be specialized for finalzing the parsing process of a whole voice, but may never be called directly.

findLocation

protected Location<XMLDocumentIdentifier> findLocation(int loc)

error

protected void error(int loc,
         String text,
         Object... args)

Translate the text position from buffer index back to source file posistion and generate an error message to msg.

warning

protected void warning(int loc,
           String text,
           Object... args)

Translate the text position from buffer index back to source file posistion and generate a warning message to msg.

parseVoice

public void parseVoice(Vox voice)

The only public entry method. Set up the parameter data in one single string buffer and in an ULex.State. Then calls parseEvent(Event, ULex.State) and finalizeEvent(Event) in a loop, and finally finalizeTrack().