Package org.biojava.nbio.genome.parsers.gff

Class GFF3Reader

java.lang.Object

org.biojava.nbio.genome.parsers.gff.GFF3Reader

public class GFF3Reader
extends Object

http://www.bioperl.org/wiki/GTF Read and write FeatureLists as GFF/GTF formatted files.

The GFF moniker is applied to a variety of tab-delimited formats that mock the notion of a standard. This class should parse most files bearing at least a passing resemblance to any of the formats. You will, however, need to research the semantics of the files you encounter. Generally, the format consists of 9 tab-delimited fields:

 seqname   source   featureType   start   end   score   strand   frame   attributes
 

The 9th field consists of key-value pairs separated by semicolons, the first of which JavaGene interprets as the group id (as used in GFF1). It is the precise meaning of this 9th field that varies from week to week. The Feature and FeatureList objects provide various utility methods to ease the task of accessing and using the attributes. The proper interpretation of any particular attribute, however, is left to you.

Author:

Hanno Hinsch

Constructor Summary

Constructors

Constructor	Description
GFF3Reader()

Method Summary

Modifier and Type	Method	Description
static void	main(String[] args)
static FeatureList	read(String filename)
static FeatureList	read(String filename, List<String> indexes)	Read a file into a FeatureList.
static FeatureList	read(Path path)
static FeatureList	read(Path path, List<String> indexes)	Read a file into a FeatureList.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GFF3Reader

public GFF3Reader()

Method Detail

read

public static FeatureList read(String filename,
                               List<String> indexes)
                        throws IOException

Read a file into a FeatureList. Each line of the file becomes one Feature object.

Parameters:

filename - The path to the GFF file.

Returns:

A FeatureList.

Throws:

IOException - Something went wrong -- check exception detail message.

read

public static FeatureList read(Path path,
                               List<String> indexes)
                        throws IOException

Read a file into a FeatureList. Each line of the file becomes one Feature object.

Parameters:

path - The path to the GFF file.

Returns:

A FeatureList.

Throws:

IOException - Something went wrong -- check exception detail message.

read

public static FeatureList read(String filename)
                        throws IOException

Throws:

IOException

read

public static FeatureList read(Path path)
                        throws IOException

Throws:

IOException

main

public static void main(String[] args)
                 throws Exception

Throws:

Exception