Class/Object

org.bdgenomics.adam.models

RecordGroupDictionary

Related Docs: object RecordGroupDictionary | package models

Permalink

case class RecordGroupDictionary(recordGroups: Seq[RecordGroup]) extends Product with Serializable

Builds a dictionary containing record groups.

Record groups must have a unique name across all samples in the dictionary. This dictionary provides numerical IDs for each group; these IDs are only consistent when referencing a single dictionary.

recordGroups

A seq of record groups to popualate the dictionary.

Exceptions thrown

IllegalArgumentError Throws an assertion error if there are multiple record groups with the same name.

Linear Supertypes
Serializable, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. RecordGroupDictionary
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new RecordGroupDictionary(recordGroups: Seq[RecordGroup])

    Permalink

    recordGroups

    A seq of record groups to popualate the dictionary.

    Exceptions thrown

    IllegalArgumentError Throws an assertion error if there are multiple record groups with the same name.

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. def ++(that: RecordGroupDictionary): RecordGroupDictionary

    Permalink

    Merges together two record group dictionaries.

    Merges together two record group dictionaries.

    that

    The record group dictionary to merge with.

    returns

    The merged record group dictionary.

  4. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  5. def apply(recordGroupName: String): RecordGroup

    Permalink

    Returns the record group entry for an associated name.

    Returns the record group entry for an associated name.

    recordGroupName

    The record group to look up.

    returns

    Detailed info for a record group.

  6. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  7. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  8. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  9. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  10. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  11. def getIndex(recordGroupName: String): Int

    Permalink

    Returns the numerical index for a given record group name.

    Returns the numerical index for a given record group name.

    recordGroupName

    The record group to find an index for.

    returns

    Returns a numerical index for a record group.

    Note

    This index is only guaranteed to have the same value for a given record group name when the index is pulled from the same record group dictionary.

  12. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  13. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  14. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  15. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  16. val recordGroupMap: Map[String, (RecordGroup, Int)]

    Permalink

    A representation of this record group dictionary that can be indexed into by record group name.

  17. val recordGroups: Seq[RecordGroup]

    Permalink

    A seq of record groups to popualate the dictionary.

  18. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  19. def toSamples: Seq[Sample]

    Permalink

    returns

    Converts this record group dictionary to a set of samples.

  20. def toString(): String

    Permalink
    Definition Classes
    RecordGroupDictionary → AnyRef → Any
  21. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  22. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  23. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped