final case class NodeObjectBinding[T](key: BindingKey)(implicit evidence$5: NodeObjectMapper[T]) extends Binding with Product with Serializable

A binding between a key that is a "JSON-LD value" and a Scala type that can be represented as that value. A NodeObjectMapper is responsible for doing the conversion.

Most of the time you'll use a custom NodeObjectMapper to convert appropriately, building on other bindings in your context. For example, to render a MonetaryAmount class as a node object, you can add the binding in a context that contains currency and value bindings:

case class MonetaryAmount(currency: Currency, value: Int)

/** Represent as https://schema.org/MonetaryAmount instance */
trait MonetaryAmountMapper extends MyContext {
  implicit val monetaryAmountMapper: NodeObjectMapper[MonetaryAmount] = NodeObjectMapper { ma =>
    NodeObject(
      `@type`  -> monetaryAmountType,
      currency -> ma.currency,
      value    -> ma.value
    )
  }
}
object MonetaryAmountMapper extends MonetaryAmountMapper

And then you can use bindObject[MonetaryAmount].

import MonetaryAmountMapper._

val estimatedSalary: NodeObjectBinding[MonetaryAmount] =
 schemaOrg("estimatedSalary").bindObject[MonetaryAmount]

You can also bind a simple NodeObject without mapping. For example, you can represent an organization with an employee as a raw NodeObject:

val employee  = schemaOrg("employee").bindObject[NodeObject]
val organization = NodeObject(
  `@type`   -> schemaOrg("Organization")
  name -> "Terse Systems",
  employee -> NodeObject(
    `@type`   -> schemaOrg("Person")
    givenName -> "Will",
  )
)
Source
Binding.scala
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. NodeObjectBinding
  2. Serializable
  3. Product
  4. Equals
  5. Binding
  6. AnyRef
  7. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new NodeObjectBinding(key: BindingKey)(implicit arg0: NodeObjectMapper[T])

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from NodeObjectBinding[T] toany2stringadd[NodeObjectBinding[T]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->(value: T): NodeEntry

    Binds to a value of T.

    Binds to a value of T.

    value

    the value

    returns

    the node entry

  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def bind(value: T): NodeEntry

    Binds to a value of T.

    Binds to a value of T.

    value

    the value

    returns

    the node entry

  8. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  9. def ensuring(cond: (NodeObjectBinding[T]) => Boolean, msg: => Any): NodeObjectBinding[T]
    Implicit
    This member is added by an implicit conversion from NodeObjectBinding[T] toEnsuring[NodeObjectBinding[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: (NodeObjectBinding[T]) => Boolean): NodeObjectBinding[T]
    Implicit
    This member is added by an implicit conversion from NodeObjectBinding[T] toEnsuring[NodeObjectBinding[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean, msg: => Any): NodeObjectBinding[T]
    Implicit
    This member is added by an implicit conversion from NodeObjectBinding[T] toEnsuring[NodeObjectBinding[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: Boolean): NodeObjectBinding[T]
    Implicit
    This member is added by an implicit conversion from NodeObjectBinding[T] toEnsuring[NodeObjectBinding[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from NodeObjectBinding[T] toStringFormat[NodeObjectBinding[T]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  15. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  16. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  17. val key: BindingKey
    Definition Classes
    NodeObjectBindingBinding
  18. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  20. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  21. def productElementNames: Iterator[String]
    Definition Classes
    Product
  22. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  23. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  24. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  25. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Shadowed Implicit Value Members

  1. def ->[B](y: B): (NodeObjectBinding[T], B)
    Implicit
    This member is added by an implicit conversion from NodeObjectBinding[T] toArrowAssoc[NodeObjectBinding[T]] performed by method ArrowAssoc in scala.Predef.
    Shadowing
    This implicitly inherited member is shadowed by one or more members in this class.
    To access this member you can use a type ascription:
    (nodeObjectBinding: ArrowAssoc[NodeObjectBinding[T]]).->(y)
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated
  2. def [B](y: B): (NodeObjectBinding[T], B)
    Implicit
    This member is added by an implicit conversion from NodeObjectBinding[T] toArrowAssoc[NodeObjectBinding[T]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from Binding

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromNodeObjectBinding[T] to any2stringadd[NodeObjectBinding[T]]

Inherited by implicit conversion StringFormat fromNodeObjectBinding[T] to StringFormat[NodeObjectBinding[T]]

Inherited by implicit conversion Ensuring fromNodeObjectBinding[T] to Ensuring[NodeObjectBinding[T]]

Inherited by implicit conversion ArrowAssoc fromNodeObjectBinding[T] to ArrowAssoc[NodeObjectBinding[T]]

Ungrouped