de.cismet.commons.gui.equalizer

Class RubberBandEqualizerModel

java.lang.Object

de.cismet.commons.gui.equalizer.AbstractEqualizerModel

de.cismet.commons.gui.equalizer.DefaultEqualizerModel

de.cismet.commons.gui.equalizer.RubberBandEqualizerModel

All Implemented Interfaces:

EqualizerModel

public final class RubberBandEqualizerModel
extends DefaultEqualizerModel

Special EqualizerModel that guarantees that the sum of all categories is 100. So if a new value is set all the other categories' values are adapted so that the sum is 100 again. Thus this model does not inform listeners about a specific change at a specific index but only fires a general change event.

The adaption of other values follows these rules:

• the delta of the changed value is distributed equally over the other categories
• if a specific category value is zero it will not be considered for distribution
• if a specific category value reaches zero during delta distribution it will also not be considered for distribution anymore
• if the (remaining) delta is smaller than the number of remaining categories a change of 1 is applied to the remaining categories, ascending by index

Version:

1.0

Author:

martin.scholl@cismet.de

Field Summary

Fields inherited from class de.cismet.commons.gui.equalizer.DefaultEqualizerModel

DEFAULT_RANGE, equalizerCategories

Constructor Summary

Constructors

Constructor and Description
RubberBandEqualizerModel(Collection<EqualizerCategory> equalizerCategories) Creates a new RubberBandEqualizerModel object using the given list of EqualizerCategorys.

Method Summary

Modifier and Type	Method and Description
void	setValueAt(int index, int value) Setter for the a new value at the specified index.

Methods inherited from class de.cismet.commons.gui.equalizer.DefaultEqualizerModel

checkValueWithinRange, getEqualizerCategories, getEqualizerCategory, getEqualizerCategoryCount, getRange, getValueAt

Methods inherited from class de.cismet.commons.gui.equalizer.AbstractEqualizerModel

addEqualizerModelListener, fireEqualizerModelEvent, removeEqualizerModelListener

Methods inherited from class java.lang.Object

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

Constructor Detail

RubberBandEqualizerModel

public RubberBandEqualizerModel(Collection<EqualizerCategory> equalizerCategories)

Creates a new RubberBandEqualizerModel object using the given list of EqualizerCategorys. The Range of this model is [0, 100]. In addition to the policies of DefaultEqualizerModel this model implementation ensures that the sum of all values of the categories is always 100. For convenience this constructor permits a category collection that contains categories with 0 values only. In this case the constructor distributes values among the categories equally so that a sum of 100 is guaranteed.

Parameters:

equalizerCategories - the EqualizerCategorys of this model

Throws:

IllegalArgumentException - if any of the policies of DefaultEqualizerModel are not met or if the sum of the categories' values is not 0 or 100

See Also:

DefaultEqualizerModel

Method Detail

setValueAt

public void setValueAt(int index,
                       int value)

Description copied from interface: EqualizerModel

Setter for the a new value at the specified index. The value has to be within the Range of this model. Otherwise an IllegalArgumentException shall be thrown. Shall throw IndexOutOfBoundsException if index is < 0 or >= EqualizerModel.getEqualizerCategoryCount().

Specified by:

setValueAt in interface EqualizerModel

Overrides:

setValueAt in class DefaultEqualizerModel

Parameters:

index - the category index

value - the new value