Object

org.apache.predictionio.data.storage

EventValidation

Related Doc: package storage

Permalink

object EventValidation

:: DeveloperApi :: Utilities for validating Events

Annotations
@DeveloperApi()
Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. EventValidation
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Value Members

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

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

    Permalink
    Definition Classes
    Any
  5. val builtinEntityTypes: Set[String]

    Permalink

    Defines built-in entity types.

    Defines built-in entity types. The current built-in type is pio_pr.

  6. val builtinProperties: Set[String]

    Permalink

    Defines built-in properties.

    Defines built-in properties. This is currently empty.

  7. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  8. val defaultTimeZone: DateTimeZone

    Permalink

    Default time zone is set to UTC

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

    Permalink
    Definition Classes
    AnyRef
  10. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  11. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  12. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  13. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  14. def isBuiltinEntityTypes(name: String): Boolean

    Permalink

    Checks whether an entity type is a built-in entity type

  15. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  16. def isReservedPrefix(name: String): Boolean

    Permalink

    Checks whether an event name contains a reserved prefix

    Checks whether an event name contains a reserved prefix

    name

    Event name

    returns

    true if event name starts with $ or pio_, false otherwise

  17. def isSpecialEvents(name: String): Boolean

    Permalink

    Checks whether an event name is a special PredictionIO event name

    Checks whether an event name is a special PredictionIO event name

    name

    Event name

    returns

    true if the name is a special event, false otherwise

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

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

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

    Permalink
    Definition Classes
    AnyRef
  21. val specialEvents: Set[String]

    Permalink

    PredictionIO reserves some single entity event names.

    PredictionIO reserves some single entity event names. They are currently $set, $unset, and $delete.

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

    Permalink
    Definition Classes
    AnyRef
  23. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  24. def validate(e: Event): Unit

    Permalink

    Validate an Event, throwing exceptions when the candidate violates any of the following:

    Validate an Event, throwing exceptions when the candidate violates any of the following:

    • event name must not be empty
    • entityType must not be empty
    • entityId must not be empty
    • targetEntityType must not be Some of empty
    • targetEntityId must not be Some of empty
    • targetEntityType and targetEntityId must be both Some or None
    • properties must not be empty when event is $unset
    • event name must be a special event if it has a reserved prefix
    • targetEntityType and targetEntityId must be None if the event name has a reserved prefix
    • entityType must be a built-in entity type if entityType has a reserved prefix
    • targetEntityType must be a built-in entity type if targetEntityType is Some and has a reserved prefix
    e

    Event to be validated

  25. def validateProperties(e: Event): Unit

    Permalink

    Validate event properties, throwing exceptions when the candidate violates any of the following:

    Validate event properties, throwing exceptions when the candidate violates any of the following:

    • property name must not contain a reserved prefix
    e

    Event to be validated

  26. final def wait(): Unit

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

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

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

Inherited from AnyRef

Inherited from Any

Ungrouped