Packages

  • package root
    Definition Classes
    root
  • package edu
    Definition Classes
    root
  • package holycross
    Definition Classes
    edu
  • package shot
    Definition Classes
    holycross
  • package cex

    Provides an object for parsing citable resources in CEX serialization.

    Provides an object for parsing citable resources in CEX serialization. See https://github.com/cite-architecture/citedx for documentation of the CEX format.

    Overview

    The main class is the CexParser. It is constructucted from a string in CEX format, and provides functions for working with distinct blocks of the data source. For example:

    val cex = CexParser(cexSourceString)
    // get a map of all blocks labels to a Vector of one or
    // more string data sets:
    val blockMap = cex.blockMap
    // get a single string concatenating all data for a single
    // block type:
    val ctsCatalog = cex.blockString("ctscatalog")

    In the JVM environment, the CexParserSource object provides a single-step factory function for creating parsers from files:

    val cex = CexParserSource.fromFile("filename.cex")
    Definition Classes
    shot
  • CexParser
  • CexParserSource

package cex

Provides an object for parsing citable resources in CEX serialization. See https://github.com/cite-architecture/citedx for documentation of the CEX format.

Overview

The main class is the CexParser. It is constructucted from a string in CEX format, and provides functions for working with distinct blocks of the data source. For example:

val cex = CexParser(cexSourceString)
// get a map of all blocks labels to a Vector of one or
// more string data sets:
val blockMap = cex.blockMap
// get a single string concatenating all data for a single
// block type:
val ctsCatalog = cex.blockString("ctscatalog")

In the JVM environment, the CexParserSource object provides a single-step factory function for creating parsers from files:

val cex = CexParserSource.fromFile("filename.cex")
Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. cex
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. case class CexParser(rawCex: String) extends Product with Serializable

    A CEX parser making blocks of a CEX String available as a named map of label -> vectors of data.

    A CEX parser making blocks of a CEX String available as a named map of label -> vectors of data.

    rawCex

    CEX data to parse.

    Annotations
    @JSExportAll()

Value Members

  1. val labels: Set[String]

    Exhaustive set of valid labels for CEX blocks.

  2. object CexParserSource

    Factory for creating CexParsers for CEX data accessible from JVM-specific sources.

Inherited from AnyRef

Inherited from Any

Ungrouped