Class/Object

org.apache.predictionio.data.storage

DataMap

Related Docs: object DataMap | package storage

Permalink

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
Visibility
  1. Public
  2. All

Instance Constructors

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

    Permalink

    fields

    Map of property name to JValue

Value Members

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

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

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

    Permalink

    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

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

    Permalink

    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

  5. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  7. def canEqual(other: Any): Boolean

    Permalink
  8. def clone(): AnyRef

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

    Permalink

    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.

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

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

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

    Permalink

    Converts this DataMap to case class of type T.

    Converts this DataMap to case class of type T.

    returns

    the object of type T.

  13. val fields: Map[String, JValue]

    Permalink

    Map of property name to JValue

  14. def finalize(): Unit

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

    Permalink

    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

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

    Permalink

    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

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

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

    Permalink

    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]

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

    Permalink

    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

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

    Permalink

    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

  21. def hashCode(): Int

    Permalink
    Definition Classes
    DataMap → AnyRef → Any
  22. def isEmpty: Boolean

    Permalink

    Tests whether the DataMap is empty.

    Tests whether the DataMap is empty.

    returns

    true if the DataMap is empty, false otherwise.

  23. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  24. def keySet: Set[String]

    Permalink

    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.

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

    Permalink
    Definition Classes
    AnyRef
  26. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  27. final def notifyAll(): Unit

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

    Permalink

    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

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

    Permalink
    Definition Classes
    AnyRef
  30. def toJObject(): JObject

    Permalink

    Converts this DataMap to a JObject.

    Converts this DataMap to a JObject.

    returns

    the JObject initialized by this DataMap.

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

    Permalink

    Converts this DataMap to a List.

    Converts this DataMap to a List.

    returns

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

  32. def toString(): String

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

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped