Packages

  • package root
    Definition Classes
    root
  • package microtesia

    Documentation for the Microtesia microdata parsing library.

    Documentation for the Microtesia microdata parsing library.

    Usage

    To use simply put the Microtesia API in scope and call the parseMicrodata function as follows:

    scala> import microtesia._
import microtesia.

scala> import scala.util.Try
import scala.util.Try

scala> parseMicrodata("""<div itemscope itemtype="http://schema.org/Movie"><h1 itemprop="name">Avatar</h1></div>""")
res0: Try[microtesia.MicrodataDocument] = Success(MicrodataDocument(List(MicrodataItem(ArrayBuffer((name,MicrodataString(Avatar))),Some(http://schema.org/Movie),None))))
    Definition Classes
    root
  • package formats

    API to automatically de-serialise MicrodataValue instances into value types and case classes.

    API to automatically de-serialise MicrodataValue instances into value types and case classes.

    Usage

    To use simply put the Microtesia Formats API in scope (with the Microtesia API). This enriches MicrodataValue instances with the EnrichedMicrodataValue.convertTo method which you can use to parse microdata as follows:

    scala> import microtesia._
import microtesia._

scala> import formats._
import formats._

scala> import scala.util.Try
import scala.util.Try

scala> case class Person(name: String, age: Int, adult: Boolean)
defined class Person

scala>  MicrodataItem(
          Seq(
            ("name", MicrodataString("hello")),
            ("age", MicrodataString("13")),
            ("adult", MicrodataString("true"))
          )
        ).convertTo[Person]
res0: Try[Person] = Success(Person(hello,13,true))
    Definition Classes
    microtesia
  • CannotConvert
  • CollectionFormats
  • EnrichedMicrodataDocument
  • EnrichedMicrodataValue
  • HNilFormat
  • LinkFormat
  • MicrodataFormat
  • MicrodataPropertyFormat
  • RichTypeFormats
  • ShapelessFormats
  • SimpleTypeFormats
t

microtesia.formats

MicrodataFormat

trait MicrodataFormat[T] extends AnyRef

Trait for implicit formatters to de-serialize microdata values to hard types. You can define custom formats as follows:

scala> import microtesia._
import microtesia._

scala> import formats._
import formats._

scala> import java.time._
import java.time._

scala> import scala.util.{Failure, Success, Try}
import scala.util.{Failure, Success, Try}

scala> implicit val dateFormat = new MicrodataFormat[LocalDate] {
     |  override def read(microdata: MicrodataValue): Try[LocalDate] = microdata match {
     |    case MicrodataString(value)  => Success(LocalDate.parse(value))
     |    case other                   => Failure(CannotConvert(classOf[LocalDate], other))
     |  }
     | }
dateFormat: microtesia.formats.MicrodataFormat[java.time.LocalDate] = $anon$1@4fa4e3b6

scala> MicrodataString("2016-01-01").convertTo[LocalDate]
res0: Try[java.time.LocalDate] = Success(2016-01-01)
Annotations
@implicitNotFound( ... )
Linear Supertypes
AnyRef, Any
Known Subclasses
LinkFormat, HNilFormat
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. MicrodataFormat
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def read(microdata: MicrodataValue): Try[T]

Concrete 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[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  9. final def getClass(): Class[_]
    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( ... )
  18. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  19. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped