BfsParamBuilder (Bolt Java API)

java.lang.Object
- com.graphdbapi.driver.v1.graph.query.bfs.BfsParamBuilder

```
public class BfsParamBuilder
extends Object
```
BfsParam构造工具类 e.g. BfsParam bfsParam = BfsParamBuilder.create(id, 5) .setDirection(Direction.BOTH) .setDirection(2, Direction.OUT) .setVertexCondition(pv) .setVertexCondition(2, pv2) .setEdgeCondition(pe) .setEdgeCondition(2, pe2) .setEdgeTypeFilter(edgeType) .setEdgeTypeFilter(2, edgeType) .setLimitNeighbor(10) .setLimitEdge(10) .setHop(false) .setOnlyCount(true) .setReturnVertex(true) .setReturnEdge(true) .builder();

Constructor Summary

Constructors
Constructor and Description

BfsParamBuilder(long startId, int depth)

Constructors
Constructor and Description
`BfsParamBuilder(long startId, int depth)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`BfsParam`	`builder()` 生成`BfsParam`对象
`static BfsParamBuilder`	`create(long startId, int depth)` 构造BfsParamBuilder对象
`BfsParamBuilder`	`setDirection(Direction direction)` 方向。为所有扩展都设置方向。
`BfsParamBuilder`	`setDirection(int specifiedDepth, Direction direction)` 方向。为指定度数设置方向。
`BfsParamBuilder`	`setEdgeCondition(int specifiedDepth, VisitCondition pe)` 边条件。为指定度数设置边条件。默认无条件。
`BfsParamBuilder`	`setEdgeCondition(VisitCondition pe)` 边条件。为所有扩展都设置边条件。默认无条件。
`BfsParamBuilder`	`setEdgeTypeFilter(int specifiedDepth, Set<String> edgeType)` 边类型过滤。为指定度数设置边类型过滤。默认无条件。
`BfsParamBuilder`	`setEdgeTypeFilter(Set<String> edgeType)` 边类型过滤。为所有扩展都应用边过滤。默认无条件。
`BfsParamBuilder`	`setHop(boolean hop)` 是否启用hop模式。默认值：false
`BfsParamBuilder`	`setLimitEdge(int limitEdge)` 邻居边上限，-1为不限制。默认值：-1
`BfsParamBuilder`	`setLimitNeighbor(int limitNeighbor)` 邻居点上限，-1为不限制。默认值：-1
`BfsParamBuilder`	`setOnlyCount(boolean onlyCount)` 是否返回count。true表示返回count。false表示数据也要返回。默认值：false
`BfsParamBuilder`	`setReturnEdge(boolean returnEdge)` 是否返回结果边集。只有onlyCount为false时生效。默认值：false
`BfsParamBuilder`	`setReturnVertex(boolean returnVertex)` 是否返回结果点集。只有onlyCount为false时生效。默认值：false
`BfsParamBuilder`	`setVertexCondition(int specifiedDepth, VisitCondition pv)` 点条件。为指定度数设置点条件。默认无条件。
`BfsParamBuilder`	`setVertexCondition(VisitCondition pv)` 点条件。为所有扩展都设置点条件。默认无条件。

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - BfsParamBuilder
```
public BfsParamBuilder(long startId,
                       int depth)
```
- Method Detail
  - builder
```
public BfsParam builder()
```
    生成BfsParam对象
    
    Returns:
    
    BfsParam
  - create
```
public static BfsParamBuilder create(long startId,
                                     int depth)
```
    构造BfsParamBuilder对象
    
    Parameters:
    
    startId - 起始点
    
    depth - 度数
    
    Returns:
  - setDirection
```
public BfsParamBuilder setDirection(Direction direction)
```
    方向。为所有扩展都设置方向。
    
    Parameters:
    
    direction - 方向
  - setDirection
```
public BfsParamBuilder setDirection(int specifiedDepth,
                                    Direction direction)
```
    方向。为指定度数设置方向。
    
    Parameters:
    
    specifiedDepth - 度数
    
    direction - 方向
  - setEdgeCondition
```
public BfsParamBuilder setEdgeCondition(int specifiedDepth,
                                        VisitCondition pe)
```
    边条件。为指定度数设置边条件。默认无条件。
    
    Parameters:
    
    specifiedDepth - 度数
    
    pe - 边条件
  - setEdgeCondition
```
public BfsParamBuilder setEdgeCondition(VisitCondition pe)
```
    边条件。为所有扩展都设置边条件。默认无条件。
    
    Parameters:
    
    pe - 边条件
  - setEdgeTypeFilter
```
public BfsParamBuilder setEdgeTypeFilter(int specifiedDepth,
                                         Set<String> edgeType)
```
    边类型过滤。为指定度数设置边类型过滤。默认无条件。
    
    Parameters:
    
    specifiedDepth - 深度
    
    edgeType - 要过滤的边类型
  - setEdgeTypeFilter
```
public BfsParamBuilder setEdgeTypeFilter(Set<String> edgeType)
```
    边类型过滤。为所有扩展都应用边过滤。默认无条件。
    
    Parameters:
    
    edgeType - 要过滤的边类型
  - setHop
```
public BfsParamBuilder setHop(boolean hop)
```
    是否启用hop模式。默认值：false
    
    Parameters:
    
    hop -
  - setLimitEdge
```
public BfsParamBuilder setLimitEdge(int limitEdge)
```
    邻居边上限，-1为不限制。默认值：-1
    
    Parameters:
    
    limitEdge -
  - setLimitNeighbor
```
public BfsParamBuilder setLimitNeighbor(int limitNeighbor)
```
    邻居点上限，-1为不限制。默认值：-1
    
    Parameters:
    
    limitNeighbor -
  - setOnlyCount
```
public BfsParamBuilder setOnlyCount(boolean onlyCount)
```
    是否返回count。true表示返回count。false表示数据也要返回。默认值：false
    
    Parameters:
    
    onlyCount -
  - setReturnEdge
```
public BfsParamBuilder setReturnEdge(boolean returnEdge)
```
    是否返回结果边集。只有onlyCount为false时生效。默认值：false
    
    Parameters:
    
    returnEdge -
  - setReturnVertex
```
public BfsParamBuilder setReturnVertex(boolean returnVertex)
```
    是否返回结果点集。只有onlyCount为false时生效。默认值：false
    
    Parameters:
    
    returnVertex -
  - setVertexCondition
```
public BfsParamBuilder setVertexCondition(int specifiedDepth,
                                          VisitCondition pv)
```
    点条件。为指定度数设置点条件。默认无条件。
    
    Parameters:
    
    specifiedDepth - 度数
    
    pv - 点条件
  - setVertexCondition
```
public BfsParamBuilder setVertexCondition(VisitCondition pv)
```
    点条件。为所有扩展都设置点条件。默认无条件。
    
    Parameters:
    
    pv - 点条件

Class BfsParamBuilder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

BfsParamBuilder

Method Detail

builder

create

setDirection

setDirection

setEdgeCondition

setEdgeCondition

setEdgeTypeFilter

setEdgeTypeFilter

setHop

setLimitEdge

setLimitNeighbor

setOnlyCount

setReturnEdge

setReturnVertex

setVertexCondition

setVertexCondition