An operation that is trackable using a ProgressionListener.

Introduced properties

protected fun fire_done

progression :: Trackable :: fire_done

Notice the registered ProgessionListener that the operation is done.
protected fun fire_progressed(done_part: Int, total: Int)

progression :: Trackable :: fire_progressed

Notice the registered ProgessionListener that the operation progressed.
protected fun fire_started

progression :: Trackable :: fire_started

Notice the registered ProgessionListener that the operation started.
protected fun progression_listeners=(progression_listeners: SimpleCollection[ProgressionListener])

progression :: Trackable :: progression_listeners=

Listen to the progression of the operation.

Redefined properties

redef type SELF: Trackable

progression $ Trackable :: SELF

Type of this instance, automatically specialized in every class

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
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.
protected fun fire_done

progression :: Trackable :: fire_done

Notice the registered ProgessionListener that the operation is done.
protected fun fire_progressed(done_part: Int, total: Int)

progression :: Trackable :: fire_progressed

Notice the registered ProgessionListener that the operation progressed.
protected fun fire_started

progression :: Trackable :: fire_started

Notice the registered ProgessionListener that the operation started.
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.
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.
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).
protected fun progression_listeners=(progression_listeners: SimpleCollection[ProgressionListener])

progression :: Trackable :: progression_listeners=

Listen to the progression of the operation.
fun serialization_hash: Int

core :: Object :: serialization_hash

Hash value use for serialization
intern fun sys: Sys

core :: Object :: sys

Return the global sys object, the only instance of the Sys class.
abstract fun to_jvalue(env: JniEnv): JValue

core :: Object :: to_jvalue

fun to_s: String

core :: Object :: to_s

User readable representation of self.
package_diagram progression::Trackable Trackable core::Object Object progression::Trackable->core::Object neo4j::GraphStore GraphStore neo4j::GraphStore->progression::Trackable neo4j::Neo4jGraphStore Neo4jGraphStore neo4j::Neo4jGraphStore->neo4j::GraphStore neo4j::JsonGraphStore JsonGraphStore neo4j::JsonGraphStore->neo4j::GraphStore neo4j::Neo4jGraphStore... ... neo4j::Neo4jGraphStore...->neo4j::Neo4jGraphStore neo4j::JsonGraphStore... ... neo4j::JsonGraphStore...->neo4j::JsonGraphStore

Parents

interface Object

core :: Object

The root of the class hierarchy.

Children

abstract class GraphStore

neo4j :: GraphStore

A mean to save and load a Neo4j graph.

Descendants

class JsonGraphStore

neo4j :: JsonGraphStore

Save or load a graph using a JSON document.
class Neo4jGraphStore

neo4j :: Neo4jGraphStore

Save or load a graph using an actual Neo4j database.

Class definitions

progression $ Trackable
# An operation that is trackable using a `ProgressionListener`.
abstract class Trackable

	# Listen to the progression of the operation.
	var progression_listeners: SimpleCollection[ProgressionListener] =
			new Array[ProgressionListener]

	# Notice the registered `ProgessionListener` that the operation started.
	protected fun fire_started do
		for l in progression_listeners do
			l.started
			l.progressed(0)
		end
	end

	# Notice the registered `ProgessionListener` that the operation progressed.
	#
	# Parameter:
	#
	# * `done_part`: Indicates what is done.
	# * `total`: Indicates what need to be done, `done_part` included.
	protected fun fire_progressed(done_part: Int, total: Int) do
		for l in progression_listeners do
			l.progressed(done_part * l.progression_max / total)
		end
	end

	# Notice the registered `ProgessionListener` that the operation is done.
	protected fun fire_done do
		for l in progression_listeners do
			l.progressed(l.progression_max)
			l.done
		end
	end
end
lib/progression/progression.nit:14,1--48,3