htsjdk.tribble.index.tabix

Class TabixFormat

java.lang.Object

htsjdk.tribble.index.tabix.TabixFormat

All Implemented Interfaces:

java.lang.Cloneable

public class TabixFormat
extends java.lang.Object
implements java.lang.Cloneable

The values in a Tabix header that define the format of the file being indexed, e.g. gff, bed, vcf

Field Summary

Fields

Modifier and Type	Field and Description
static TabixFormat	BED
int	endPositionColumn One-based index of the column in the file being indexed containing the end position.
int	flags Describes interpretation of file being indexed.
static int	GENERIC_FLAGS
static TabixFormat	GFF Predefined headers for known formats
char	metaCharacter Lines in the file being indexed that start with this character are ignored.
int	numHeaderLinesToSkip This is part of the index header, but does not appear to be used.
static TabixFormat	PSLTBL
static TabixFormat	SAM
static int	SAM_FLAGS
int	sequenceColumn One-based index of the column in the file being indexed containing the sequence name
int	startPositionColumn One-based index of the column in the file being indexed containing the start position.
static int	UCSC_FLAGS
static TabixFormat	VCF
static int	VCF_FLAGS
static int	ZERO_BASED

Constructor Summary

Constructors

Constructor and Description
TabixFormat()
TabixFormat(int flags, int sequenceColumn, int startPositionColumn, int endPositionColumn, char metaCharacter, int numHeaderLinesToSkip)

Method Summary

Modifier and Type	Method and Description
TabixFormat	clone()
boolean	equals(java.lang.Object o)
int	hashCode()

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

ZERO_BASED

public static final int ZERO_BASED

See Also:

Constant Field Values

GENERIC_FLAGS

public static final int GENERIC_FLAGS

See Also:

Constant Field Values

SAM_FLAGS

public static final int SAM_FLAGS

See Also:

Constant Field Values

VCF_FLAGS

public static final int VCF_FLAGS

See Also:

Constant Field Values

UCSC_FLAGS

public static final int UCSC_FLAGS

See Also:

Constant Field Values

GFF

public static TabixFormat GFF

Predefined headers for known formats

BED

public static TabixFormat BED

PSLTBL

public static TabixFormat PSLTBL

SAM

public static TabixFormat SAM

VCF

public static TabixFormat VCF

flags

public int flags

Describes interpretation of file being indexed. See FLAGS constants above.

sequenceColumn

public int sequenceColumn

One-based index of the column in the file being indexed containing the sequence name

startPositionColumn

public int startPositionColumn

One-based index of the column in the file being indexed containing the start position.

endPositionColumn

public int endPositionColumn

One-based index of the column in the file being indexed containing the end position. Zero implies there is no end position column.

metaCharacter

public char metaCharacter

Lines in the file being indexed that start with this character are ignored.

numHeaderLinesToSkip

public int numHeaderLinesToSkip

This is part of the index header, but does not appear to be used.

Constructor Detail

TabixFormat

public TabixFormat()

TabixFormat

public TabixFormat(int flags,
                   int sequenceColumn,
                   int startPositionColumn,
                   int endPositionColumn,
                   char metaCharacter,
                   int numHeaderLinesToSkip)

Method Detail

clone

public TabixFormat clone()

Overrides:

clone in class java.lang.Object

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object