Chromosome

java.lang.Object
- edu.sysu.pmglab.gbc.variant.Chromosome

所有已实现的接口:: java.lang.Comparable<Chromosome>

public class Chromosome
extends java.lang.Object
implements java.lang.Comparable<Chromosome>

构造器概要

构造器
构造器和说明

Chromosome(java.lang.String simpleName, java.lang.String fullName, java.lang.String... otherNames)
构造器方法

构造器
构造器和说明
`Chromosome(java.lang.String simpleName, java.lang.String fullName, java.lang.String... otherNames)` 构造器方法

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`static Chromosome`	`addChromosome(Chromosome chromosome)` 添加染色体数据
`static int`	`chromosomeSorter(Chromosome chromosome1, Chromosome chromosome2)` 染色体排序器
`static void`	`clear()` 清除加载的染色体数据
`int`	`compareTo(Chromosome o)`
`static edu.sysu.pmglab.ccf.CCFTable`	`convertTSV2CCF(edu.sysu.pmglab.container.File inputFile, edu.sysu.pmglab.container.File outputFile)` 将 tsv 文件转为 ccf 文件, 文件中的额外字段被转换为 bytecode 对象
`boolean`	`equals(java.lang.Object o)`
`static Chromosome`	`get(edu.sysu.pmglab.container.ByteCode chromosome)` 获取染色体
`static Chromosome`	`get(int index)` 获取染色体
`static Chromosome`	`get(java.lang.String chromosome)` 获取染色体
`edu.sysu.pmglab.container.array.BaseArray<java.lang.String>`	`getAlternativeNames()` 获得其他的替代名列表
`int`	`getChromosomeIndex()`
`java.lang.String`	`getFullName()`
`java.lang.Object`	`getProperty(java.lang.String key)` 获取染色体的指定属性值
`java.lang.String`	`getSimpleName()`
`int`	`hashCode()`
`static java.util.Set<Chromosome>`	`identifiableList()`
`static void`	`init()` 初始化染色体信息 (恢复为人类基因组)
`static edu.sysu.pmglab.container.IndexableSet<Chromosome>`	`iterator()`
`static void`	`loadFromCCF(java.lang.Object inputFile)` 从 ccf 文件中加载染色体信息
`static void`	`save(edu.sysu.pmglab.container.File outputFile)` 保存为 CCF 格式
`Chromosome`	`setProperty(java.lang.String key, java.lang.Object value)` 设置染色体属性值
`java.lang.String`	`toString()`

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

- 构造器详细资料
  - Chromosome
```
public Chromosome(java.lang.String simpleName,
                  java.lang.String fullName,
                  java.lang.String... otherNames)
```
    构造器方法
    
    参数:
    
    simpleName - 精简染色体名
    
    fullName - 完整染色体名
    
    otherNames - 其他链接到同一染色体对象的识别名
- 方法详细资料
  - get
```
public static Chromosome get(int index)
```
    获取染色体
    
    参数:
    
    index - 染色体索引
    
    返回:
    
    染色体对象
  - get
```
public static Chromosome get(java.lang.String chromosome)
```
    获取染色体
    
    参数:
    
    chromosome - 染色体名
    
    返回:
    
    染色体对象
  - get
```
public static Chromosome get(edu.sysu.pmglab.container.ByteCode chromosome)
```
    获取染色体
    
    参数:
    
    chromosome - 染色体名
    
    返回:
    
    染色体对象
  - setProperty
```
public Chromosome setProperty(java.lang.String key,
                              java.lang.Object value)
```
    设置染色体属性值
    
    参数:
    
    key - 属性键
    
    value - 属性值
    
    返回:
    
    本类
  - getProperty
```
public java.lang.Object getProperty(java.lang.String key)
```
    获取染色体的指定属性值
    
    参数:
    
    key - 属性键
    
    返回:
    
    属性值
  - clear
```
public static void clear()
```
    清除加载的染色体数据
  - save
```
public static void save(edu.sysu.pmglab.container.File outputFile)
                 throws java.io.IOException
```
    保存为 CCF 格式
    
    参数:
    
    outputFile - 输出文件对象
    
    抛出:
    
    java.io.IOException - IO 异常
  - convertTSV2CCF
```
public static edu.sysu.pmglab.ccf.CCFTable convertTSV2CCF(edu.sysu.pmglab.container.File inputFile,
                                                          edu.sysu.pmglab.container.File outputFile)
                                                   throws java.io.IOException
```
    将 tsv 文件转为 ccf 文件, 文件中的额外字段被转换为 bytecode 对象
    
    参数:
    
    inputFile - 输入文件对象
    
    outputFile - 输出文件对象
    
    返回:
    
    构建完成的 ccf 表对象
    
    抛出:
    
    java.io.IOException - IO 异常
  - loadFromCCF
```
public static void loadFromCCF(java.lang.Object inputFile)
                        throws java.io.IOException
```
    从 ccf 文件中加载染色体信息
    
    参数:
    
    inputFile - 输入文件对象
    
    抛出:
    
    java.io.IOException - 来自 CCF 的 IO 异常
  - init
```
public static void init()
```
    初始化染色体信息 (恢复为人类基因组)
  - addChromosome
```
public static Chromosome addChromosome(Chromosome chromosome)
```
    添加染色体数据
    
    参数:
    
    chromosome - 染色体对象
    
    返回:
    
    添加的染色体对象
  - getChromosomeIndex
```
public int getChromosomeIndex()
```
    返回:
    
    染色体索引
  - getFullName
```
public java.lang.String getFullName()
```
    返回:
    
    完整染色体名
  - getSimpleName
```
public java.lang.String getSimpleName()
```
    返回:
    
    精简染色体名
  - getAlternativeNames
```
public edu.sysu.pmglab.container.array.BaseArray<java.lang.String> getAlternativeNames()
```
    获得其他的替代名列表
    
    返回:
    
    替代名
  - toString
```
public java.lang.String toString()
```
    覆盖:
    
    toString 在类中 java.lang.Object
  - hashCode
```
public int hashCode()
```
    覆盖:
    
    hashCode 在类中 java.lang.Object
    
    返回:
    
    使用简称作为 hash 的键
  - equals
```
public boolean equals(java.lang.Object o)
```
    覆盖:
    
    equals 在类中 java.lang.Object
  - compareTo
```
public int compareTo(Chromosome o)
```
    指定者:
    
    compareTo 在接口中 java.lang.Comparable<Chromosome>
  - iterator
```
public static edu.sysu.pmglab.container.IndexableSet<Chromosome> iterator()
```
    返回:
    
    染色体迭代器
  - identifiableList
```
public static java.util.Set<Chromosome> identifiableList()
```
    返回:
    
    可用的染色体列表
  - chromosomeSorter
```
public static int chromosomeSorter(Chromosome chromosome1,
                                   Chromosome chromosome2)
```
    染色体排序器
    
    参数:
    
    chromosome1 - 染色体 1
    
    chromosome2 - 染色体 2
    
    返回:
    
    排序结果

类 Chromosome

构造器概要

方法概要

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

构造器详细资料

Chromosome

方法详细资料

get

get

get

setProperty

getProperty

clear

save

convertTSV2CCF

loadFromCCF

init

addChromosome

getChromosomeIndex

getFullName

getSimpleName

getAlternativeNames

toString

hashCode

equals

compareTo

iterator

identifiableList

chromosomeSorter