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
  • InvalidMicrodata
  • MicrodataDocument
  • MicrodataItem
  • MicrodataLink
  • MicrodataProperty
  • MicrodataQuery
  • MicrodataString
  • MicrodataValue
c

microtesia

MicrodataDocument

case class MicrodataDocument extends Product with Serializable

Representation of a document containing microdata mark-up. Returned by the parseMicrodata function. A MicrodataDocument can contain multiple MicrodataItem instances which can be accessed via the rootItems property as follows:

scala> document.rootItems.foreach{ (m: MicrodataItem) => println(m.itemtype) }
Some(http://schema.org/Movie)
Linear Supertypes
Serializable, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. MicrodataDocument
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

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 finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  8. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  9. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  10. def items(itemtype: URI): Seq[MicrodataItem]

    Utility method to help collect all items by their type URI within a document.

  11. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  13. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  14. def rootItems(itemtype: URI): Seq[MicrodataItem]

    Utility method to help collect root items by their type URI within a document.

  15. val rootItems: Seq[MicrodataItem]
  16. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  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 Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped