edu.uci.ics.jung.visualization.util.PredicatedParallelEdgeIndexFunction Maven / Gradle / Ivy

Go to download
/*
 * Created on Sep 24, 2005
 *
 * Copyright (c) 2005, The JUNG Authors
 *
 * All rights reserved.
 *
 * This software is open-source under the BSD license; see either
 * "license.txt" or
 * https://github.com/jrtom/jung/blob/master/LICENSE for a description.
 */
package edu.uci.ics.jung.visualization.util;

import com.google.common.graph.Network;
import java.util.function.Predicate;

/**
 * A class which creates and maintains indices for parallel edges. Edges are evaluated by a
 * Predicate function and those that evaluate to true are excluded from computing a parallel offset.
 *
 * @author Tom Nelson
 */
public class PredicatedParallelEdgeIndexFunction extends ParallelEdgeIndexFunction {
  protected Predicate predicate;

  public PredicatedParallelEdgeIndexFunction(Predicate predicate) {
    this.predicate = predicate;
  }

  /**
   * Returns the index for the specified edge, or 0 if {@code edge} is accepted by the Predicate.
   *
   * @param context the network and the edge whose index is to be calculated
   */
  @Override
  public int getIndex(Context, E> context) {
    return predicate.test(context.element) ? 0 : super.getIndex(context);
  }

  public Predicate getPredicate() {
    return predicate;
  }

  public void setPredicate(Predicate predicate) {
    this.predicate = predicate;
  }
}