| /* |
| * Licensed to the Apache Software Foundation (ASF) under one or more |
| * contributor license agreements. See the NOTICE file distributed with this |
| * work for additional information regarding copyright ownership. The ASF |
| * licenses this file to You 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. |
| */ |
| |
| package org.apache.hugegraph.api.traversers; |
| |
| import static org.apache.hugegraph.traversal.algorithm.HugeTraverser.DEFAULT_ELEMENTS_LIMIT; |
| import static org.apache.hugegraph.traversal.algorithm.HugeTraverser.DEFAULT_MAX_DEGREE; |
| import static org.apache.hugegraph.traversal.algorithm.HugeTraverser.NO_LIMIT; |
| |
| import java.util.Collections; |
| import java.util.HashSet; |
| import java.util.Iterator; |
| import java.util.List; |
| import java.util.Set; |
| |
| import org.apache.hugegraph.HugeGraph; |
| import org.apache.hugegraph.api.graph.EdgeAPI; |
| import org.apache.hugegraph.api.graph.VertexAPI; |
| import org.apache.hugegraph.backend.id.Id; |
| import org.apache.hugegraph.backend.query.QueryResults; |
| import org.apache.hugegraph.core.GraphManager; |
| import org.apache.hugegraph.structure.HugeVertex; |
| import org.apache.hugegraph.traversal.algorithm.HugeTraverser; |
| import org.apache.hugegraph.traversal.algorithm.KneighborTraverser; |
| import org.apache.hugegraph.traversal.algorithm.records.KneighborRecords; |
| import org.apache.hugegraph.traversal.algorithm.steps.Steps; |
| import org.apache.hugegraph.type.define.Directions; |
| import org.apache.hugegraph.util.E; |
| import org.apache.hugegraph.util.Log; |
| import org.apache.tinkerpop.gremlin.structure.Edge; |
| import org.slf4j.Logger; |
| |
| import com.codahale.metrics.annotation.Timed; |
| import com.fasterxml.jackson.annotation.JsonProperty; |
| import com.google.common.collect.ImmutableList; |
| import com.google.common.collect.ImmutableMap; |
| |
| import io.swagger.v3.oas.annotations.tags.Tag; |
| import jakarta.inject.Singleton; |
| import jakarta.ws.rs.Consumes; |
| import jakarta.ws.rs.DefaultValue; |
| import jakarta.ws.rs.GET; |
| import jakarta.ws.rs.POST; |
| import jakarta.ws.rs.Path; |
| import jakarta.ws.rs.PathParam; |
| import jakarta.ws.rs.Produces; |
| import jakarta.ws.rs.QueryParam; |
| import jakarta.ws.rs.core.Context; |
| |
| @Path("graphs/{graph}/traversers/kneighbor") |
| @Singleton |
| @Tag(name = "KneighborAPI") |
| public class KneighborAPI extends TraverserAPI { |
| |
| private static final Logger LOG = Log.logger(KneighborAPI.class); |
| |
| @GET |
| @Timed |
| @Produces(APPLICATION_JSON_WITH_CHARSET) |
| public String get(@Context GraphManager manager, |
| @PathParam("graph") String graph, |
| @QueryParam("source") String sourceV, |
| @QueryParam("direction") String direction, |
| @QueryParam("label") String edgeLabel, |
| @QueryParam("max_depth") int depth, |
| @QueryParam("count_only") |
| @DefaultValue("false") boolean countOnly, |
| @QueryParam("max_degree") |
| @DefaultValue(DEFAULT_MAX_DEGREE) long maxDegree, |
| @QueryParam("limit") |
| @DefaultValue(DEFAULT_ELEMENTS_LIMIT) int limit) { |
| LOG.debug("Graph [{}] get k-neighbor from '{}' with " + |
| "direction '{}', edge label '{}', max depth '{}', " + |
| "max degree '{}' and limit '{}'", |
| graph, sourceV, direction, edgeLabel, depth, |
| maxDegree, limit); |
| |
| ApiMeasurer measure = new ApiMeasurer(); |
| |
| Id source = VertexAPI.checkAndParseVertexId(sourceV); |
| Directions dir = Directions.convert(EdgeAPI.parseDirection(direction)); |
| |
| HugeGraph g = graph(manager, graph); |
| |
| Set<Id> ids; |
| try (KneighborTraverser traverser = new KneighborTraverser(g)) { |
| ids = traverser.kneighbor(source, dir, edgeLabel, |
| depth, maxDegree, limit); |
| measure.addIterCount(traverser.vertexIterCounter.get(), |
| traverser.edgeIterCounter.get()); |
| } |
| if (countOnly) { |
| return manager.serializer(g, measure.measures()) |
| .writeMap(ImmutableMap.of("vertices_size", ids.size())); |
| } |
| return manager.serializer(g, measure.measures()).writeList("vertices", ids); |
| } |
| |
| @POST |
| @Timed |
| @Consumes(APPLICATION_JSON) |
| @Produces(APPLICATION_JSON_WITH_CHARSET) |
| public String post(@Context GraphManager manager, |
| @PathParam("graph") String graph, |
| Request request) { |
| E.checkArgumentNotNull(request, "The request body can't be null"); |
| E.checkArgumentNotNull(request.source, |
| "The source of request can't be null"); |
| E.checkArgument(request.steps != null, |
| "The steps of request can't be null"); |
| if (request.countOnly) { |
| E.checkArgument(!request.withVertex && !request.withPath && !request.withEdge, |
| "Can't return vertex, edge or path when count only"); |
| } |
| |
| LOG.debug("Graph [{}] get customized kneighbor from source vertex " + |
| "'{}', with steps '{}', limit '{}', count_only '{}', " + |
| "with_vertex '{}', with_path '{}' and with_edge '{}'", |
| graph, request.source, request.steps, request.limit, |
| request.countOnly, request.withVertex, request.withPath, |
| request.withEdge); |
| |
| ApiMeasurer measure = new ApiMeasurer(); |
| |
| HugeGraph g = graph(manager, graph); |
| Id sourceId = HugeVertex.getIdValue(request.source); |
| |
| Steps steps = steps(g, request.steps); |
| |
| KneighborRecords results; |
| try (KneighborTraverser traverser = new KneighborTraverser(g)) { |
| results = traverser.customizedKneighbor(sourceId, steps, |
| request.maxDepth, |
| request.limit); |
| measure.addIterCount(traverser.vertexIterCounter.get(), |
| traverser.edgeIterCounter.get()); |
| } |
| |
| long size = results.size(); |
| if (request.limit != NO_LIMIT && size > request.limit) { |
| size = request.limit; |
| } |
| List<Id> neighbors = request.countOnly ? |
| ImmutableList.of() : results.ids(request.limit); |
| |
| HugeTraverser.PathSet paths = new HugeTraverser.PathSet(); |
| if (request.withPath) { |
| paths.addAll(results.paths(request.limit)); |
| } |
| |
| if (request.countOnly) { |
| return manager.serializer(g, measure.measures()) |
| .writeNodesWithPath("kneighbor", neighbors, size, paths, |
| QueryResults.emptyIterator(), |
| QueryResults.emptyIterator()); |
| } |
| |
| Iterator<?> iterVertex; |
| Set<Id> vertexIds = new HashSet<>(neighbors); |
| if (request.withPath) { |
| for (HugeTraverser.Path p : paths) { |
| vertexIds.addAll(p.vertices()); |
| } |
| } |
| if (request.withVertex && !vertexIds.isEmpty()) { |
| iterVertex = g.vertices(vertexIds.toArray()); |
| measure.addIterCount(vertexIds.size(), 0L); |
| } else { |
| iterVertex = vertexIds.iterator(); |
| } |
| |
| Iterator<?> iterEdge = Collections.emptyIterator(); |
| if (request.withPath) { |
| Set<Edge> edges = results.edgeResults().getEdges(paths); |
| if (request.withEdge) { |
| iterEdge = edges.iterator(); |
| } else { |
| iterEdge = HugeTraverser.EdgeRecord.getEdgeIds(edges).iterator(); |
| } |
| } |
| |
| return manager.serializer(g, measure.measures()) |
| .writeNodesWithPath("kneighbor", neighbors, |
| size, paths, iterVertex, iterEdge); |
| } |
| |
| private static class Request { |
| |
| @JsonProperty("source") |
| public Object source; |
| @JsonProperty("steps") |
| public TraverserAPI.VESteps steps; |
| @JsonProperty("max_depth") |
| public int maxDepth; |
| @JsonProperty("limit") |
| public int limit = Integer.parseInt(DEFAULT_ELEMENTS_LIMIT); |
| @JsonProperty("count_only") |
| public boolean countOnly = false; |
| @JsonProperty("with_vertex") |
| public boolean withVertex = false; |
| @JsonProperty("with_path") |
| public boolean withPath = false; |
| @JsonProperty("with_edge") |
| public boolean withEdge = false; |
| |
| @Override |
| public String toString() { |
| return String.format("PathRequest{source=%s,steps=%s,maxDepth=%s" + |
| "limit=%s,countOnly=%s,withVertex=%s," + |
| "withPath=%s,withEdge=%s}", this.source, this.steps, |
| this.maxDepth, this.limit, this.countOnly, |
| this.withVertex, this.withPath, this.withEdge); |
| } |
| } |
| } |