class CmdModelEntities

nitc :: CmdModelEntities

A command that returns a list of all mentities in a model

Introduced properties

private var _kind: String

nitc :: CmdModelEntities :: _kind

Kind of mentities to be returned.
private var _limit: nullable Int

nitc :: CmdModelEntities :: _limit

Default limit is 10
init defaultinit(model: Model, filter: nullable ModelFilter, limit: nullable Int, page: nullable Int, count: nullable Int, max: nullable Int, kind: nullable String)

nitc :: CmdModelEntities :: defaultinit

fun kind: String

nitc :: CmdModelEntities :: kind

Kind of mentities to be returned.
fun kind=(kind: nullable String)

nitc :: CmdModelEntities :: kind=

Kind of mentities to be returned.

Redefined properties

redef type SELF: CmdModelEntities

nitc $ CmdModelEntities :: SELF

Type of this instance, automatically specialized in every class
redef fun execute(no_color: nullable Bool)

nitc :: term $ CmdModelEntities :: execute

redef fun http_init(req: HttpRequest): CmdMessage

nitc :: commands_http $ CmdModelEntities :: http_init

Init the command from an HTTPRequest
redef fun init_results: CmdMessage

nitc $ CmdModelEntities :: init_results

Initialize the results list
redef fun limit: nullable Int

nitc $ CmdModelEntities :: limit

Default limit is 10
redef fun limit=(limit: nullable Int)

nitc $ CmdModelEntities :: limit=

Default limit is 10
redef fun parser_init(kind: String, options: CmdOptions): CmdMessage

nitc :: commands_parser $ CmdModelEntities :: parser_init

Initialize the command from the CommandParser data

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 ITEM: Object

nitc :: CmdList :: ITEM

Type of result
type SELF: Object

core :: Object :: SELF

Type of this instance, automatically specialized in every class
private var _count: nullable Int

nitc :: CmdList :: _count

Total number of ret
private var _filter: nullable ModelFilter

nitc :: DocCommand :: _filter

ModelFilter to apply if any
private var _kind: String

nitc :: CmdModelEntities :: _kind

Kind of mentities to be returned.
private var _limit: nullable Int

nitc :: CmdList :: _limit

Limit the items in the list
private var _limit: nullable Int

nitc :: CmdModelEntities :: _limit

Default limit is 10
private var _max: nullable Int

nitc :: CmdList :: _max

Total number of pages
private var _model: Model

nitc :: DocCommand :: _model

Model to retrieve data for
private var _page: nullable Int

nitc :: CmdList :: _page

Page to display
private var _results: nullable Array[ITEM]

nitc :: CmdList :: _results

Items in the list
private var _sorter: nullable Comparator

nitc :: CmdEntities :: _sorter

private var _sorter: nullable Comparator

nitc :: CmdList :: _sorter

Comparator used to sort the list
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 cmd_filter: ModelFilter

nitc :: DocCommand :: cmd_filter

Return a new filter for that command execution.
fun count: nullable Int

nitc :: CmdList :: count

Total number of ret
fun count=(count: nullable Int)

nitc :: CmdList :: count=

Total number of ret
init defaultinit(model: Model, filter: nullable ModelFilter, limit: nullable Int, page: nullable Int, count: nullable Int, max: nullable Int, kind: nullable String)

nitc :: CmdModelEntities :: defaultinit

init defaultinit(model: Model, filter: nullable ModelFilter, limit: nullable Int, page: nullable Int, count: nullable Int, max: nullable Int)

nitc :: CmdEntities :: defaultinit

init defaultinit(model: Model, filter: nullable ModelFilter, limit: nullable Int, page: nullable Int, count: nullable Int, max: nullable Int)

nitc :: CmdList :: defaultinit

init defaultinit(model: Model, filter: nullable ModelFilter)

nitc :: DocCommand :: defaultinit

abstract fun execute(no_color: nullable Bool)

nitc :: DocCommand :: execute

fun filter: nullable ModelFilter

nitc :: DocCommand :: filter

ModelFilter to apply if any
protected fun filter=(filter: nullable ModelFilter)

nitc :: DocCommand :: filter=

ModelFilter to apply if any
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 http_init(req: HttpRequest): CmdMessage

nitc :: DocCommand :: http_init

Init the command from an HTTPRequest
init init

core :: Object :: init

fun init_command: CmdMessage

nitc :: DocCommand :: init_command

Initialize the command
fun init_results: CmdMessage

nitc :: CmdList :: init_results

Initialize the results list
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 kind: String

nitc :: CmdModelEntities :: kind

Kind of mentities to be returned.
fun kind=(kind: nullable String)

nitc :: CmdModelEntities :: kind=

Kind of mentities to be returned.
fun limit: nullable Int

nitc :: CmdList :: limit

Limit the items in the list
fun limit=(limit: nullable Int)

nitc :: CmdList :: limit=

Limit the items in the list
fun max: nullable Int

nitc :: CmdList :: max

Total number of pages
fun max=(max: nullable Int)

nitc :: CmdList :: max=

Total number of pages
fun model: Model

nitc :: DocCommand :: model

Model to retrieve data for
protected fun model=(model: Model)

nitc :: DocCommand :: model=

Model to retrieve data for
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 page: nullable Int

nitc :: CmdList :: page

Page to display
fun page=(page: nullable Int)

nitc :: CmdList :: page=

Page to display
fun paginate

nitc :: CmdList :: paginate

Paginate the results
fun parser_init(arg: String, options: CmdOptions): CmdMessage

nitc :: DocCommand :: parser_init

Initialize the command from the CommandParser data
fun print_list(list_title: nullable String, list_items: nullable Array[MEntity], no_color: nullable Bool)

nitc :: CmdList :: print_list

fun results: nullable Array[ITEM]

nitc :: CmdList :: results

Items in the list
fun results=(results: nullable Array[ITEM])

nitc :: CmdList :: results=

Items in the list
fun serialization_hash: Int

core :: Object :: serialization_hash

Hash value use for serialization
fun sort

nitc :: CmdList :: sort

Sort mentities with sorter
fun sorter: nullable Comparator

nitc :: CmdList :: sorter

Comparator used to sort the list
fun sorter=(sorter: nullable Comparator)

nitc :: CmdList :: sorter=

Comparator used to sort the list
intern fun sys: Sys

core :: Object :: sys

Return the global sys object, the only instance of the Sys class.
fun to_html: Writable

nitc :: DocCommand :: to_html

Render results as a HTML string
abstract fun to_json: nullable Serializable

nitc :: DocCommand :: to_json

Return a JSON Serializable representation of self results
abstract fun to_jvalue(env: JniEnv): JValue

core :: Object :: to_jvalue

fun to_md: Writable

nitc :: DocCommand :: to_md

Render results as a Markdown string
fun to_s: String

core :: Object :: to_s

User readable representation of self.
package_diagram nitc::CmdModelEntities CmdModelEntities nitc::CmdEntities CmdEntities nitc::CmdModelEntities->nitc::CmdEntities nitc::CmdList CmdList nitc::CmdEntities->nitc::CmdList ...nitc::CmdList ... ...nitc::CmdList->nitc::CmdList nitc::CmdRandomEntities CmdRandomEntities nitc::CmdRandomEntities->nitc::CmdModelEntities

Ancestors

abstract class CmdList

nitc :: CmdList

A command that returns a list of results
abstract class DocCommand

nitc :: DocCommand

Documentation command
interface Object

core :: Object

The root of the class hierarchy.

Parents

abstract class CmdEntities

nitc :: CmdEntities

A list of mentities

Children

class CmdRandomEntities

nitc :: CmdRandomEntities

A command that returns a random list of mentities from a model

Class definitions

nitc $ CmdModelEntities 
# A command that returns a list of all mentities in a model
class CmdModelEntities
	super CmdEntities

	# Kind of mentities to be returned.
	#
	# Value must be one of "packages", "groups", "modules", "classes", "classdefs",
	# "properties", "propdefs" or "all".
	#
	# Default is "all".
	var kind = "all" is optional, writable

	# Default limit is `10`
	redef var limit = 10

	redef fun init_results do
		if results != null then return new CmdSuccess

		var res = super
		if not res isa CmdSuccess then return res

		var mentities = new Array[MEntity]
		if kind == "packages" then
			mentities = model.collect_mpackages(filter).to_a
		else if kind == "groups" then
			mentities = model.collect_mgroups(filter).to_a
		else if kind == "modules" then
			mentities = model.collect_mmodules(filter).to_a
		else if kind == "classes" then
			mentities = model.collect_mclasses(filter).to_a
		else if kind == "classdefs" then
			mentities = model.collect_mclassdefs(filter).to_a
		else if kind == "properties" then
			mentities = model.collect_mproperties(filter).to_a
		else if kind == "propdefs" then
			mentities = model.collect_mpropdefs(filter).to_a
		else
			mentities = model.collect_mentities(filter).to_a
		end
		results = mentities
		return res
	end
end
src/doc/commands/commands_model.nit:483,1--525,3

nitc :: commands_parser $ CmdModelEntities 
redef class CmdModelEntities
	redef fun parser_init(kind, options) do
		self.kind = kind
		return super
	end
end
src/doc/commands/commands_parser.nit:356,1--361,3

nitc :: commands_http $ CmdModelEntities 
redef class CmdModelEntities
	redef fun http_init(req) do
		var opt_kind = req.string_arg("kind")
		if opt_kind != null then kind = opt_kind
		return super
	end
end
src/doc/commands/commands_http.nit:159,1--165,3

nitc :: term $ CmdModelEntities 
redef class CmdModelEntities
	redef fun execute(no_color) do
		var kind = self.kind
		if no_color != null and not no_color then kind = kind.blue
		print_list("MEntities for kind `{kind}`:", results, no_color)
	end
end
src/doc/term/term.nit:196,1--202,3
Nit tools. Version .