CCFReader

java.lang.Object
- edu.sysu.pmglab.ccf.CCFReader

所有已实现的接口:

java.io.Closeable, java.lang.AutoCloseable, java.lang.Iterable<IRecord>
```
public class CCFReader
extends java.lang.Object
implements java.lang.Iterable<IRecord>, java.lang.AutoCloseable, java.io.Closeable
```
CCF 文件读取器

另请参阅:

数据需要先写入 Record 中, 再传入 CCFReader

构造器概要

构造器
构造器和说明
`CCFReader(CCFTable table)` 构造器方法
`CCFReader(CCFTable table, java.lang.Iterable<java.lang.String> fieldNames)` 构造器方法
`CCFReader(CCFTable table, java.lang.String... fieldNames)` 构造器方法

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`void`	`close()` 关闭当前文件读取器
`boolean`	`containField(java.lang.String fieldName)` 查看当前数据表是否包含指定列名的数据
`boolean`	`endOfFile()` 是否到达文件尾部
`int`	`getFieldIndex(java.lang.String fieldName)` 获取指定列名的索引
`java.lang.String`	`getFieldName(int fieldIndex)` 获取指定列索引的列名
`java.lang.String[]`	`getFieldNames()` 获取当前数据表包含的列的列名
`int`	`getFieldNum()` 获取当前数据表包含的列数
`FieldType`	`getFieldType(java.lang.String fieldName)` 获取指定列名的数据类型
`java.util.Map<java.lang.String,FieldType>`	`getFieldTypes()` 获取所有列名及其数据类型
`edu.sysu.pmglab.unifyIO.Path`	`getFilePath()` 获取当前数据表读取器绑定的数据表文件对象
`edu.sysu.pmglab.container.Interval<java.lang.Long>`	`getRangeOfRecordIndex()` 获取可读的索引范围, 左闭右开通常情况下它的值为 [0, 总记录数)
`IRecord`	`getRecord()` 获取当前读取器绑定的记录类型
`long`	`getRecordNum()` 获取当前数据表包含的记录条目数
`CCFTable`	`getTable()` 获取当前数据表读取器绑定的数据表对象
`boolean`	`isClosed()` 文件是否已关闭
`java.util.Iterator<IRecord>`	`iterator()`
`java.lang.Iterable<IRecord>`	`iterator(CCFFilter filters)` 指定过滤器下的记录迭代器
`boolean`	`limit(edu.sysu.pmglab.container.Interval<java.lang.Long> ranges)` 设置全局的读取范围
`CCFReader`	`newInstance()` 创建新读取器
`edu.sysu.pmglab.container.array.BaseArray<CCFReader>`	`part(int nParts)` 将 CCF 读取器分块
`IRecord`	`read()` 读一条记录
`IRecord`	`read(CCFFilter filter)` 读一条满足条件要求的记录该方法速度极快
`IRecord[]`	`read(int nums)` 读多条记录
`boolean`	`read(IRecord record)` 读一条记录, 并写入到已有的记录对象中
`boolean`	`read(IRecord record, CCFFilter filters)` 读一条满足条件要求的记录, 并写入到已有的记录对象中该方法速度极快
`IRecord[]`	`reads(CCFFilter filters)` 读所有满足条件要求的记录
`long`	`remaining()` 获取当前数据表读取器可读的记录条目数
`boolean`	`seek(CCFFilter filters)` 将指针跳转到指定的记录行, 并约束相应的值条件.
`boolean`	`seek(long recordIndex)` 将指针跳转到指定的记录行.
`long`	`tell()` 获取当前的文件指针 (当前指向的记录行索引)
`java.lang.String`	`toString()`

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

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

- 构造器详细资料
  - CCFReader
```
public CCFReader(CCFTable table)
          throws java.io.IOException
```
    构造器方法
    
    参数:
    
    table - 数据表对象
    
    抛出:
    
    java.io.IOException - 文件读取过程中产生的 IO 异常 (包括占用、指针异常、不存在等)
  - CCFReader
```
public CCFReader(CCFTable table,
                 java.lang.String... fieldNames)
          throws java.io.IOException
```
    构造器方法
    
    参数:
    
    table - 数据表对象
    
    fieldNames - 筛选的列字段
    
    抛出:
    
    java.io.IOException - 文件读取过程中产生的 IO 异常 (包括占用、指针异常、不存在等)
  - CCFReader
```
public CCFReader(CCFTable table,
                 java.lang.Iterable<java.lang.String> fieldNames)
          throws java.io.IOException
```
    构造器方法
    
    参数:
    
    table - 数据表对象
    
    fieldNames - 加载的字段信息
    
    抛出:
    
    java.io.IOException - 文件读取过程中产生的 IO 异常 (包括占用、指针异常、不存在等)
- 方法详细资料
  - newInstance
```
public CCFReader newInstance()
                      throws java.io.IOException
```
    创建新读取器
    
    返回:
    
    新的独立的读取器
    
    抛出:
    
    java.io.IOException - IO 异常
  - getRecord
```
public IRecord getRecord()
```
    获取当前读取器绑定的记录类型
    
    返回:
    
    当前读取器绑定的记录类型
  - getFieldNum
```
public int getFieldNum()
```
    获取当前数据表包含的列数
    
    返回:
    
    当前数据表包含的列数
  - getRecordNum
```
public long getRecordNum()
```
    获取当前数据表包含的记录条目数
    
    返回:
    
    当前数据表包含的记录条目数
  - containField
```
public boolean containField(java.lang.String fieldName)
```
    查看当前数据表是否包含指定列名的数据
    
    参数:
    
    fieldName - 列名
    
    返回:
    
    true: 包含, false: 不包含
  - getFieldNames
```
public java.lang.String[] getFieldNames()
```
    获取当前数据表包含的列的列名
    
    返回:
    
    当前数据表包含的列的列名
  - getFieldTypes
```
public java.util.Map<java.lang.String,FieldType> getFieldTypes()
```
    获取所有列名及其数据类型
    
    返回:
    
    当前数据表包含的列名及其数据类型
  - getFieldType
```
public FieldType getFieldType(java.lang.String fieldName)
```
    获取指定列名的数据类型
    
    参数:
    
    fieldName - 指定列名
    
    返回:
    
    指定列名的数据类型, null 代表不存在该列
  - getFieldIndex
```
public int getFieldIndex(java.lang.String fieldName)
```
    获取指定列名的索引
    
    参数:
    
    fieldName - 指定列名
    
    返回:
    
    指定列名的索引, -1 表示不存在
  - getFieldName
```
public java.lang.String getFieldName(int fieldIndex)
```
    获取指定列索引的列名
    
    参数:
    
    fieldIndex - 指定列索引
    
    返回:
    
    指定列索引的列名, null 表示不存在
  - getTable
```
public CCFTable getTable()
```
    获取当前数据表读取器绑定的数据表对象
    
    返回:
    
    当前数据表读取器绑定的数据表对象
  - getFilePath
```
public edu.sysu.pmglab.unifyIO.Path getFilePath()
```
    获取当前数据表读取器绑定的数据表文件对象
    
    返回:
    
    当前数据表读取器绑定的数据表文件对象
  - getRangeOfRecordIndex
```
public edu.sysu.pmglab.container.Interval<java.lang.Long> getRangeOfRecordIndex()
```
    获取可读的索引范围, 左闭右开通常情况下它的值为 [0, 总记录数)
    
    返回:
    
    可读的索引范围, 左闭右开
  - endOfFile
```
public boolean endOfFile()
```
    是否到达文件尾部
    
    返回:
    
    true: 到达文件尾部, 此时调用 read() 返回 null
  - read
```
public IRecord read()
```
    读一条记录
    
    返回:
    
    数据表记录, Record 数据类型, null 表示文件已经到达尾部, 无法读取任何记录
  - read
```
public IRecord read(CCFFilter filter)
```
    读一条满足条件要求的记录该方法速度极快
    
    参数:
    
    filter - 记录过滤器
    
    返回:
    
    数据表记录, Record 数据类型, null 表示文件已经到达尾部, 且没有找到符合条件的记录
  - read
```
public IRecord[] read(int nums)
```
    读多条记录
    
    参数:
    
    nums - 读取的条目数
    
    返回:
    
    数据表记录, Record 数据类型. 长度取决于可读记录的数量
  - read
```
public boolean read(IRecord record)
```
    读一条记录, 并写入到已有的记录对象中
    
    参数:
    
    record - 传入记录对象, 当记录对象是通过 CCFReader.getRecord 产生时, 写入速度会加快
    
    返回:
    
    true: 写入成功, false: 写入失败 (文件已经到达尾部, 无法读取任何记录)
  - read
```
public boolean read(IRecord record,
                    CCFFilter filters)
```
    读一条满足条件要求的记录, 并写入到已有的记录对象中该方法速度极快
    
    参数:
    
    record - 写入记录
    
    filters - 记录过滤器
    
    返回:
    
    数据表记录, Record 数据类型, true: 写入成功, false: 写入失败 (文件已经到达尾部, 无法读取任何记录)
  - reads
```
public IRecord[] reads(CCFFilter filters)
```
    读所有满足条件要求的记录
    
    参数:
    
    filters - 记录过滤器
    
    返回:
    
    数据表记录, Record 数据类型
  - seek
```
public boolean seek(long recordIndex)
```
    将指针跳转到指定的记录行. 只有找到了相应的记录才会发生指针改变.
    
    参数:
    
    recordIndex - 指定的记录行数
    
    返回:
    
    true, 跳转成功
  - seek
```
public boolean seek(CCFFilter filters)
```
    将指针跳转到指定的记录行, 并约束相应的值条件. 只有找到了相应的记录才会发生指针改变.
    
    参数:
    
    filters - 记录过滤器
    
    返回:
    
    是否找到了相应的记录
    
    另请参阅:
    
    过滤器被提取成多个列过滤器进行处理
  - remaining
```
public long remaining()
```
    获取当前数据表读取器可读的记录条目数
    
    返回:
    
    剩余可读数据长度
  - tell
```
public long tell()
```
    获取当前的文件指针 (当前指向的记录行索引)
    
    返回:
    
    当前的文件指针
  - limit
```
public boolean limit(edu.sysu.pmglab.container.Interval<java.lang.Long> ranges)
```
    设置全局的读取范围
    
    参数:
    
    ranges - 记录索引范围 (左闭右开)
    
    返回:
    
    是否约束成功
  - iterator
```
public java.util.Iterator<IRecord> iterator()
```
    指定者:
    
    iterator 在接口中 java.lang.Iterable<IRecord>
  - iterator
```
public java.lang.Iterable<IRecord> iterator(CCFFilter filters)
```
    指定过滤器下的记录迭代器
    
    参数:
    
    filters - 记录过滤器
    
    返回:
    
    迭代器
  - close
```
public void close()
           throws java.io.IOException
```
    关闭当前文件读取器
    
    指定者:
    
    close 在接口中 java.io.Closeable
    
    指定者:
    
    close 在接口中 java.lang.AutoCloseable
    
    抛出:
    
    java.io.IOException
  - isClosed
```
public boolean isClosed()
```
    文件是否已关闭
    
    返回:
    
    文件是否已关闭
  - toString
```
public java.lang.String toString()
```
    覆盖:
    
    toString 在类中 java.lang.Object
  - part
```
public edu.sysu.pmglab.container.array.BaseArray<CCFReader> part(int nParts)
                                                          throws java.io.IOException
```
    将 CCF 读取器分块
    
    参数:
    
    nParts - 分块数
    
    返回:
    
    分类读取器
    
    抛出:
    
    java.io.IOException - IO 异常

类 CCFReader

构造器概要

方法概要

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

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

构造器详细资料

CCFReader

CCFReader

CCFReader

方法详细资料

newInstance

getRecord

getFieldNum

getRecordNum

containField

getFieldNames

getFieldTypes

getFieldType

getFieldIndex

getFieldName

getTable

getFilePath

getRangeOfRecordIndex

endOfFile

read

read

read

read

read

reads

seek

seek

remaining

tell

limit

iterator

iterator

close

isClosed

toString

part