com.soundhelix.misc

Class ActivityMatrix

java.lang.Object

com.soundhelix.misc.ActivityMatrix

All Implemented Interfaces:

Iterable<ActivityVector>

public class ActivityMatrix
extends Object
implements Iterable<ActivityVector>

Container for ActivityVectors.

Author:

Thomas Schuerger (thomas@schuerger.com)

Constructor Summary

Constructors

Constructor and Description
ActivityMatrix()

Method Summary

Methods

Modifier and Type	Method and Description
void	add(ActivityVector activityVector) Adds the given ActivityVector.
void	dump(SongContext songContext, String title, Level level) Dumps the activity vectors as an activity matrix using the given log level.
ActivityVector	get(String name) Looks up and returns the ActivityVector with the given name.
Map<String,Integer>	getIndexMap() Returns a map that maps from ActivityVector name to its iterator index.
Iterator<ActivityVector>	iterator() Provides an iterator that iterates over all ActivityVectors of this ActivityMatrix in the order they have been added.
int	size() Returns the number of ActivityVectors.

Methods inherited from class java.lang.Object

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

Constructor Detail

ActivityMatrix

public ActivityMatrix()

Method Detail

add

public void add(ActivityVector activityVector)

Adds the given ActivityVector. If an ActivityVector with the same name already exists, it will be replaced in its current position. Otherwise it will be appended to the list of ActivityVectors.

Parameters:

activityVector - the ActivityVector

get

public ActivityVector get(String name)

Looks up and returns the ActivityVector with the given name. If the name is not found, null is returned.

Parameters:

name - the name

Returns:

the ActivityVector (or null)

iterator

public Iterator<ActivityVector> iterator()

Provides an iterator that iterates over all ActivityVectors of this ActivityMatrix in the order they have been added.

Specified by:

iterator in interface Iterable<ActivityVector>

Returns:

the iterator

size

public int size()

Returns the number of ActivityVectors.

Returns:

the number of ActivityVectors

getIndexMap

public Map<String,Integer> getIndexMap()

Returns a map that maps from ActivityVector name to its iterator index.

Returns:

the map

dump

public void dump(SongContext songContext,
        String title,
        Level level)

Dumps the activity vectors as an activity matrix using the given log level.

Parameters:

songContext - the song context

title - the title

level - the log level to use