GTBReader

java.lang.Object
- edu.sysu.pmglab.gbc.GTBReader

所有已实现的接口:: java.lang.AutoCloseable, java.lang.Iterable<Variant>

public class GTBReader
extends java.lang.Object
implements java.lang.Iterable<Variant>, java.lang.AutoCloseable

GTB 文件读取器

构造器概要

构造器
构造器和说明
`GTBReader(java.lang.Object manager)` 构造器方法
`GTBReader(java.lang.Object manager, boolean loadGenotype)` 构造器方法
`GTBReader(java.lang.Object manager, boolean loadGenotype, boolean loadField)` 构造器方法
`GTBReader(java.lang.Object manager, boolean loadGenotype, java.lang.Iterable<java.lang.String> fields)` 构造器方法

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`void`	`close()` 关闭文件流
`boolean`	`containField(java.lang.String fieldName)` 是否包含指定的字段对象
`boolean`	`containSubject(java.lang.String subject)`
`boolean`	`endOfFile()` 是否到达文件结尾
`java.util.Map<java.lang.String,edu.sysu.pmglab.ccf.FieldType>`	`getFields()` 获取筛选的其他字段
`edu.sysu.pmglab.ccf.FieldType`	`getFieldType(java.lang.String fieldName)` 获取指定字段的类型
`GTBFormat`	`getGtbFormat()` 获取 GTB 文件的格式器
`GTBManager`	`getManager()` 获取 GTB 文件管理器
`edu.sysu.pmglab.container.Interval<java.lang.Long>`	`getRangeOfVariantIndex()` 获取位点索引范围
`int`	`getSubjectNum()` 获取样本个数
`java.util.Set<java.lang.String>`	`getSubjects()` 获得样本信息
`long`	`getVariantNum()` 获取位点个数
`int`	`indexOfSubject(java.lang.String subject)` 获取指定样本的索引
`boolean`	`isClosed()` 文件流是否被关闭
`java.util.Iterator<Variant>`	`iterator()`
`GTBReader`	`limit(edu.sysu.pmglab.container.Interval<java.lang.Long> ranges)` 设置全局的读取范围
`GTBReader`	`newInstance()` 克隆读取器
`edu.sysu.pmglab.container.array.BaseArray<GTBReader>`	`part(int nParts)` 将 CCF 读取器分块
`Variant`	`read()` 读取一个位点
`Variant`	`read(GTBFilter filter)` 读取一个满足过滤条件的位点
`java.util.Map.Entry<Chromosome,java.lang.Integer>`	`readCoordinate()` 读取一个坐标
`java.util.Map.Entry<Chromosome,java.lang.Integer>`	`readCoordinate(GTBFilter filter)` 读取一个满足过滤条件的位点
`Variants`	`reads()` 读取接下来所有坐标相同的位点, 用于扫描连续的相同坐标位点当 GTB 文件为无序时, 此方法无法正确返回结果
`long`	`remaining()` 获取当前数据表读取器可读的记录条目数
`boolean`	`seek(GTBFilter filter)` 定位位点指针
`boolean`	`seek(long variantIndex)` 定位位点指针
`java.lang.String`	`subjectOfIndex(int index)` 获取指定索引对应的样本
`long`	`tell()` 获取文件的位点指针
`java.lang.String`	`toString()`

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

从接口继承的方法 java.lang.Iterable
forEach, spliterator

- 构造器详细资料
  - GTBReader
```
public GTBReader(java.lang.Object manager)
          throws java.io.IOException
```
    构造器方法
    
    参数:
    
    manager - 管理器对象
    
    抛出:
    
    GTBComponentException - GTB 结构异常
    
    java.io.IOException - IO 异常
  - GTBReader
```
public GTBReader(java.lang.Object manager,
                 boolean loadGenotype)
          throws java.io.IOException
```
    构造器方法
    
    参数:
    
    manager - 管理器对象
    
    loadGenotype - 是否加载基因型
    
    抛出:
    
    GTBComponentException - GTB 结构异常
    
    java.io.IOException - IO 异常
  - GTBReader
```
public GTBReader(java.lang.Object manager,
                 boolean loadGenotype,
                 boolean loadField)
          throws java.io.IOException
```
    构造器方法
    
    参数:
    
    manager - 管理器对象
    
    loadGenotype - 是否加载基因型
    
    loadField - 是否加载其他字段
    
    抛出:
    
    GTBComponentException - GTB 结构异常
    
    java.io.IOException - IO 异常
  - GTBReader
```
public GTBReader(java.lang.Object manager,
                 boolean loadGenotype,
                 java.lang.Iterable<java.lang.String> fields)
```
    构造器方法
    
    参数:
    
    manager - 管理器对象
    
    loadGenotype - 是否加载基因型
    
    fields - 筛选的其他字段
    
    抛出:
    
    GTBComponentException - GTB 结构异常
- 方法详细资料
  - newInstance
```
public GTBReader newInstance()
                      throws java.io.IOException
```
    克隆读取器
    
    返回:
    
    本类
    
    抛出:
    
    GTBComponentException - GTB 结构异常
    
    java.io.IOException - IO 异常
  - read
```
public Variant read()
```
    读取一个位点
    
    返回:
    
    是否读取成功
  - readCoordinate
```
public java.util.Map.Entry<Chromosome,java.lang.Integer> readCoordinate()
```
    读取一个坐标
    
    返回:
    
    是否读取成功
  - read
```
public Variant read(GTBFilter filter)
```
    读取一个满足过滤条件的位点
    
    参数:
    
    filter - 过滤条件
    
    返回:
    
    null 时读取失败, 文件指针达到文件末尾
  - readCoordinate
```
public java.util.Map.Entry<Chromosome,java.lang.Integer> readCoordinate(GTBFilter filter)
```
    读取一个满足过滤条件的位点
    
    参数:
    
    filter - 过滤条件
    
    返回:
    
    是否读取成功
  - reads
```
public Variants reads()
```
    读取接下来所有坐标相同的位点, 用于扫描连续的相同坐标位点当 GTB 文件为无序时, 此方法无法正确返回结果
    
    返回:
    
    顺序读取的位点对象
  - seek
```
public boolean seek(GTBFilter filter)
```
    定位位点指针
    
    参数:
    
    filter - 过滤器
    
    返回:
    
    顺序读取的位点对象
  - seek
```
public boolean seek(long variantIndex)
```
    定位位点指针
    
    参数:
    
    variantIndex - 位点索引
    
    返回:
    
    是否定位成功
  - tell
```
public long tell()
```
    获取文件的位点指针
    
    返回:
    
    文件指针
  - limit
```
public GTBReader limit(edu.sysu.pmglab.container.Interval<java.lang.Long> ranges)
```
    设置全局的读取范围
    
    参数:
    
    ranges - 记录索引范围
    
    返回:
    
    是否约束成功
  - remaining
```
public long remaining()
```
    获取当前数据表读取器可读的记录条目数
    
    返回:
    
    剩余可读数据长度
  - endOfFile
```
public boolean endOfFile()
```
    是否到达文件结尾
    
    返回:
    
    是否到达文件结尾
  - containField
```
public boolean containField(java.lang.String fieldName)
```
    是否包含指定的字段对象
    
    参数:
    
    fieldName - 字段对象
    
    返回:
    
    是否包含指定的字段对象
  - getFields
```
public java.util.Map<java.lang.String,edu.sysu.pmglab.ccf.FieldType> getFields()
```
    获取筛选的其他字段
    
    返回:
    
    获取筛选的其他字段
  - getFieldType
```
public edu.sysu.pmglab.ccf.FieldType getFieldType(java.lang.String fieldName)
```
    获取指定字段的类型
    
    参数:
    
    fieldName - 指定的字段名
    
    返回:
    
    指定字段的类型
  - containSubject
```
public boolean containSubject(java.lang.String subject)
```
    参数:
    
    subject - 样本名
    
    返回:
    
    是否包含指定的样本名
  - subjectOfIndex
```
public java.lang.String subjectOfIndex(int index)
```
    获取指定索引对应的样本
    
    参数:
    
    index - 样本索引
    
    返回:
    
    样本名
  - indexOfSubject
```
public int indexOfSubject(java.lang.String subject)
```
    获取指定样本的索引
    
    参数:
    
    subject - 样本名
    
    返回:
    
    索引
  - getSubjects
```
public java.util.Set<java.lang.String> getSubjects()
```
    获得样本信息
    
    返回:
    
    样本索引对应的索引名
  - getGtbFormat
```
public GTBFormat getGtbFormat()
```
    获取 GTB 文件的格式器
    
    返回:
    
    GTB 文件格式
  - getVariantNum
```
public long getVariantNum()
```
    获取位点个数
    
    返回:
    
    位点个数
  - getSubjectNum
```
public int getSubjectNum()
```
    获取样本个数
    
    返回:
    
    样本个数
  - getManager
```
public GTBManager getManager()
```
    获取 GTB 文件管理器
    
    返回:
    
    GTB 文件管理器
  - close
```
public void close()
           throws java.io.IOException
```
    关闭文件流
    
    指定者:
    
    close 在接口中 java.lang.AutoCloseable
    
    抛出:
    
    java.io.IOException - 来自 CCF 的 IO 异常
  - isClosed
```
public boolean isClosed()
```
    文件流是否被关闭
    
    返回:
    
    文件流是否被关闭
  - iterator
```
public java.util.Iterator<Variant> iterator()
```
    指定者:
    
    iterator 在接口中 java.lang.Iterable<Variant>
  - toString
```
public java.lang.String toString()
```
    覆盖:
    
    toString 在类中 java.lang.Object
  - getRangeOfVariantIndex
```
public edu.sysu.pmglab.container.Interval<java.lang.Long> getRangeOfVariantIndex()
```
    获取位点索引范围
    
    返回:
    
    位点索引范围
  - part
```
public edu.sysu.pmglab.container.array.BaseArray<GTBReader> part(int nParts)
                                                          throws java.io.IOException
```
    将 CCF 读取器分块
    
    参数:
    
    nParts - 分块数
    
    返回:
    
    分类读取器
    
    抛出:
    
    java.io.IOException - IO 异常

类 GTBReader

构造器概要

方法概要

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

从接口继承的方法 java.lang.Iterable

构造器详细资料

GTBReader

GTBReader

GTBReader

GTBReader

方法详细资料

newInstance

read

readCoordinate

read

readCoordinate

reads

seek

seek

tell

limit

remaining

endOfFile

containField

getFields

getFieldType

containSubject

subjectOfIndex

indexOfSubject

getSubjects

getGtbFormat

getVariantNum

getSubjectNum

getManager

close

isClosed

iterator

toString

getRangeOfVariantIndex

part