本项目已停止更新, 请访问最新版: https://github.com/Zhangliubin/commandParser-1.1
将程序封装为可运行的 jar 包，能够方便不同平台之间传输、使用，而不需要考虑 IDE 环境而进行繁琐的配置。通常 jar 包就包含了完成一套计算/分析/服务所需的全部代码，为了让 jar 包可以根据不同的输入参数执行不同的任务，以提升开发效率、用户交互体验，就需要进行命令行开发。
CommandParser 是一个基于 Java 平台开发的小型框架，用于解析、管理命令行参数。CommandParser 提供了脚本指令设计方式及图形化设计方式，便于用户方便地设计、管理命令行程序。
CommandParser 兼有传统命令行设计工具 Jcommander 的特点及独特的 GUI 图形化设计功能，在内测阶段已证实可以有效降低 Java 开发者编写命令行工具的门槛，降低代码耦合度。
技术问题请联系 张柳彬 (suranyi.sysu@gmail.com, 一定能看到，但是时效性不保证)
知乎ID: Suranyi (工作日随缘回复，非工作日 8 小时内回复)
CommandParser 在 JDK 8 中开发完成，得益于 Java 跨平台的特性，我们预计它也可以在所有支持 Java 语言的软件与硬件环境中运行。
- 在 Windows 和 MacOS 下，当设备准确配置了JDK运行环境时，可以双击启动图形界面；
- 在 Java 脚本程序中，可以通过导入该包进行使用。
| Type | File |
|---|---|
| Package | CommandParser-1.0.jar |
| Source codes | CommandParser-1.0 |
| 说明文档 | http://pmglab.top/commandParser/ |
| API 文档 |
我们建议阅读本文 “快速入门” 部分，以了解 commandParser 的使用方式。当你熟练掌握 commandParser 后，开发一个程序所需的命令行工具，甚至只需要几分钟时间。我们也鼓励现有的项目使用我们的 commandParser，尽管刚开始的迁移会有一点点痛苦 （主要是复制、粘贴，但我保证这是最轻松的迁移方式了！），但后续的扩展、管理会获得极大的收益。
我们在 github 上传了本项目的源码，在 src/dev/fromcommandfile/command 中提供了 7 个可供测试的指令文件 （动动你的手，将他们拖动到 commandParser 窗口中吧！），以及指令文件的使用方式提供参考。CommandParser 提供了两种方式导出设计的指令文件（*.cp 命令文件和 *.java 脚本文件），相应地也有两种使用方式，示例代码存放在：
src/dev/fromcommandfile: 从指令文件中加载参数解析器，并进行后续开发的实例src/dev/fromjavascript: 使用纯 Java 脚本编写指令文件（实际上这些文件是通过图形界面将src/dev/fromcommandfile/command转换为 Java 脚本文件实现的），并进行后续开发的实例
方法1: 在具有图形界面的操作系统上双击 commandParser.jar，打开图形界面 (需要操作系统配置了 java 环境)
方法2: 在具有图形界面的操作系统上使用终端 (terminal)，输入 java -jar ./commandParser-1.0.jar
方法1: 双击空白处，在末尾追加新的参数
方法2: 点击左下角 +，在选中位置插入新的参数
方法3: 点击右下角 Open 或拖拽一个文件到窗口中，将导入该参数文件中所有的参数
每个参数都有 12 个基本属性，其中 commandName, convertTo 和 arity 是建议设置的属性。每个属性的含义如下：
| 属性 | 含义 |
|---|---|
| commandName | 识别的参数名 (关键字)1. 参数名支持的字符类型: 阿拉伯数字0-9、大小写字母 a-zA-z、部分特殊字符 +-_ 2. 多个参数名定位到同一参数时，使用 , 进行分隔，第一个参数名将注册为主参数名3. 所有的参数名 (无论是否为主参数名) 都不可重复 |
| request | 是否为必备参数1. 在文档提示中，必备参数前有* 标记2. 设置为 request 的参数是必须传入的，若缺少必备参数则会抛出异常 |
| default | 设置默认值1. 当 default 包含,并且捕获的参数值个数不为 1 或 0 时，default 将按照 , 切割为数组2. 未指定默认值时，将设置为 null |
| convertTo | 参数转换的数据类型1. 默认值 (default) 和输入的参数值都会被 convertTo 转为对应的 Java 对象 (例如string-array 类型在 Java 中对应 String[]。有关各个转换器对应的参数类型，请阅读 开发文档)2. built-in 类型需要在 Java 脚本中重新调用 parser.getCommandItem($commandName).convertTo($myConvertor)进行设置3. passedIn 类型为传入类型，即仅验证参数是否被传入，而不捕获任何值 |
| validateWith | 使用验证器验证参数值1. 多个验证器使用; 进行分隔2. built-in 类型需要在 Java 脚本中重新调用 parser.getCommandItem($commandName).validateWith($myValidator)进行设置3. passedIn 类型禁止设置验证器 (即该项必须为.)4. ElementOf($value,$value,...) 为限定元素验证器，即元素的值必须在列出的项目中。它的元素值被识别为字符串类型，即 string, string-array, k1=v1;k2=v2;..., <start>-<end> (string), <index>:<start>-<end> (string) 类型支持此验证器，其余类型需要用户在命令脚本中定义规则。此外，元素值支持的字符类型为：阿拉伯数字 0-9、大小写字母 a-zA-z、部分特殊字符 +-_./ |
| arity | 参数长度1. 捕获到参数关键字时，之后的 arity 个字段都识别为它的值2. 参数长度为 ≥1 时，将捕捉随后的多个字段，直到遇到下一个参数关键字3. convertTo 为数组类型时 (如: string-array)：当 arity=1 时，输入的字段将按照 , 进行切割 (例: --model lr,lasso,svm 识别为 String[]{"lr", "lasso", "svm"})；arity 为 ≥1 或 2,3,... 时，传入的值直接作为数组元素，而不进行分隔 (例: --model lr lasso,svm 识别为 String[]{"lr", "lasso,svm"})4. passedIn 类型参数长度必须为 0；boolean, short, integer, long, string, float, double 类型参数长度必须为 1; <start>-<end>,<index>:<start>-<end>,k1=v1;k2=v2;...类型参数长度必须为 1；array 类型参数长度不能为 0 |
| group | 参数组文档提示：设置参数所在的参数组 |
| description | 描述文档文档提示：设置参数的描述文档 |
| format | 参数输入的参考格式文档提示：设置参数的参考输入格式 |
| hidden | 在文档中隐藏该参数被隐藏的参数可以使用，但是不会在文档中显示 |
| help | 该参数是否识别为帮助指令用户传入帮助指令时，允许输入错误的参数，并且不会对参数的规则进行检验 |
| debug | 是否为 debug 模式下可用的参数在非 debug 模式下无法使用勾选了该项的参数，该属性建议用于标记一些未完成开发或内部测试的参数 |
参数之间若存在搭配规则，建议在 Other Option 面板中进行配置。目前 commandParser 支持 5 种类型的参数规则：
| 规则 | 含义 | 表达式 ( |
|---|---|---|
| AT_MOST_ONE | command1 和 command2 至多传入一个 | |
| AT_LEAST_ONE | command1 和 command2 至少传入一个 | |
| REQUEST_ONE | command1 和 command2 需要有其中的一个 | |
| PRECONDITION | 传入了 command1 才能传入 command2 即: command1 是 command2 的前置条件 |
|
| SYMBIOSIS | command1 和 command2 同时传入或同时不传入 |
案例1 程序的输出格式可以为 --o-bgz(使用 bgzip 压缩输出的数据) 或 --o-text (纯文本输出), 两者不能同时使用
指令设计如下: 
规则设计如下:
仅当输出格式为
--o-bgz 时才能指定并行压缩的线程数 (-t) 和压缩级别 (-l)；--o-bgz 和 --o-text 必须指定其中的一个文档预览:
命令解析器有 5 项全局参数，位于 Other Option 面板下部，每一项的含义为：
- Usage: 如 “案例1” 所示，此窗口的内容对应于文档中的第一句程序用法
- offset: 跳过输入的参数个数（例如:
bgzip compress <input> -t 5 -l 5而offset=3时，将跳过 3 个参数，从-t 5 -l 5开始解析） - Global Rule: 全局规则，支持三种参数类型 （
.代表不设置规则）- AT_MOST_ONE: 所有参数至多输入 1 个
- AT_LEAST_ONE: 所有参数至少输入 1 个
- REQUEST_ONE: 需要输入 1 个参数
- Debug Mode: 解析器是否为 Debug 模式。建议开发人员在
Debug 模式下进行工具开发，对外发布时再使用非 Debug 模式的命令行文件（或 Java 脚本中使用parser.debug(boolean debug)控制模式）- 非 Debug 模式 (用户模式): 包含
debug项的参数将不可使用，并且不会在文档中显示 - Debug 模式 (开发人员模式): 包含
debug项的参数可以使用，并且会在文档中显示
- 非 Debug 模式 (用户模式): 包含
- @ Syntax: 将
@开头的符号识别为取地址符，该地址对应的文件内容作为参数进行传入
窗口左下角可以进行参数搜索，支持两种规则的查找方式：
string: 从commandName,default,convertTo,validateWith,group,description,format中查找包含 (区分大小写) 指定内容的参数项目key:value: 查找key列 （不区分大小写）值包含value的参数项目request,hidden,help,debug列的可选值为 true 或 false
搜索状态下只能修改参数的属性，而不允许新增、删除、移动参数，需要手动清空搜索框后才能恢复编辑状态。
点击 Preview 生成当前参数对应的指令文档，在 Java 脚本中使用 parser.toString() 获取文档
通常会使用 options.isPassedIn("-h") 判断是否传入了 help 指令，如果传入了，则使用 parser.toString() 打印文档，否则进行业务
点击 Parser Testing 进行指令解析测试，上半部分输入窗口可以通过拖拽文件进行输入，也可以手动输入。完成输入后点击 Parse 进行解析测试，随后下半部分窗口可以观察到哪些指令被输入，以及参数的捕获值。
点击 Save 按钮保存当前指令文件，CommandParser 中支持两种导出格式：Java 脚本文件和 Command 命令文件。
Command 命令文件的格式见 [本节](#Command 文件格式)，Java 脚本文件则是指令转为使用 Java 语言创建 Parser 的格式。两种文件的区别如下：
- Java 脚本文件无法直接拖拽进入 CommandParser 图形窗口进行编辑，但可以通过调用
MyParser.toFile(String fileName)转为 Command 命令文件，再拽拖进入 CommandParser 图形窗口进行编辑 - Command 命令文件通过拖拽进入 CommandParser 图形窗口，再选择导出为 Java 脚本文件
Java 脚本文件示例
指令设计如下:
MyParser 是一个单例，通过 `MyParser.getParser()` 获得 CommandParser 对象。
指令的解析与使用分四步进行：用户传入指令 args parser matcher
CommandParser 支持两种格式的文件导出，两种方式的区别仅在加载解析器部分，我们分别介绍两种格式文件的使用方法。
示例文件:
src/dev/fromcommandfile
Step1: 从指令文件中创建解析器
// 从外部文件中导入指令文件 (支持相对路径、绝对路径)
CommandParser parser = CommandParser.loadFromFile("./commandList.cp");
// 从内部资源导入指令文件，Test.class 请修改为调用该指令的 类名.class (当前项目路径为根目录 /，使用“相对于项目路径的绝对路径”)
CommandParser parser = CommandParser.loadFromInnerResource(Test.class, "/commandList.cp");若 Java 程序最后应该导出为 jar 包或其他封装程序使用，我们建议使用 CommandParser.loadFromInnerResource 导入指令文件。
Step2: 解析用户输入的参数
CommandMatcher options = parser.parse(args);Step3: 通过参数名获取解析结果
// 判断用户是否传入了指定的参数
boolean noqc = options.isPassedIn("--no-qc");
// 获取参数 --thread,-t 对应的值 (若用户没有传入该参数，则获得默认值)
int threadNum = (int) options.get("-t");其他常用方法：
- 获取指令文档：
parser.toString() - 获取该指令解析器中是否包含某参数：
parser.containCommandItem($commandName) - 修改为开发人员/用户模式：
parser.debug(true)或parser.debug(false) - 获取解析器的捕获情况：
options.toString() - 导出当前解析器为指令文件：
parser.toFile($fileName)
示例文件:
src/dev/fromjavascript
Step1: 获取解析器 (MyParser 是导出的 Java 文件的类名)
CommandParser parser = MyParser.getParser();Step2: 解析用户输入的参数
CommandMatcher options = parser.parse(args);
// 或直接通过 MyParser 进行访问
CommandMatcher options = MyParser.parse(args);Step3: 通过参数名获取解析结果
// 判断用户是否传入了指定的参数
boolean noqc = options.isPassedIn("--no-qc");
// 获取参数 --thread,-t 对应的值 (若用户没有传入该参数，则获得默认值)
int threadNum = (int) options.get("-t");其他常用方法：
- 获取指令文档：
parser.toString() - 获取该指令解析器中是否包含某参数：
parser.containCommandItem($commandName) - 修改为开发人员/用户模式：
parser.debug(true)或parser.debug(false) - 获取解析器的捕获情况：
options.toString() - 导出当前解析器为指令文件：
parser.toFile($fileName)或MyParser.toFile($fileName)
Step1: 在 IDEA 中点击 File > Project Structure 打开窗口
Step2: 在 Modules 中将包含参数文件的父目录设置为 Resources (也可以将文件放在 src 目录下)
Step3: 点击 Artifacts > + > JAR > From modules with dependencies...
Step4: 设置入口函数 (包含 public static void main(String[] args) 方法的类)
建议将 Output directory 修改为项目根目录，这样编译后的 jar 包就在项目根目录
Step5: 关闭 Project Structure 窗口，点击 Build > Build Artifacts > Build (或 Rebuild) 编译 jar 包
Command 文件是 CommandParser 用于储存命令信息的格式，以 cp 作为扩展名。Command 文件包含注释信息行、标题行、数据行。其中：
- 注释信息行的行首为“##”，内容是键值对的形式，通常包含 Command 文件版本信息、运行模式、程序名、指令偏移量、全局规则、指令规则等
- 标题行的行首为“#”，包含 11 个顺序固定的字段，分别为 commandName (指令名)，request (是否为必备参数)，default (默认值, 该值默认为字符串格式, 并按照 convertTo 进行格式转换), convertTo (指令值的格式, 内置 21 种常见格式，详见开发文档), validateWith (验证器, 内置 4 种常见格式), arity (参数长度), group (参数组), description (描述信息), format (指令使用格式), hidden (是否在 -h 帮助文档中隐藏该参数), help (是否捕获为帮助指令)
- 之后的数据行中每一个指令占用一行，指令的参数按照标题行顺序进行填写，使用制表符分割数据，缺失信息使用“.”占位
##commandParserV1.0
##programName=<value="bgzip <input>";description="when '-h' were passed in, would be show 'Usage: $value [options]'">
##debugMode=false
##offset=<value=1;description="skip the $value arguments before the command argument passed in">
##globalRule=<value="REQUEST_ONE";description="one of the following rules is supported: {'.','AT_MOST_ONE','AT_LEAST_ONE','REQUEST_ONE'}">
#commandName request default convertTo validateWith arity group description format hidden help debug
--help,-help,-h false . passedIn . 0 Options . . true true false
compress false . string-array . -1 Options Compression using parallel-bgzip (supported by CLM algorithm). 'compress <file>' false false false
convert false . string-array . -1 Options Convert *.gz format to *.bgz format. 'convert <file>' false false false
decompress false . string-array . -1 Options Decompression. 'decompress <file>' false false false
extract false . string-array . -1 Options Cut the bgzip file by pointer range (decompressed file). 'extract <file> -r <start>-<end>' false false false
concat false . string-array . -1 Options Concatenate multiple files. 'concat <file>,<file>,...' false false false
md5 false . string-array . -1 Options Calculate a message-digest fingerprint (checksum) for decompressed file. 'md5 <file>' false false false尽管从原理上可以直接修改 command 文件，以更改参数/文件属性，但我们建议使用 commandParser 图形界面进行（我们内置了一些检查规则，可以规避错误的格式输入）。
我们建议有高级开发需求的用户阅读开发文档（如自定义转换器、验证器，追求纯脚本开发，而不希望通过外部资源导入的方式进行）。
解析器可以使用脚本进行注册，也可以从文件中导入。
// 使用脚本创建解析器
CommandParser parser = new CommandParser("bgzip <input>");
// 从文件中导入解析器 (不建议使用该语句)
CommandParser parser = CommandParser.loadFromFile("/command/bgzip.cp");
// 从文件中导入解析器 (建议使用该语句)
CommandParser parser = CommandParser.loadFromInnerResource(BGZIPParserFromFile.class, "/command/bgzip.cp");CommandParser 包含三个注册器:
- CommandParser(String programName): 创建解析器，并设置程序名为 programName，添加参数名为
--help, -help, -h的帮助指令 - CommandParser(boolean help): 创建解析器，并设置程序名为
<main class>，根据help决定是否往解析器中添加默认的帮助指令 - CommandParser(boolean help, String programName): 创建解析器，并设置程序名为 programName。根据
help决定是否往解析器中添加默认的帮助指令
- parser.setProgramName(String programName): 设置程序名
- parser.offset(int length): 设置偏移量 (偏移量指对于用户传入的指令
args，将忽略前面的 length 个参数) - parser.registerGlobalRule(CommandRuleType ruleType): 设置全局规则。全局规则接受一个 CommandRuleType 参数 (这是一个枚举类)，支持 AT_MOST_ONE (至多包含 1 个参数)、AT_LEAST_ONE (至少包含 1 个参数)、REQUEST_ONE (恰好 1 个参数)
- parser.debug(boolean enable): 是否为 debug 模式
- parser.ustingAt(boolean enable): 是否将
@转译为取地址符 (地址对应的文件内容作为参数传入)
初始情况下解析器中不包含任何指令，通过 parser.register(String... commandNames) 进行指令注册，该指令的返回类型是 CommanItem，即以 commandNames 作为指令名的指令项目。
commandName 的格式要求: 阿拉伯数字
0-9、大小写字母a-zA-z、部分特殊字符+-_，并且该参数名不能与该解析器中已经注册的任何参数重复
// 注册参数名为 --threads, -t 的指令项目
CommandItem threadItem = parser.register("--threads", "-t");CommandItem 具有参数:
- item.convertTo(IConverter converter): 将指令的捕获值转为指定的格式
- item.validateWith(IValidator... validators): 验证该指令的捕获值，
- item.validateWith(int MIN, int MAX): 创建一个整数范围验证器，参数值必须在 [MIN, MAX] 内
- item.validateWith(double MIN, double MAX): 创建一个浮点数范围验证器，参数值必须在 [MIN, MAX] 内
- item.arity(int length): 设置参数长度，-1 表示至少 1 个参数
- item.defaultTo(Object defaultValue): 设置该指令的默认值，若未设置转换器，则自动设置为与 默认值 一致的转换器 (如: defaultTo(new String[]{}), 则转换器自动设置为 StringArrayConverter)
- item.addOptions(CommandOptions... options): 追加指令的权限参数，可选 REQUEST (必备参数)、HIDDEN (隐藏参数)、HELP (帮助参数)、DEBUG (debug 模式参数)
- item.setOptions(CommandOptions... options): 设置指令的权限参数，可选 REQUEST (必备参数)、HIDDEN (隐藏参数)、HELP (帮助参数)、DEBUG (debug 模式参数)，该方法会覆盖现有的权限参数信息
- item.setOptionGroup(String optionGroup): 设置该指令的参数组名 (默认情况下由 Parser 指令)
- item.setDescription(String description): 设置该指令的描述文档
- item.setDescription(String description, String format): 设置该指令的描述文档、格式
- item.setFormat(String format): 设置该指令的格式
每一个方法的返回值都是 CommandItem 本身，因此支持链式调用：
// 注册指令，并配置其参数
parser.register("--threads", "-t")
.defaultTo(4)
.validateWith(1, 10)
.setDescription("Set the number of threads for bgzip compression.", "'-t <int>' (" + 1 + "~" + 10 + ")");CommandParser 内置的 21 种转换器如下：
| 转换器类型 | 默认参数长度 | 输入格式示例 | 转换格式 |
|---|---|---|---|
| passedIn | 0 | (该指令无转换值，而是通过 matcher.isPassedIn 判断是否传入) | |
| boolean | 1 | true | true |
| short | 1 | 10086 | 10086 |
| integer | 1 | 20119823 | 20119823 |
| long | 1 | 20119823 | 20119823 |
| float | 1 | 1.0 | 1.0 |
| double | 1 | 1.0 | 1.0 |
| string | 1 | sysu | "sysu" |
| short-array | -1 | 1 2 3 4 5 | short[]{1, 2, 3, 4 ,5} |
| integer-array | -1 | 1 2 3 4 5 | int[]{1, 2, 3, 4 ,5} |
| long-array | -1 | 1 2 3 4 5 | long[]{1, 2, 3, 4 ,5} |
| float-array | -1 | 0.1 0.2 0.4 0.8 1.0 | float[]{0.1, 0.2, 0.4, 0.8, 1.0} |
| double-array | -1 | 0.1 0.2 0.4 0.8 1.0 | double[]{0.1, 0.2, 0.4, 0.8, 1.0} |
| string-array | -1 | sysu pku thu | String[]{"sysu", "pku", "thu"} |
| <start>-<end> (integer) | 1 | 10177-20119823 | int[]{10177, 20119823} |
| <start>-<end> (long) | 1 | 10177-20119823 | long[]{10177, 20119823} |
| <start>-<end> (double) | 1 | 0.2-0.8 | double[]{0.2, 0.8} |
| <index>:<start>-<end> (integer) | 1 | 22:290000-1000000 | int[]{22, 290000, 1000000} |
| <start>-<end> (string) | 1 | 290000-1000000 | String[]{"290000", "1000000"} |
| <index>:<start>-<end> (string) | 1 | 22:290000-1000000 | String[]{"22", "290000", "1000000"} |
| k1=v1;k2=v2;... | 1 | chrom=1;ALT=A;REF=T | HashMap{"chrom":"1", "ALT":"A", "REF":"T"} |
CommandParser 内置的 4 种验证器如下：
| 验证器 | 描述 |
|---|---|
| EnsureFileExistsValidator.INSTANCE | 确保文件存在 (不存在时报错) |
| EnsureFileIsNotDirectoryValidator.INSTANCE | 确保文件不是文件夹 (为文件夹时报错) |
| new RangeValidator(MIN, MAX) | 传入值的范围不在 [MIN, MAX] 之间时报错 (MIN, MAX 实现了 float, double, short, integer, long 类型) |
| new ElementValidator(String... keys) | 传入值的必须在指定的 keys 中。该验证器具有方法 setAllowIndex(boolean enable) 和 setIgnoreCase(boolean enable)，分别表示是否支持索引验证及无视大小写 |
多个 CommandItem 之间可以通过以下指令设置彼此间的规则：
- parser.registerRule(String item1, String item2, CommandRuleType ruleType)
- parser.registerRule(String item1, String[] items, CommandRuleType ruleType)
- parser.registerRule(String[] items1, String[] items2, CommandRuleType ruleType)
指令项目必须先进行注册，才能添加指令规则。指令规则 CommandRuleType 支持的类型 [详见此处](#4. 配置参数规则 (Other Option 面板))
// 注册指令 --no-qc 与其他质控参数的规则，含义为：指令了 --no-qc (不质控) 时，禁止用户传入其他质控参数
parser.registerRule("--no-qc", new String[]{"--gty-gq", "--gty-dp", "--seq-qual", "--seq-dp", "--seq-mq", "--seq-ac", "--seq-af", "--seq-an", "--max-allele"}, CommandRuleType.AT_MOST_ONE);创建完成的解析器可以导出 command 文件，以便于后续修改、复用：
- parser.toFile(String fileName)
创建完成的解析器使用以下方法之一
parser.parse(args)parser.parseFromString(strings)parser.parseFromFile(fileName)
解析指令，并获得 CommandMatcher 对象。CommandMatcher 对象主要包含 2 个方法：
- matcher.isPassedIn(String commandKey): 是否传入 commandKey 参数
- matcher.get(String commandKey): 获取 commandKey 对应的参数值，未传入时将获得参数的 defaultValue (默认为 null)
此外，使用 matcher.toString() 可以获得输入参数的格式化文本。
有时候一个指令往往需要对应多种用法，此时默认的 21 种参数转换器便不再适用。commandParser 可以通过自定义转换器与验证器，实现复杂的参数转换与验证。
实现该功能需要指定的方法实现相应的接口 (IConverter 与 IValidator)。对于自定义的转换器，在图形界面和指令文件中都将以 built-in 形式存在，导入到 java 中时将创建 AbstractConvertor 和 AbstractValidator 占位，用户需要使用：
parser.getCommandItem("$commandName").convertTo($convertor)
parser.getCommandItem("$commandName").validateWith($convertor)
重新链接自定义的方法。
例如：实现一个名为 --model 的指令，它的转换格式为 ILDModel 类型。输入的 geno, --geno, --geno-ld, --geno-r2 将被识别为 ILDModel.GENOTYPE_LD，而输入的 hap, --hap, --hap-ld, --hap-r2 将被识别为 ILDModel.HAPLOTYPE_LD。
parser.register("--model", "-m")
.arity(1)
.convertTo((IConverter<ILDModel>) params -> {
Assert.that(params.length == 1);
ElementValidator validator = new ElementValidator("geno", "--geno", "--geno-ld", "--geno-r2", "hap", "--hap", "--hap-ld", "--hap-r2");
validator.validate("--model", params);
String param = params[0].toUpperCase();
if (param.equals("GENO") || param.equals("--GENO") || param.equals("--GENO-LD") || param.equals("--GENO-R2")) {
return ILDModel.GENOTYPE_LD;
} else if (param.equals("HAP") || param.equals("--HAP") || param.equals("--HAP-LD") || param.equals("--HAP-R2")) {
return ILDModel.HAPLOTYPE_LD;
} else {
throw new ParameterException("unable convert " + Arrays.toString(params) + " to " + ILDModel.class);
}
})
.setOptionGroup("LD Calculation Options")
.setDescription("Calculate pairwise the linkage disequilibrium (hap, --hap, --hap-ld, --hap-r2) or genotypic correlation (geno, --geno, --geno-ld, --geno-r2)")
.setFormat("'-m <string>'");- GBC-1.1
- 本示例程序中的 bgzip-tools
- BGZIP 是生物信息学领域常用的工具，压缩原理如图：
- 使用
java -jar ./commandParser-1.0.jar bgzip使用该工具
- BGZIP 是生物信息学领域常用的工具，压缩原理如图：
