-
- All Implemented Interfaces:
-
kotlin.Comparable
public final class BedEntry implements Comparable<BedEntry>
A minimal representation of a BED file entry.
The BED standard absolutely requires three fields: chrom, start and end. The remaining line is stored in rest. It might or might not contain other, more optional BED fields, such as name, score or color. Use unpack to obtain an ExtendedBedEntry where these fields are properly parsed.
-
-
Method Summary
Modifier and Type Method Description IntegercompareTo(BedEntry other)final ExtendedBedEntryunpack(Byte fieldsNumber, Boolean parseExtraFields, Character delimiter, Boolean omitEmptyStrings)Unpacks a basic bed3 BedEntry into a bedN+ ExtendedBedEntry. final ExtendedBedEntryunpack(Byte fieldsNumber, Integer extraFieldsNumber, Character delimiter, Boolean omitEmptyStrings)final Stringcomponent1()final Integercomponent2()final Integercomponent3()final Stringcomponent4()final BedEntrycopy(String chrom, Integer start, Integer end, String rest)final StringgetChrom()Chromosome name, e.g. final IntegergetStart()0-based start offset (inclusive). final IntegergetEnd()0-based end offset (exclusive). final StringgetRest()Tab-separated string of additional BED values. -
-
Method Detail
-
unpack
final ExtendedBedEntry unpack(Byte fieldsNumber, Boolean parseExtraFields, Character delimiter, Boolean omitEmptyStrings)
Unpacks a basic bed3 BedEntry into a bedN+ ExtendedBedEntry.
Correctly parses the typed BED fields (such as score, color or blockSizes). Extra (non-standard) fields, if any (and if parseExtraFields is enabled) are stored in ExtendedBedEntry.extraFields property as a String array (null if no extra fields or parseExtraFields is disabled).
- Parameters:
fieldsNumber- Expected regular BED format fields number to parse (3..parseExtraFields- Whether to parse or discard the BED+ format extra fields.delimiter- Custom delimiter for malformed dataomitEmptyStrings- Treat several consecutive separators as one
-
unpack
@Deprecated(message = "use parseExtraFields instead of extraFieldsNumber", replaceWith = @ReplaceWith(imports = {}, expression = "unpack(fieldsNumber, extraFieldsNumber != 0, delimiter, omitEmptyStrings)")) final ExtendedBedEntry unpack(Byte fieldsNumber, Integer extraFieldsNumber, Character delimiter, Boolean omitEmptyStrings)
-
component1
final String component1()
-
component2
final Integer component2()
-
component3
final Integer component3()
-
component4
final String component4()
-
-
-
-