/*
 * #%L
 * org.gitools.heatmap
 * %%
 * Copyright (C) 2013 - 2014 Universitat Pompeu Fabra - Biomedical Genomics group
 * %%
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as
 * published by the Free Software Foundation, either version 3 of the 
 * License, or (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public 
 * License along with this program.  If not, see
 * <http://www.gnu.org/licenses/gpl-3.0.html>.
 * #L%
 */
package org.gitools.heatmap.decorator.impl;


import org.gitools.api.matrix.AbstractMatrixFunction;
import org.gitools.api.matrix.IMatrixPosition;
import org.gitools.utils.colorscale.INumericColorScale;

import javax.xml.bind.annotation.XmlTransient;

public abstract class NonEventToNullFunction<T extends INumericColorScale> extends AbstractMatrixFunction<Double, Double> {

    private String name;

    @XmlTransient
    private T colorScale;

    protected IMatrixPosition position;

    protected NonEventToNullFunction(T colorScale, String name) {
        this.name = name;
        this.colorScale = colorScale;
    }

    public T getColorScale() {
        return colorScale;
    }

    public IMatrixPosition getPosition() {
        return position;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public abstract String getDescription();

    @Override
    public String toString() {
        return name;
    }
}
