class IndexMatch

nitc :: IndexMatch

An MEntity matched from a ModelIndex

Each match has a score. The score should be seen as the distance of the match from the query. In other words, the lowest is the score, the more relevant is the match.

Introduced properties

private var _mentity: MEntity

nitc :: IndexMatch :: _mentity

MEntity matches
private var _score: Int

nitc :: IndexMatch :: _score

Score allocated by the search method
init defaultinit(mentity: MEntity, score: Int)

nitc :: IndexMatch :: defaultinit

fun mentity: MEntity

nitc :: IndexMatch :: mentity

MEntity matches
protected fun mentity=(mentity: MEntity)

nitc :: IndexMatch :: mentity=

MEntity matches
fun score: Int

nitc :: IndexMatch :: score

Score allocated by the search method
fun score=(score: Int)

nitc :: IndexMatch :: score=

Score allocated by the search method

Redefined properties

redef fun <=>(o: OTHER): Int

nitc $ IndexMatch :: <=>

By default matches are compared only on their score
redef type OTHER: IndexMatch

nitc $ IndexMatch :: OTHER

What self can be compared to?
redef type SELF: IndexMatch

nitc $ IndexMatch :: SELF

Type of this instance, automatically specialized in every class
redef fun to_s: String

nitc $ IndexMatch :: to_s

User readable representation of self.

All properties

fun !=(other: nullable Object): Bool

core :: Object :: !=

Have self and other different values?
abstract fun <(other: OTHER): Bool

core :: Comparable :: <

Is self lesser than other?
fun <=(other: OTHER): Bool

core :: Comparable :: <=

not other < self
fun <=>(other: OTHER): Int

core :: Comparable :: <=>

-1 if <, +1 if > and 0 otherwise
fun ==(other: nullable Object): Bool

core :: Object :: ==

Have self and other the same value?
fun >(other: OTHER): Bool

core :: Comparable :: >

other < self
fun >=(other: OTHER): Bool

core :: Comparable :: >=

not self < other
type CLASS: Class[SELF]

core :: Object :: CLASS

The type of the class of self.
type OTHER: Comparable

core :: Comparable :: OTHER

What self can be compared to?
type SELF: Object

core :: Object :: SELF

Type of this instance, automatically specialized in every class
private var _mentity: MEntity

nitc :: IndexMatch :: _mentity

MEntity matches
private var _score: Int

nitc :: IndexMatch :: _score

Score allocated by the search method
fun clamp(min: OTHER, max: OTHER): OTHER

core :: Comparable :: clamp

Constraint self within [min..max]
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.
init defaultinit(mentity: MEntity, score: Int)

nitc :: IndexMatch :: defaultinit

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".
fun is_between(c: OTHER, d: OTHER): Bool

core :: Comparable :: is_between

c <= self <= d
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 max(other: OTHER): OTHER

core :: Comparable :: max

The maximum between self and other (prefers self if equals).
fun mentity: MEntity

nitc :: IndexMatch :: mentity

MEntity matches
protected fun mentity=(mentity: MEntity)

nitc :: IndexMatch :: mentity=

MEntity matches
fun min(c: OTHER): OTHER

core :: Comparable :: min

The minimum between self and c (prefer self if equals)
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 score: Int

nitc :: IndexMatch :: score

Score allocated by the search method
fun score=(score: Int)

nitc :: IndexMatch :: score=

Score allocated by the search method
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 nitc::IndexMatch IndexMatch core::Comparable Comparable nitc::IndexMatch->core::Comparable core::Object Object core::Comparable->core::Object ...core::Object ... ...core::Object->core::Object

Ancestors

interface Object

core :: Object

The root of the class hierarchy.

Parents

interface Comparable

core :: Comparable

The ancestor of class where objects are in a total order.

Class definitions

nitc $ IndexMatch 
# An MEntity matched from a ModelIndex
#
# Each match has a `score`. The score should be seen as the distance of
# the match from the query. In other words, the lowest is the score, the more
# relevant is the match.
class IndexMatch
	super Comparable

	redef type OTHER: IndexMatch

	# MEntity matches
	var mentity: MEntity

	# Score allocated by the search method
	#
	# A lowest score means a more relevant match.
	#
	# Scores values are arbitrary, the meaning of `10` vs `2000` really depends
	# on the search method producing the match and the comparators used to sort
	# the matches.
	# The only universal rule is: low score = relevance.
	var score: Int is writable

	# By default matches are compared only on their score
	redef fun <=>(o) do return score <=> o.score

	redef fun to_s do return "{mentity} ({score})"
end
src/model/model_index.nit:522,1--549,3
Nit tools. Version v0.8-3595-g3f58b4f.