GTBMerger

java.lang.Object
- edu.sysu.pmglab.easytools.Parallelizable
- - edu.sysu.pmglab.gbc.toolkit.GTBMerger

```
public class GTBMerger
extends edu.sysu.pmglab.easytools.Parallelizable
```
GTB 基因型文件合并器, 第一个文件作为主文件 (major or left), 第二个文件作为次文件 (minor or right)
由于多文件合并涉及到复杂的等位基因类型判断及内存控制, 此处仅用于合并两个 GTB 文件. 对于多个文件的合并, 建议使用最小堆优化合并顺序.
请注意, 对于非基因数据的合并, 建议使用 Annotator 方法当位点的 REF 不是标准 REF 时, GTBMerger 将放弃此位点的合并
默认情况下所有的非坐标、非基因型字段都会被丢弃

嵌套类概要

嵌套类
限定符和类型类和说明

static class GTBMerger.MergeOperator
处理不同文件位点的方式

嵌套类
限定符和类型	类和说明
`static class`	`GTBMerger.MergeOperator` 处理不同文件位点的方式

字段概要
- 从类继承的字段 edu.sysu.pmglab.easytools.Parallelizable
  AVAILABLE_PROCESSORS, INIT_THREADS

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`GTBMerger`	`addField(java.util.Map<java.lang.String,edu.sysu.pmglab.ccf.FieldType> fields)` 添加字段或更改字段值类型
`GTBMerger`	`addField(java.lang.String fieldName, edu.sysu.pmglab.ccf.FieldType fieldType)` 添加字段或更改字段值类型
`GTBMerger`	`addMeta(edu.sysu.pmglab.container.ByteCode key, edu.sysu.pmglab.container.ByteCode value)` 写入元信息
`GTBMerger`	`addMeta(edu.sysu.pmglab.ccf.CCFMeta meta)` 写入元信息
`GTBMerger`	`addMeta(java.lang.String key, java.lang.String value)` 写入元信息
`GTBMerger`	`addValueConverter(java.util.function.BiConsumer<edu.sysu.pmglab.container.Entry<Variant,Variant>,Variant> valueConverter)` 添加值转换器转换器的第一个参数为坐标和等位基因匹配成功的一组位点 (分别为第一个文件的位点和第二个文件的位点), 第二个参数为合并后的位点
`GTBMerger`	`clearMeta()` 清除所有的元信息
`GTBMerger`	`dropDuplicationMeta()` 去除重复的元信息
`GTBManager`	`getMajorManager()` 获取主管理器
`GTBManager`	`getMinorManager()` 获取次管理器
`edu.sysu.pmglab.container.File`	`getOutputFile()` 获取输出文件对象
`GTBMerger`	`loadGenotype(boolean loadGenotype)` 设置是否加载基因型数据
`static GTBMerger`	`of(java.lang.Object majorManager, java.lang.Object minorManager)` 构造器方法
`GTBMerger`	`setFormat(GTBFormat format)` 设置 GTB 文件格式
`GTBMerger`	`setMergeOperator(GTBMerger.MergeOperator mergeOperator)` 设置处理不同文件位点的方式
`GTBMerger`	`setOutputFile(java.io.File outputFile)` 设置输出文件
`GTBMerger`	`setThreads(int threads)`
`GTBManager`	`submit()` 提交合并任务合并时按照染色体进行, 以避免调整坐标
`java.lang.String`	`toString()`

从类继承的方法 edu.sysu.pmglab.easytools.Parallelizable
addThreads, getThreads, reduceThreads, verify

从类继承的方法 java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- 方法详细资料
  - of
```
public static GTBMerger of(java.lang.Object majorManager,
                           java.lang.Object minorManager)
                    throws java.io.IOException
```
    构造器方法
    
    参数:
    
    majorManager - 主管理器
    
    minorManager - 次管理器
    
    返回:
    
    GTB 文件合并器
    
    抛出:
    
    java.io.IOException - IO 异常
  - setOutputFile
```
public GTBMerger setOutputFile(java.io.File outputFile)
```
    设置输出文件
    
    参数:
    
    outputFile - 输出文件
    
    返回:
    
    本类
  - getOutputFile
```
public edu.sysu.pmglab.container.File getOutputFile()
```
    获取输出文件对象
    
    返回:
    
    输出文件
  - getMajorManager
```
public GTBManager getMajorManager()
```
    获取主管理器
    
    返回:
    
    主管理器
  - getMinorManager
```
public GTBManager getMinorManager()
```
    获取次管理器
    
    返回:
    
    次管理器
  - setThreads
```
public GTBMerger setThreads(int threads)
```
    覆盖:
    
    setThreads 在类中 edu.sysu.pmglab.easytools.Parallelizable
  - setMergeOperator
```
public GTBMerger setMergeOperator(GTBMerger.MergeOperator mergeOperator)
```
    设置处理不同文件位点的方式
    
    参数:
    
    mergeOperator - 坐标类型
    
    返回:
    
    本类
  - setFormat
```
public GTBMerger setFormat(GTBFormat format)
```
    设置 GTB 文件格式
    
    参数:
    
    format - GTB 文件格式
    
    返回:
    
    本类
  - addMeta
```
public GTBMerger addMeta(java.lang.String key,
                         java.lang.String value)
```
    写入元信息
    
    参数:
    
    key - 元信息键
    
    value - 元信息值
    
    返回:
    
    本类
  - addMeta
```
public GTBMerger addMeta(edu.sysu.pmglab.container.ByteCode key,
                         edu.sysu.pmglab.container.ByteCode value)
```
    写入元信息
    
    参数:
    
    key - 元信息键
    
    value - 元信息值
    
    返回:
    
    本类
  - addMeta
```
public GTBMerger addMeta(edu.sysu.pmglab.ccf.CCFMeta meta)
```
    写入元信息
    
    参数:
    
    meta - 元信息对象
    
    返回:
    
    本类
  - clearMeta
```
public GTBMerger clearMeta()
```
    清除所有的元信息
    
    返回:
    
    本类
  - dropDuplicationMeta
```
public GTBMerger dropDuplicationMeta()
```
    去除重复的元信息
    
    返回:
    
    本类
  - addField
```
public GTBMerger addField(java.lang.String fieldName,
                          edu.sysu.pmglab.ccf.FieldType fieldType)
```
    添加字段或更改字段值类型
    
    参数:
    
    fieldName - 字段名
    
    fieldType - 字段类型
    
    返回:
    
    本类
  - addField
```
public GTBMerger addField(java.util.Map<java.lang.String,edu.sysu.pmglab.ccf.FieldType> fields)
```
    添加字段或更改字段值类型
    
    参数:
    
    fields - 字段名及其类型
    
    返回:
    
    本类
  - addValueConverter
```
public GTBMerger addValueConverter(java.util.function.BiConsumer<edu.sysu.pmglab.container.Entry<Variant,Variant>,Variant> valueConverter)
```
    添加值转换器
    转换器的第一个参数为坐标和等位基因匹配成功的一组位点 (分别为第一个文件的位点和第二个文件的位点), 第二个参数为合并后的位点
    
    参数:
    
    valueConverter - 值转换器
    
    返回:
    
    本类
  - loadGenotype
```
public GTBMerger loadGenotype(boolean loadGenotype)
```
    设置是否加载基因型数据
    
    参数:
    
    loadGenotype - 加载基因型数据
    
    返回:
    
    本类
  - submit
```
public GTBManager submit()
                  throws java.io.IOException
```
    提交合并任务合并时按照染色体进行, 以避免调整坐标
    
    返回:
    
    合并后的 GTB 文件
    
    抛出:
    
    java.io.IOException - IO 异常
  - toString
```
public java.lang.String toString()
```
    覆盖:
    
    toString 在类中 java.lang.Object

类 GTBMerger

嵌套类概要

字段概要

从类继承的字段 edu.sysu.pmglab.easytools.Parallelizable

方法概要

从类继承的方法 edu.sysu.pmglab.easytools.Parallelizable

从类继承的方法 java.lang.Object

方法详细资料

of

setOutputFile

getOutputFile

getMajorManager

getMinorManager

setThreads

setMergeOperator

setFormat

addMeta

addMeta

addMeta

clearMeta

dropDuplicationMeta

addField

addField

addValueConverter

loadGenotype

submit

toString