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

MicrodataItem

case class MicrodataItem(properties: Seq[MicrodataProperty], itemtype: Option[URI] = None, id: Option[URI] = None) extends MicrodataValue with MicrodataQuery with Product with Serializable

Represents a microdata "item". An item consists of a set of properties (name-value pairs) and an optional itemtype and unique id.

Note Properties are represented by a sequence of MicrodataProperty and not a map as a property name can have multiple values in a microdata document.

properties

Map of name-value pairs.

itemtype

Optional type of the item defined by a URI.

id

Optional unique identifier of the item defined by a URI.

Linear Supertypes
Serializable, Serializable, Product, Equals, MicrodataQuery, MicrodataValue, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. MicrodataItem
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. MicrodataQuery
  7. MicrodataValue
  8. AnyRef
  9. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new MicrodataItem(properties: Seq[MicrodataProperty], itemtype: Option[URI] = None, id: Option[URI] = None)

    properties

    Map of name-value pairs.

    itemtype

    Optional type of the item defined by a URI.

    id

    Optional unique identifier of the item defined by a URI.

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 \(key: String): MicrodataQuery

    Query item properties using XPath-like syntax.

    Query item properties using XPath-like syntax.

    For example:

    scala> val item = MicrodataItem(properties = Seq(("name", MicrodataString("Brian"))))

scala> item \ "name"
res1: MicrodataQuery = QueryResults(List(MicrodataString(Brian)))
    Definition Classes
    MicrodataQuery
  5. def \\(key: String): MicrodataQuery

    Recursively query item properties using XPath-like syntax.

    Recursively query item properties using XPath-like syntax.

    For example:

    scala> val item = MicrodataItem(properties = Seq(("friend", MicrodataItem(properties = Seq(("name", MicrodataString("Brian")))))))

scala> item \\ "name"
res1: MicrodataQuery = QueryResults(List(MicrodataString(Brian)))
    Definition Classes
    MicrodataQuery
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. lazy val children: Seq[MicrodataValue]

    Returns all the child elements of this microdata item.

  8. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  9. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  11. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  12. val id: Option[URI]
  13. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  14. val itemtype: Option[URI]
  15. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  17. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  18. val properties: Seq[MicrodataProperty]
  19. lazy val results: Seq[MicrodataItem]

    Results found for this query.

    Results found for this query.

    Definition Classes
    MicrodataItem → MicrodataQuery
  20. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  21. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  22. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  23. 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 MicrodataQuery

Inherited from MicrodataValue

Inherited from AnyRef

Inherited from Any

Ungrouped