Endpoint.java
No OneTemporary
Actions

Size

10 KB

Subscribers

None

Endpoint.java
View Options

	package org.softwareheritage.graph;

	import java.util.ArrayList;

	import org.softwareheritage.graph.Graph;
	import org.softwareheritage.graph.SwhPID;
	import org.softwareheritage.graph.SwhPath;
	import org.softwareheritage.graph.algo.Traversal;
	import org.softwareheritage.graph.benchmark.utils.Timing;

	/**
	* REST API endpoints wrapper functions.
	* <p>
	* Graph operations are segmented between high-level class (this one) and the low-level class
	* ({@link Traversal}). The {@link Endpoint} class creates wrappers for each endpoints by performing
	* all the input/output node ids conversions and logging timings.
	*
	* @author The Software Heritage developers
	* @see org.softwareheritage.graph.algo.Traversal
	*/

	public class Endpoint {
	/**
	* Wrapper class to unify traversal methods input signatures.
	*/
	public static class Input {
	/** Source node of endpoint call specified as a {@link SwhPID} */
	public SwhPID src;
	/**
	* Destination formatted string as described in the <a
	* href="https://docs.softwareheritage.org/devel/swh-graph/api.html#walk">API</a>
	*/
	public String dstFmt;
	/** Traversal algorithm used in endpoint call (either "dfs" or "bfs") */
	public String algorithm;

	public Input(SwhPID src) {
	this.src = src;
	}

	public Input(SwhPID src, String dstFmt, String algorithm) {
	this.src = src;
	this.dstFmt = dstFmt;
	this.algorithm = algorithm;
	}
	}

	/**
	* Wrapper class to return both the endpoint result and metadata (such as timings).
	*/
	public static class Output<T> {
	/** The result content itself */
	public T result;
	/** Various metadata about the result */
	public Meta meta;

	public Output() {
	this.result = null;
	this.meta = new Meta();
	}

	/**
	* Endpoint result metadata.
	*/
	public class Meta {
	/** Operations timings */
	public Timings timings;
	/** Number of edges accessed during traversal */
	public long nbEdgesAccessed;

	public Meta() {
	this.timings = new Timings();
	this.nbEdgesAccessed = 0;
	}

	/**
	* Wrapper class for JSON output format.
	*/
	public class Timings {
	/** Time in seconds to do the traversal */
	public double traversal;
	/** Time in seconds to convert input SWH PID to node id */
	public double pid2node;
	/** Time in seconds to convert output node ids to SWH PIDs */
	public double node2pid;
	}
	}
	}

	/** Graph where traversal endpoint is performed */
	Graph graph;
	/** Internal traversal API */
	Traversal traversal;

	/**
	* Constructor.
	*
	* @param graph the graph used for traversal endpoint
	* @param direction a string (either "forward" or "backward") specifying edge orientation
	* @param edgesFmt a formatted string describing <a
	* href="https://docs.softwareheritage.org/devel/swh-graph/api.html#terminology">allowed edges</a>
	*/
	public Endpoint(Graph graph, String direction, String edgesFmt) {
	this.graph = graph;
	this.traversal = new Traversal(graph, direction, edgesFmt);
	}

	/**
	* Converts a list of (internal) long node ids to a list of corresponding (external) SWH PIDs.
	*
	* @param nodeIds the list of long node ids
	* @return a list of corresponding SWH PIDs
	*/
	private ArrayList<SwhPID> convertNodesToSwhPIDs(ArrayList<Long> nodeIds) {
	ArrayList<SwhPID> swhPIDs = new ArrayList<>();
	for (long nodeId : nodeIds) {
	swhPIDs.add(graph.getSwhPID(nodeId));
	}
	return swhPIDs;
	}

	/**
	* Converts a list of (internal) long node ids to the corresponding {@link SwhPath}.
	*
	* @param nodeIds the list of long node ids
	* @return the corresponding {@link SwhPath}
	* @see org.softwareheritage.graph.SwhPath
	*/
	private SwhPath convertNodesToSwhPath(ArrayList<Long> nodeIds) {
	SwhPath path = new SwhPath();
	for (long nodeId : nodeIds) {
	path.add(graph.getSwhPID(nodeId));
	}
	return path;
	}

	/**
	* Converts a list of paths made of (internal) long node ids to one made of {@link SwhPath}-s.
	*
	* @param pathsNodeId the list of paths with long node ids
	* @return a list of corresponding {@link SwhPath}
	* @see org.softwareheritage.graph.SwhPath
	*/
	private ArrayList<SwhPath> convertPathsToSwhPIDs(ArrayList<ArrayList<Long>> pathsNodeId) {
	ArrayList<SwhPath> paths = new ArrayList<>();
	for (ArrayList<Long> path : pathsNodeId) {
	paths.add(convertNodesToSwhPath(path));
	}
	return paths;
	}

	/**
	* Leaves endpoint wrapper.
	*
	* @param input input parameters for the underlying endpoint call
	* @return the resulting list of {@link SwhPID} from endpoint call and operation metadata
	* @see org.softwareheritage.graph.SwhPID
	* @see org.softwareheritage.graph.algo.Traversal#leaves(long)
	*/
	public Output leaves(Input input) {
	Output<ArrayList<SwhPID>> output = new Output<>();
	long startTime;

	startTime = Timing.start();
	long srcNodeId = graph.getNodeId(input.src);
	output.meta.timings.pid2node = Timing.stop(startTime);

	startTime = Timing.start();
	ArrayList<Long> nodeIds = traversal.leaves(srcNodeId);
	output.meta.timings.traversal = Timing.stop(startTime);
	output.meta.nbEdgesAccessed = traversal.getNbEdgesAccessed();

	startTime = Timing.start();
	output.result = convertNodesToSwhPIDs(nodeIds);
	output.meta.timings.node2pid = Timing.stop(startTime);

	return output;
	}

	/**
	* Neighbors endpoint wrapper.
	*
	* @param input input parameters for the underlying endpoint call
	* @return the resulting list of {@link SwhPID} from endpoint call and operation metadata
	* @see org.softwareheritage.graph.SwhPID
	* @see org.softwareheritage.graph.algo.Traversal#neighbors(long)
	*/
	public Output neighbors(Input input) {
	Output<ArrayList<SwhPID>> output = new Output<>();
	long startTime;

	startTime = Timing.start();
	long srcNodeId = graph.getNodeId(input.src);
	output.meta.timings.pid2node = Timing.stop(startTime);

	startTime = Timing.start();
	ArrayList<Long> nodeIds = traversal.neighbors(srcNodeId);
	output.meta.timings.traversal = Timing.stop(startTime);
	output.meta.nbEdgesAccessed = traversal.getNbEdgesAccessed();

	startTime = Timing.start();
	output.result = convertNodesToSwhPIDs(nodeIds);
	output.meta.timings.node2pid = Timing.stop(startTime);

	return output;
	}

	/**
	* Walk endpoint wrapper.
	*
	* @param input input parameters for the underlying endpoint call
	* @return the resulting {@link SwhPath} from endpoint call and operation metadata
	* @see org.softwareheritage.graph.SwhPID
	* @see org.softwareheritage.graph.SwhPath
	* @see org.softwareheritage.graph.algo.Traversal#walk
	*/
	public Output walk(Input input) {
	Output<SwhPath> output = new Output<>();
	long startTime;

	startTime = Timing.start();
	long srcNodeId = graph.getNodeId(input.src);
	output.meta.timings.pid2node = Timing.stop(startTime);

	ArrayList<Long> nodeIds = new ArrayList<Long>();

	// Destination is either a SWH PID or a node type
	try {
	SwhPID dstSwhPID = new SwhPID(input.dstFmt);
	long dstNodeId = graph.getNodeId(dstSwhPID);

	startTime = Timing.start();
	nodeIds = traversal.walk(srcNodeId, dstNodeId, input.algorithm);
	output.meta.timings.traversal = Timing.stop(startTime);
	} catch (IllegalArgumentException ignored1) {
	try {
	Node.Type dstType = Node.Type.fromStr(input.dstFmt);

	startTime = Timing.start();
	nodeIds = traversal.walk(srcNodeId, dstType, input.algorithm);
	output.meta.timings.traversal = Timing.stop(startTime);
	} catch (IllegalArgumentException ignored2) {
	}
	}

	output.meta.nbEdgesAccessed = traversal.getNbEdgesAccessed();

	startTime = Timing.start();
	output.result = convertNodesToSwhPath(nodeIds);
	output.meta.timings.node2pid = Timing.stop(startTime);

	return output;
	}

	/**
	* VisitNodes endpoint wrapper.
	*
	* @param input input parameters for the underlying endpoint call
	* @return the resulting list of {@link SwhPID} from endpoint call and operation metadata
	* @see org.softwareheritage.graph.SwhPID
	* @see org.softwareheritage.graph.algo.Traversal#visitNodes(long)
	*/
	public Output visitNodes(Input input) {
	Output<ArrayList<SwhPID>> output = new Output<>();
	long startTime;

	startTime = Timing.start();
	long srcNodeId = graph.getNodeId(input.src);
	output.meta.timings.pid2node = Timing.stop(startTime);

	startTime = Timing.start();
	ArrayList<Long> nodeIds = traversal.visitNodes(srcNodeId);
	output.meta.timings.traversal = Timing.stop(startTime);
	output.meta.nbEdgesAccessed = traversal.getNbEdgesAccessed();

	startTime = Timing.start();
	output.result = convertNodesToSwhPIDs(nodeIds);
	output.meta.timings.node2pid = Timing.stop(startTime);

	return output;
	}

	/**
	* VisitPaths endpoint wrapper.
	*
	* @param input input parameters for the underlying endpoint call
	* @return the resulting list of {@link SwhPath} from endpoint call and operation metadata
	* @see org.softwareheritage.graph.SwhPID
	* @see org.softwareheritage.graph.SwhPath
	* @see org.softwareheritage.graph.algo.Traversal#visitPaths(long)
	*/
	public Output visitPaths(Input input) {
	Output<ArrayList<SwhPath>> output = new Output<>();
	long startTime;

	startTime = Timing.start();
	long srcNodeId = graph.getNodeId(input.src);
	output.meta.timings.pid2node = Timing.stop(startTime);

	startTime = Timing.start();
	ArrayList<ArrayList<Long>> paths = traversal.visitPaths(srcNodeId);
	output.meta.timings.traversal = Timing.stop(startTime);
	output.meta.nbEdgesAccessed = traversal.getNbEdgesAccessed();

	startTime = Timing.start();
	output.result = convertPathsToSwhPIDs(paths);
	output.meta.timings.node2pid = Timing.stop(startTime);

	return output;
	}
	}

File Metadata

Mime Type: text/x-java
Expires: Fri, Jul 4, 2:38 PM (3 d, 9 h ago)
Storage Engine: blob
Storage Format: Raw Data
Storage Handle: 3368683

Endpoint.javaNo OneTemporaryActions

Endpoint.javaView Options

File Metadata

Event Timeline

Endpoint.java
No OneTemporary
Actions

Endpoint.java
View Options