Flowcharting (autest - Gitee.com))

java.lang.Object
- com.auxiliary.testcase.scene.Flowcharting

All Implemented Interfaces:

Cloneable
```
public class Flowcharting
extends Object
implements Cloneable
```
文件名：Flowcharting.java

用途： 用于定义流程图的各个节点与其之间的连线关系，生成基于Mermaid语法的流程图文本，该内容可写入到支持Mermaid的Markdown编辑器中，或通过Mermaid在线编辑器生成相应的流程图

注意：每次添加节点后，会以默认的线型连接上一次添加的节点，若不希望连接上一次节点，可调用Flowcharting.FlowchartNode.addParentNode(String...)等方法修改相应的父层或子层；图形内容请勿出现中文标点符号，其Meraid语法不支持中文标点

编码时间：2022年3月4日上午7:51:20

修改时间：2022年3月4日上午7:51:20

Since:

JDK 1.8, autest 3.2.0

Version:

Ver1.0

Author:

彭宇琦

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

class Flowcharting.FlowchartNode
文件名：Flowcharting.java

class Flowcharting.LineEntry
文件名：Flowcharting.java

Nested Classes
Modifier and Type	Class and Description
`class`	`Flowcharting.FlowchartNode` 文件名：Flowcharting.java
`class`	`Flowcharting.LineEntry` 文件名：Flowcharting.java

Constructor Summary

Constructors
Constructor and Description

Flowcharting(String nodeName, String nodeText)
构造对象，初始化起始节点

Constructors
Constructor and Description
`Flowcharting(String nodeName, String nodeText)` 构造对象，初始化起始节点

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`addEndNode(String nodeText)` 该方法用于添加结束节点
`Flowcharting.FlowchartNode`	`addEndNode(String nodeName, String nodeText)` 该方法用于添加结束节点
`String`	`addFlowNode(String nodeText)` 该方法用于添加普通流程节点
`Flowcharting.FlowchartNode`	`addFlowNode(String nodeName, String nodeText)` 该方法用于添加普通流程节点
`Flowcharting.FlowchartNode`	`addJudgeNode(String nodeName, String nodeText)` 该方法用于添加判断节点
`Flowcharting.FlowchartNode`	`addNode(String nodeName, String nodeText, NodeGraphType nodeGraphType)` 该方法用于添加一个自定义图形的节点元素
`Flowcharting.FlowchartNode`	`addPageReferenceNode(String nodeName, String nodeText)` 该方法用于添加页面引用节点
`Flowcharting`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getFlowchartMermaidText(FlowchartDirectionType flowchartDirectionType)` 该方法用于返回在Markdown中，Mermaid语法绘制流程图的文本
`int`	`getInsularNodeNumber()` 该方法用于返回孤立节点的个数
`HashSet<String>`	`getInsularNodeSet()` 该方法用于返回流程图的孤立节点集合
`int`	`getLineNumber()` 该方法用于返回流程图中的连线数量（边数）
`Flowcharting.FlowchartNode`	`getNode(String nodeName)` 该方法用于返回指定名称的节点
`HashMap<String,Flowcharting.FlowchartNode>`	`getNodeMap()` 该方法用于返回流程图中的节点集合
`int`	`getNodeNumber()` 该方法用于返回当前流程图中的节点数
`String`	`getStartNode()` 该方法用于返回流程图的起始节点
`int`	`hashCode()`
`String`	`toString()`

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Flowcharting
```
public Flowcharting(String nodeName,
                    String nodeText)
```
    构造对象，初始化起始节点
    
    Parameters:
    
    nodeName - 起始节点名称
    
    nodeText - 起始节点文本
    
    Since:
    
    autest 3.2.0
- Method Detail
  - addNode
```
public Flowcharting.FlowchartNode addNode(String nodeName,
                                          String nodeText,
                                          NodeGraphType nodeGraphType)
```
    该方法用于添加一个自定义图形的节点元素
    当传入的节点名称存在时，则只修改其节点内容与图形样式，若节点为起始节点，则只修改其内容，不修改图形样式
    
    注意：自定义的图形元素不被当做特殊元素处理，例如，使用NodeGraphType.DIAMOND枚举，其不会被当成判定节点，只作为普通节点看待
    
    Parameters:
    
    nodeName - 节点名称
    
    nodeText - 节点文本
    
    nodeGraphType - 节点图形样式
    
    Returns:
    
    节点类对象
    
    Throws:
    
    TestCaseException - 节点名称为空时抛出的异常
    
    Since:
    
    autest 3.2.0
  - addJudgeNode
```
public Flowcharting.FlowchartNode addJudgeNode(String nodeName,
                                               String nodeText)
```
    该方法用于添加判断节点
    当传入的节点名称存在时，则只修改其节点内容与图形样式，若节点为起始节点，则只修改其内容，不修改图形样式
    
    Parameters:
    
    nodeName - 节点名称
    
    nodeText - 节点内文本
    
    Returns:
    
    节点类对象
    
    Throws:
    
    TestCaseException - 节点名称为空时抛出的异常
    
    Since:
    
    autest 3.2.0
  - addFlowNode
```
public Flowcharting.FlowchartNode addFlowNode(String nodeName,
                                              String nodeText)
```
    该方法用于添加普通流程节点
    当传入的节点名称存在时，则只修改其节点内容与图形样式，若节点为起始节点，则只修改其内容，不修改图形样式
    
    Parameters:
    
    nodeName - 节点名称
    
    nodeText - 节点内文本
    
    Returns:
    
    节点类对象
    
    Throws:
    
    TestCaseException - 节点名称为空时抛出的异常
    
    Since:
    
    autest 3.2.0
  - addFlowNode
```
public String addFlowNode(String nodeText)
```
    该方法用于添加普通流程节点
    注意：通过该方法添加的节点将使用一个随机的一串英文作为节点名称并进行返回
    
    Parameters:
    
    nodeText - 节点文本
    
    Returns:
    
    节点的名称
    
    Since:
    
    autest 3.2.0
  - addEndNode
```
public Flowcharting.FlowchartNode addEndNode(String nodeName,
                                             String nodeText)
```
    该方法用于添加结束节点
    当传入的节点名称存在时，则只修改其节点内容与图形样式，若节点为起始节点，则只修改其内容，不修改图形样式
    
    Parameters:
    
    nodeName - 节点名称
    
    nodeText - 节点内文本
    
    Returns:
    
    节点类对象
    
    Throws:
    
    TestCaseException - 节点名称为空时抛出的异常
    
    Since:
    
    autest 3.2.0
  - addEndNode
```
public String addEndNode(String nodeText)
```
    该方法用于添加结束节点
    注意：通过该方法添加的节点将使用一个随机的一串英文作为节点名称并进行返回
    
    Parameters:
    
    nodeText - 节点文本
    
    Returns:
    
    节点的名称
    
    Since:
    
    autest 3.2.0
  - addPageReferenceNode
```
public Flowcharting.FlowchartNode addPageReferenceNode(String nodeName,
                                                       String nodeText)
```
    该方法用于添加页面引用节点
    当传入的节点名称存在时，则只修改其节点内容与图形样式，若节点为起始节点，则只修改其内容，不修改图形样式
    
    Parameters:
    
    nodeName - 节点名称
    
    nodeText - 节点内文本
    
    Returns:
    
    节点类对象
    
    Throws:
    
    TestCaseException - 节点名称为空时抛出的异常
    
    Since:
    
    autest 3.2.0
  - getNode
```
public Flowcharting.FlowchartNode getNode(String nodeName)
```
    该方法用于返回指定名称的节点
    
    Parameters:
    
    nodeName - 节点名称
    
    Returns:
    
    指定名称的节点
    
    Since:
    
    autest 3.2.0
  - getNodeNumber
```
public int getNodeNumber()
```
    该方法用于返回当前流程图中的节点数
    
    Returns:
    
    节点数
    
    Since:
    
    autest 3.2.0
  - getLineNumber
```
public int getLineNumber()
```
    该方法用于返回流程图中的连线数量（边数）
    注意：输出边数时，需要先调用getFlowchartMermaidText(FlowchartDirectionType)方法，对流程图输出后，才能返回当前流程图的边数，否则只能返回上一次输出的流程图边数
    
    Returns:
    
    连线数量（边数）
    
    Since:
    
    autest 3.2.0
  - getInsularNodeNumber
```
public int getInsularNodeNumber()
```
    该方法用于返回孤立节点的个数
    
    Returns:
    
    孤立节点的个数
    
    Since:
    
    autest 3.2.0
  - getFlowchartMermaidText
```
public String getFlowchartMermaidText(FlowchartDirectionType flowchartDirectionType)
```
    该方法用于返回在Markdown中，Mermaid语法绘制流程图的文本
    
    Parameters:
    
    flowchartDirectionType - 流程图方向枚举
    
    Returns:
    
    流程图的文本
    
    Throws:
    
    TestCaseException - 存在孤立流程时，抛出的异常
    
    Since:
    
    autest 3.2.0
  - getNodeMap
```
public HashMap<String,Flowcharting.FlowchartNode> getNodeMap()
```
    该方法用于返回流程图中的节点集合
    
    Returns:
    
    节点集合
    
    Since:
    
    autest 3.2.0
  - getStartNode
```
public String getStartNode()
```
    该方法用于返回流程图的起始节点
    
    Returns:
    
    流程图起始节点
    
    Since:
    
    autest 3.2.0
  - getInsularNodeSet
```
public HashSet<String> getInsularNodeSet()
```
    该方法用于返回流程图的孤立节点集合
    
    Returns:
    
    孤立节点集合
    
    Since:
    
    autest 3.2.0
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - clone
```
public Flowcharting clone()
```
    Overrides:
    
    clone in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class Flowcharting

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Flowcharting

Method Detail

addNode

addJudgeNode

addFlowNode

addFlowNode

addEndNode

addEndNode

addPageReferenceNode

getNode

getNodeNumber

getLineNumber

getInsularNodeNumber

getFlowchartMermaidText

getNodeMap

getStartNode

getInsularNodeSet

hashCode

equals

clone

toString