org.jfree.data.xy: public class: NormalizedMatrixSeries

org.jfree.data.xy
public class: NormalizedMatrixSeries [javadoc | source]

java.lang.Object
   org.jfree.data.general.Series
      org.jfree.data.xy.MatrixSeries
         org.jfree.data.xy.NormalizedMatrixSeries

All Implemented Interfaces:
Serializable, Cloneable

Represents a dense normalized matrix M[i,j] where each Mij item of the matrix has a value (default is 0). When a matrix item is observed using getItem method, it is normalized, that is, divided by the total sum of all items. It can be also be scaled by setting a scale factor.

Field Summary
public static final double	DEFAULT_SCALE_FACTOR	The default scale factor.

Fields inherited from org.jfree.data.xy.MatrixSeries:
data

Constructor:

Constructor:
public NormalizedMatrixSeries(String name, int rows, int columns) { super(name, rows, columns); /* * we assum super is always initialized to all-zero matrix, so the * total sum should be 0 upon initialization. However, we set it to * Double.MIN_VALUE to get the same effect and yet avoid division by 0 * upon initialization. / this.m_totalSum = Double.MIN_VALUE; } Constructor for NormalizedMatrixSeries. Parameters:* `name` - the series name. `rows` - the number of rows. `columns` - the number of columns.

 public NormalizedMatrixSeries(String name,
    int rows,
    int columns) {
                                
        super(name, rows, columns);
        /*
         * we assum super is always initialized to all-zero matrix, so the
         * total sum should be 0 upon initialization. However, we set it to
         * Double.MIN_VALUE to get the same effect and yet avoid division by 0
         * upon initialization.
         */
        this.m_totalSum = Double.MIN_VALUE;
}

Constructor for NormalizedMatrixSeries.

Parameters:

name - the series name.

rows - the number of rows.

columns - the number of columns.

Method from org.jfree.data.xy.NormalizedMatrixSeries Summary:
getItem, getScaleFactor, setScaleFactor, update, zeroAll

Methods from org.jfree.data.xy.MatrixSeries:
equals, get, getColumnsCount, getItem, getItemColumn, getItemCount, getItemRow, getRowCount, update, zeroAll

Methods from org.jfree.data.general.Series:
addChangeListener, addPropertyChangeListener, clone, equals, firePropertyChange, fireSeriesChanged, getDescription, getItemCount, getKey, getNotify, hashCode, isEmpty, notifyListeners, removeChangeListener, removePropertyChangeListener, setDescription, setKey, setNotify

Methods from java.lang.Object:
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method from org.jfree.data.xy.NormalizedMatrixSeries Detail:
public Number getItem(int itemIndex) { int i = getItemRow(itemIndex); int j = getItemColumn(itemIndex); double mij = get(i, j) * this.m_scaleFactor; Number n = new Double(mij / this.m_totalSum); return n; } Returns an item.
public double getScaleFactor() { return this.m_scaleFactor; } Returns the factor that multiplies each item in this series when observed using getItem mehtod.
public void setScaleFactor(double factor) { this.m_scaleFactor = factor; // FIXME: this should generate a series change event } Sets the factor that multiplies each item in this series when observed using getItem mehtod.
public void update(int i, int j, double mij) { this.m_totalSum -= get(i, j); this.m_totalSum += mij; super.update(i, j, mij); } Updates the value of the specified item in this matrix series.
public void zeroAll() { this.m_totalSum = 0; super.zeroAll(); }

Method from org.jfree.data.xy.NormalizedMatrixSeries Detail:

 public Number getItem(int itemIndex) {
        int i = getItemRow(itemIndex);
        int j = getItemColumn(itemIndex);
        double mij = get(i, j) * this.m_scaleFactor;
        Number n = new Double(mij / this.m_totalSum);
        return n;
}

Returns an item.

 public double getScaleFactor() {
        return this.m_scaleFactor;
}

Returns the factor that multiplies each item in this series when observed using getItem mehtod.

 public  void setScaleFactor(double factor) {
        this.m_scaleFactor = factor;
        // FIXME: this should generate a series change event
}

Sets the factor that multiplies each item in this series when observed using getItem mehtod.

 public  void update(int i,
    int j,
    double mij) {
        this.m_totalSum -= get(i, j);
        this.m_totalSum += mij;
        super.update(i, j, mij);
}

Updates the value of the specified item in this matrix series.

 public  void zeroAll() {
        this.m_totalSum = 0;
        super.zeroAll();
}