class StarRating

nitc :: StarRating

Star ratings allow users to rate mentities with a 5-stars system.

Each rating can consider only one dimension of the mentity. Dimensions are arbitrary strings used to group ratings.

Introduced properties

private var _dimension: nullable String

nitc :: StarRating :: _dimension

The dimension rated (arbritrary key)
private var _mentity: String

nitc :: StarRating :: _mentity

Rated MEntity::full_name
private var _rating: Int

nitc :: StarRating :: _rating

The rating (traditionally a score between 0 and 5)
private var _timestamp: Int

nitc :: StarRating :: _timestamp

Timestamp when this rating was created
private var _user: nullable String

nitc :: StarRating :: _user

The user login that made that rating (or null if anon)
init defaultinit(user: nullable String, mentity: String, dimension: nullable String, rating: Int)

nitc :: StarRating :: defaultinit

fun dimension: nullable String

nitc :: StarRating :: dimension

The dimension rated (arbritrary key)
protected fun dimension=(dimension: nullable String)

nitc :: StarRating :: dimension=

The dimension rated (arbritrary key)
fun mentity: String

nitc :: StarRating :: mentity

Rated MEntity::full_name
protected fun mentity=(mentity: String)

nitc :: StarRating :: mentity=

Rated MEntity::full_name
fun rating: Int

nitc :: StarRating :: rating

The rating (traditionally a score between 0 and 5)
fun rating=(rating: Int)

nitc :: StarRating :: rating=

The rating (traditionally a score between 0 and 5)
fun timestamp: Int

nitc :: StarRating :: timestamp

Timestamp when this rating was created
fun timestamp=(timestamp: Int)

nitc :: StarRating :: timestamp=

Timestamp when this rating was created
fun user: nullable String

nitc :: StarRating :: user

The user login that made that rating (or null if anon)
protected fun user=(user: nullable String)

nitc :: StarRating :: user=

The user login that made that rating (or null if anon)

Redefined properties

redef type SELF: StarRating

nitc $ StarRating :: SELF

Type of this instance, automatically specialized in every class
redef fun core_serialize_to(v: Serializer)

nitc $ StarRating :: core_serialize_to

Actual serialization of self to serializer
redef init from_deserializer(v: Deserializer)

nitc $ StarRating :: from_deserializer

Create an instance of this class from the deserializer

All properties

fun !=(other: nullable Object): Bool

core :: Object :: !=

Have self and other different values?
fun ==(other: nullable Object): Bool

core :: Object :: ==

Have self and other the same value?
type CLASS: Class[SELF]

core :: Object :: CLASS

The type of the class of self.
type SELF: Object

core :: Object :: SELF

Type of this instance, automatically specialized in every class
private var _dimension: nullable String

nitc :: StarRating :: _dimension

The dimension rated (arbritrary key)
private var _id: String

popcorn :: RepoObject :: _id

self unique id.
private var _mentity: String

nitc :: StarRating :: _mentity

Rated MEntity::full_name
private var _rating: Int

nitc :: StarRating :: _rating

The rating (traditionally a score between 0 and 5)
private var _timestamp: Int

nitc :: StarRating :: _timestamp

Timestamp when this rating was created
private var _user: nullable String

nitc :: StarRating :: _user

The user login that made that rating (or null if anon)
protected fun accept_json_serializer(v: JsonSerializer)

serialization :: Serializable :: accept_json_serializer

Refinable service to customize the serialization of this class to JSON
protected fun accept_msgpack_attribute_counter(v: AttributeCounter)

serialization :: Serializable :: accept_msgpack_attribute_counter

Hook to customize the behavior of the AttributeCounter
protected fun accept_msgpack_serializer(v: MsgPackSerializer)

serialization :: Serializable :: accept_msgpack_serializer

Hook to customize the serialization of this class to MessagePack
protected fun add_to_bundle(bundle: NativeBundle, key: JavaString)

serialization :: Serializable :: add_to_bundle

Called by []= to dynamically choose the appropriate method according
protected fun class_factory(name: String): CLASS

core :: Object :: class_factory

Implementation used by get_class to create the specific class.
fun class_name: String

core :: Object :: class_name

The class name of the object.
fun core_serialize_to(serializer: Serializer)

serialization :: Serializable :: core_serialize_to

Actual serialization of self to serializer
init defaultinit(user: nullable String, mentity: String, dimension: nullable String, rating: Int)

nitc :: StarRating :: defaultinit

fun dimension: nullable String

nitc :: StarRating :: dimension

The dimension rated (arbritrary key)
protected fun dimension=(dimension: nullable String)

nitc :: StarRating :: dimension=

The dimension rated (arbritrary key)
init from_deserializer(deserializer: Deserializer)

serialization :: Serializable :: from_deserializer

Create an instance of this class from the deserializer
fun get_class: CLASS

core :: Object :: get_class

The meta-object representing the dynamic type of self.
fun hash: Int

core :: Object :: hash

The hash code of the object.
fun id: String

popcorn :: RepoObject :: id

self unique id.
fun id=(id: String)

popcorn :: RepoObject :: id=

self unique id.
init init

core :: Object :: init

fun inspect: String

core :: Object :: inspect

Developer readable representation of self.
protected fun inspect_head: String

core :: Object :: inspect_head

Return "CLASSNAME:#OBJECTID".
intern fun is_same_instance(other: nullable Object): Bool

core :: Object :: is_same_instance

Return true if self and other are the same instance (i.e. same identity).
fun is_same_serialized(other: nullable Object): Bool

core :: Object :: is_same_serialized

Is self the same as other in a serialization context?
intern fun is_same_type(other: Object): Bool

core :: Object :: is_same_type

Return true if self and other have the same dynamic type.
fun mentity: String

nitc :: StarRating :: mentity

Rated MEntity::full_name
protected fun mentity=(mentity: String)

nitc :: StarRating :: mentity=

Rated MEntity::full_name
protected fun msgpack_extra_array_items: Int

serialization :: Serializable :: msgpack_extra_array_items

Hook to request a larger than usual metadata array
private intern fun native_class_name: CString

core :: Object :: native_class_name

The class name of the object in CString format.
intern fun object_id: Int

core :: Object :: object_id

An internal hash code for the object based on its identity.
fun output

core :: Object :: output

Display self on stdout (debug only).
intern fun output_class_name

core :: Object :: output_class_name

Display class name on stdout (debug only).
fun rating: Int

nitc :: StarRating :: rating

The rating (traditionally a score between 0 and 5)
fun rating=(rating: Int)

nitc :: StarRating :: rating=

The rating (traditionally a score between 0 and 5)
fun serialization_hash: Int

core :: Object :: serialization_hash

Hash value use for serialization
fun serialize_msgpack(plain: nullable Bool): Bytes

serialization :: Serializable :: serialize_msgpack

Serialize self to MessagePack bytes
fun serialize_to(serializer: Serializer)

serialization :: Serializable :: serialize_to

Serialize self to serializer
fun serialize_to_json(plain: nullable Bool, pretty: nullable Bool): String

serialization :: Serializable :: serialize_to_json

Serialize self to JSON
private fun serialize_to_or_delay(v: Serializer)

serialization :: Serializable :: serialize_to_or_delay

Accept references or force direct serialization (using serialize_to)
intern fun sys: Sys

core :: Object :: sys

Return the global sys object, the only instance of the Sys class.
fun timestamp: Int

nitc :: StarRating :: timestamp

Timestamp when this rating was created
fun timestamp=(timestamp: Int)

nitc :: StarRating :: timestamp=

Timestamp when this rating was created
fun to_json: String

serialization :: Serializable :: to_json

Serialize self to plain JSON
abstract fun to_jvalue(env: JniEnv): JValue

core :: Object :: to_jvalue

fun to_pretty_json: String

serialization :: Serializable :: to_pretty_json

Serialize self to plain pretty JSON
fun to_s: String

core :: Object :: to_s

User readable representation of self.
fun user: nullable String

nitc :: StarRating :: user

The user login that made that rating (or null if anon)
protected fun user=(user: nullable String)

nitc :: StarRating :: user=

The user login that made that rating (or null if anon)
package_diagram nitc::StarRating StarRating popcorn::RepoObject RepoObject nitc::StarRating->popcorn::RepoObject serialization::Serializable Serializable popcorn::RepoObject->serialization::Serializable ...serialization::Serializable ... ...serialization::Serializable->serialization::Serializable

Ancestors

interface Object

core :: Object

The root of the class hierarchy.
interface Serializable

serialization :: Serializable

Instances of this class can be passed to Serializer::serialize

Parents

abstract class RepoObject

popcorn :: RepoObject

Base serializable entity that can go into a JsonRepository

Class definitions

nitc $ StarRating 
# Star ratings allow users to rate mentities with a 5-stars system.
#
# Each rating can consider only one `dimension` of the mentity.
# Dimensions are arbitrary strings used to group ratings.
class StarRating
	super RepoObject
	serialize

	# The user login that made that rating (or null if anon)
	var user: nullable String

	# Rated `MEntity::full_name`
	var mentity: String

	# The dimension rated (arbritrary key)
	var dimension: nullable String

	# The rating (traditionally a score between 0 and 5)
	var rating: Int is writable

	# Timestamp when this rating was created
	var timestamp = 0 is writable
end
src/doc/api/api_feedback.nit:173,1--195,3
Nit tools. Version .