Packages

  • package root
    Definition Classes
    root
  • package gem
    Definition Classes
    root
  • package ocs2
    Definition Classes
    gem
  • package pio
    Definition Classes
    ocs2
  • object PioPath

    PioPath provides a simplistic DSL for working with the OCS3 export format for OCS2 data.

    PioPath provides a simplistic DSL for working with the OCS3 export format for OCS2 data. The language consists of an operator:

    • \! - required element
    • \? - optional element
    • \* - list of immediate child elements
    • \\* - list of descendent elements

    and a corresponding match string where the initial character is:

    • '@' - attribute element
    • '#' - param element with the given name
    • '&' - paramset element with the given name
    • - (i.e., no special character) child element

    Example:

    (n \?  "instrument" \! "@type")

    Node with an optional <instrument> element that, if it exists, has a required "type" attribute. When decoded, any path that included a ? but not a * will produce an Option result. Any path including a * will produce a List.

    If a required element is missing, the result will be MissingKey PioError when decoded.

    Definition Classes
    pio
  • Attr
  • Child
  • EmptySearchPath
  • Listing
  • Lookup
  • NodeOps
  • NonEmptySearchPath
  • Optional
  • Param
  • Paramset
  • Required
  • SearchPath

final case class Listing(path: SearchPath, node: Either[PioError, List[Node]]) extends Product with Serializable

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

Instance Constructors

  1. new Listing(path: SearchPath, node: Either[PioError, List[Node]])

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def \!(matchString: String): Listing
  5. def \*(matchString: String): Listing
  6. def \?(matchString: String): Listing
  7. def \\*(matchString: String): Listing
  8. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  9. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  10. def decode[A](implicit ev: PioDecoder[A]): Either[PioError, List[A]]
  11. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  13. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  14. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  15. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. val node: Either[PioError, List[Node]]
  17. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  18. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  19. val path: SearchPath
  20. def productElementNames: Iterator[String]
    Definition Classes
    Product
  21. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  22. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  23. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  24. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped