org.apache.predictionio.data.storage

DataMap

class DataMap extends Serializable

A DataMap stores properties of the event or entity. Internally it is a Map whose keys are property names and values are corresponding JSON values respectively. Use the String,clazz: Class[T]) method to retrieve the value of a mandatory property or use getOpt to retrieve the value of an optional property.

Linear Supertypes
Serializable, Serializable, AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. DataMap
  2. Serializable
  3. Serializable
  4. AnyRef
  5. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new DataMap(fields: Map[String, JValue])

    fields

    Map of property name to JValue

Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

    Definition Classes
    AnyRef → Any
  4. def ++(that: DataMap): DataMap

    Return a new DataMap with elements containing elements from the left hand side operand followed by elements from the right hand side operand.

    Return a new DataMap with elements containing elements from the left hand side operand followed by elements from the right hand side operand.

    that

    Right hand side DataMap

    returns

    A new DataMap

  5. def --(that: GenTraversableOnce[String]): DataMap

    Creates a new DataMap from this DataMap by removing all elements of another collection.

    Creates a new DataMap from this DataMap by removing all elements of another collection.

    that

    A collection containing the removed property names

    returns

    A new DataMap

  6. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  7. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  8. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  9. def canEqual(other: Any): Boolean

  10. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  11. def contains(name: String): Boolean

    Check if this DataMap contains a specific property.

    Check if this DataMap contains a specific property.

    name

    The property name

    returns

    Return true if the property exists, else false.

  12. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  13. def equals(other: Any): Boolean

    Definition Classes
    DataMap → AnyRef → Any
  14. def extract[T](implicit arg0: Manifest[T]): T

    Converts this DataMap to case class of type T.

    Converts this DataMap to case class of type T.

    returns

    the object of type T.

  15. val fields: Map[String, JValue]

    Map of property name to JValue

  16. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  17. def get[T](name: String, clazz: Class[T]): T

    Java-friendly method for getting the value of a property.

    Java-friendly method for getting the value of a property. Return null if the property does not exist.

    T

    The type of the property value

    name

    The property name

    clazz

    The class of the type of the property value

    returns

    Return the property value of type T

  18. def get[T](name: String)(implicit arg0: Manifest[T]): T

    Get the value of a mandatory property.

    Get the value of a mandatory property. Exception is thrown if the property does not exist.

    T

    The type of the property value

    name

    The property name

    returns

    Return the property value of type T

  19. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  20. def getOpt[T](name: String)(implicit arg0: Manifest[T]): Option[T]

    Get the value of an optional property.

    Get the value of an optional property. Return None if the property does not exist.

    T

    The type of the property value

    name

    The property name

    returns

    Return the property value of type Option[T]

  21. def getOrElse[T](name: String, default: T)(implicit arg0: Manifest[T]): T

    Get the value of an optional property.

    Get the value of an optional property. Return default value if the property does not exist.

    T

    The type of the property value

    name

    The property name

    default

    The default property value of type T

    returns

    Return the property value of type T

  22. def getStringList(name: String): List[String]

    Java-friendly method for getting a list of values of a property.

    Java-friendly method for getting a list of values of a property. Return null if the property does not exist.

    name

    The property name

    returns

    Return the list of property values

  23. def hashCode(): Int

    Definition Classes
    DataMap → AnyRef → Any
  24. def isEmpty: Boolean

    Tests whether the DataMap is empty.

    Tests whether the DataMap is empty.

    returns

    true if the DataMap is empty, false otherwise.

  25. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  26. def keySet: Set[String]

    Collects all property names of this DataMap in a set.

    Collects all property names of this DataMap in a set.

    returns

    a set containing all property names of this DataMap.

  27. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  28. final def notify(): Unit

    Definition Classes
    AnyRef
  29. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  30. def require(name: String): Unit

    Check the existence of a required property name.

    Check the existence of a required property name. Throw an exception if it does not exist.

    name

    The property name

  31. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  32. def toJObject(): JObject

    Converts this DataMap to a JObject.

    Converts this DataMap to a JObject.

    returns

    the JObject initialized by this DataMap.

  33. def toList(): List[(String, JValue)]

    Converts this DataMap to a List.

    Converts this DataMap to a List.

    returns

    a list of (property name, JSON value) tuples.

  34. def toString(): String

    Definition Classes
    DataMap → AnyRef → Any
  35. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  36. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  37. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped