Trait/Object

com.fulcrumgenomics.bam.api

SamOrder

Related Docs: object SamOrder | package api

Permalink

sealed trait SamOrder extends Product

Trait for specifying BAM orderings.

Linear Supertypes
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SamOrder
  2. Product
  3. Equals
  4. AnyRef
  5. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. abstract type A <: Ordered[A]

    Permalink

Abstract Value Members

  1. abstract def canEqual(that: Any): Boolean

    Permalink
    Definition Classes
    Equals
  2. abstract def groupOrder: GroupOrder

    Permalink

    Returns the group order that should be set in the SAM header.

    Returns the group order that should be set in the SAM header. None will cause GO to be unset.

  3. abstract def productArity: Int

    Permalink
    Definition Classes
    Product
  4. abstract def productElement(n: Int): Any

    Permalink
    Definition Classes
    Product
  5. abstract def sortOrder: SortOrder

    Permalink

    Returns the sort order that should be set in the SAM header.

  6. abstract def sortkey: (SamRecord) ⇒ A

    Permalink

    Function to generate the sort key for sorting records into this ordering.

  7. abstract def subSort: Option[String]

    Permalink

    The subsort string to be placed *after* the sort order in the SS tag.

Concrete Value Members

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from SamOrder to any2stringadd[SamOrder] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (SamOrder, B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from SamOrder to ArrowAssoc[SamOrder] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  6. def applyTo(header: SAMFileHeader): SAMFileHeader

    Permalink

    Sets the appropriate fields in the SAM header for the order.

  7. final def asInstanceOf[T0]: T0

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

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  9. def ensuring(cond: (SamOrder) ⇒ Boolean, msg: ⇒ Any): SamOrder

    Permalink
    Implicit information
    This member is added by an implicit conversion from SamOrder to Ensuring[SamOrder] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: (SamOrder) ⇒ Boolean): SamOrder

    Permalink
    Implicit information
    This member is added by an implicit conversion from SamOrder to Ensuring[SamOrder] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean, msg: ⇒ Any): SamOrder

    Permalink
    Implicit information
    This member is added by an implicit conversion from SamOrder to Ensuring[SamOrder] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: Boolean): SamOrder

    Permalink
    Implicit information
    This member is added by an implicit conversion from SamOrder to Ensuring[SamOrder] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  14. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  15. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  16. def formatted(fmtstr: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from SamOrder to StringFormat[SamOrder] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  17. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  18. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  19. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  20. def name: String

    Permalink

    Returns the order's name.

  21. final def ne(arg0: AnyRef): Boolean

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

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

    Permalink
    Definition Classes
    AnyRef
  24. def productIterator: Iterator[Any]

    Permalink
    Definition Classes
    Product
  25. def productPrefix: String

    Permalink
    Definition Classes
    Product
  26. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  27. def toString(): String

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

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  31. def [B](y: B): (SamOrder, B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from SamOrder to ArrowAssoc[SamOrder] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from SamOrder to any2stringadd[SamOrder]

Inherited by implicit conversion StringFormat from SamOrder to StringFormat[SamOrder]

Inherited by implicit conversion Ensuring from SamOrder to Ensuring[SamOrder]

Inherited by implicit conversion ArrowAssoc from SamOrder to ArrowAssoc[SamOrder]

Ungrouped