com.googlecode.blaisemath.graph.mod.metrics.AbstractGraphNodeMetric Maven / Gradle / Ivy

Go to download
/**
 * AbstractGraphNodeMetric.java
 * Created May 19, 2016
 */
package com.googlecode.blaisemath.graph.mod.metrics;

/*
 * #%L
 * blaise-graphtheory3
 * --
 * Copyright (C) 2009 - 2017 Elisha Peterson
 * --
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *      http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * #L%
 */


import com.googlecode.blaisemath.graph.Graph;
import com.googlecode.blaisemath.graph.GraphMetrics;
import com.googlecode.blaisemath.graph.GraphNodeMetric;
import java.util.Map;

/**
 * Gives a name to the metric and provides a default implementation for mapping
 * all values.
 * 
 * @param  metric result type
 * 
 * @author elisha
 */
public abstract class AbstractGraphNodeMetric implements GraphNodeMetric {
   
    protected final String name;

    public AbstractGraphNodeMetric(String name) {
        this.name = name;
    }
    
    @Override
    public String toString() {
        return name;
    }

    @Override
    public  Map apply(Graph graph) {
        return GraphMetrics.computeValues(graph, this);
    }
    
}