org.apache.predictionio.data.storage

EventValidation

object EventValidation

:: DeveloperApi :: Utilities for validating Events

Annotations
@DeveloperApi()
Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. EventValidation
  2. AnyRef
  3. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

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. final def ==(arg0: AnyRef): Boolean

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

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

    Definition Classes
    Any
  7. val builtinEntityTypes: Set[String]

    Defines built-in entity types.

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

  8. val builtinProperties: Set[String]

    Defines built-in properties.

    Defines built-in properties. This is currently empty.

  9. def clone(): AnyRef

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

    Default time zone is set to UTC

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

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

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

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

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

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

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

  17. final def isInstanceOf[T0]: Boolean

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

    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

  19. def isSpecialEvents(name: String): Boolean

    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

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

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

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

    Definition Classes
    AnyRef
  23. val specialEvents: Set[String]

    PredictionIO reserves some single entity event names.

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

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

    Definition Classes
    AnyRef
  25. def toString(): String

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

    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

  27. def validateProperties(e: Event): Unit

    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

  28. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped