Packages

o

gem.ocs2.pio

PioPath

object PioPath

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.

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. PioPath
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. final case class Attr(name: String) extends Lookup with Product with Serializable
  2. final case class Child(name: String) extends Lookup with Product with Serializable
  3. final case class Listing(path: SearchPath, node: Either[PioError, List[Node]]) extends Product with Serializable
  4. trait Lookup extends AnyRef
  5. implicit class NodeOps extends AnyRef
  6. final case class NonEmptySearchPath(path: String) extends SearchPath with Product with Serializable
  7. final case class Optional(path: SearchPath, node: PioOptional[Node]) extends Product with Serializable
  8. final case class Param(name: String) extends Lookup with Product with Serializable
  9. final case class Paramset(name: String) extends Lookup with Product with Serializable
  10. final case class Required(path: SearchPath, node: Either[PioError, Node]) extends Product with Serializable
  11. sealed trait SearchPath extends AnyRef

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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  9. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  14. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  15. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  16. def toString(): String
    Definition Classes
    AnyRef → Any
  17. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  18. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  19. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  20. case object EmptySearchPath extends SearchPath with Product with Serializable
  21. object Lookup

Inherited from AnyRef

Inherited from Any

Ungrouped