A free text search command

Introduced properties

private var _query: nullable String

nitc :: CmdSearch :: _query

Free text command string

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

nitc :: CmdSearch :: defaultinit

fun query: nullable String

nitc :: CmdSearch :: query

Free text command string

fun query=(query: nullable String)

nitc :: CmdSearch :: query=

Free text command string

Redefined properties

redef type SELF: CmdSearch

nitc $ CmdSearch :: SELF

Type of this instance, automatically specialized in every class

redef fun execute(no_color: nullable Bool)

nitc :: term $ CmdSearch :: execute

redef fun http_init(req: HttpRequest): CmdMessage

nitc :: commands_http $ CmdSearch :: http_init

Init the command from an HTTPRequest

redef fun init_results: CmdMessage

nitc $ CmdSearch :: init_results

Return states:

redef fun parser_init(mentity_name: String, options: CmdOptions): CmdMessage

nitc :: commands_parser $ CmdSearch :: 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 _limit: nullable Int

nitc :: CmdList :: _limit

Limit the items in the list

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 _query: nullable String

nitc :: CmdSearch :: _query

Free text command string

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)

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

core :: Object :: defaultinit

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

nitc :: CmdSearch :: 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 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 query: nullable String

nitc :: CmdSearch :: query

Free text command string

fun query=(query: nullable String)

nitc :: CmdSearch :: query=

Free text command string

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.

Ancestors

abstract class CmdList

nitc :: CmdList

A command that returns a list of results

abstract class DocCommand

nitc :: DocCommand

Documentation command

interface Object

The root of the class hierarchy.

Parents

abstract class CmdEntities

nitc :: CmdEntities

A list of mentities

Children

class CmdCatalogSearch

nitc :: CmdCatalogSearch

A CmdSearch command using a Catalog

Class definitions

nitc $ CmdSearch

# A free text search command
class CmdSearch
	super CmdEntities

	# Free text command string
	var query: nullable String = null is optional, writable

	# Return states:
	# * `CmdSuccess`: everything was ok;
	# * `ErrorNoQuery`: no `query` provided.
	redef fun init_results do
		if results != null then return new CmdSuccess

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

		var query = self.query
		if query == null then return new ErrorNoQuery
		sorter = null
		results = model.find(query)
		return res
	end
end

src/doc/commands/commands_model.nit:259,1--281,3

nitc :: commands_parser $ CmdSearch

redef class CmdSearch
	redef fun parser_init(mentity_name, options) do
		query = mentity_name
		return super
	end
end

src/doc/commands/commands_parser.nit:333,1--338,3

nitc :: commands_http $ CmdSearch

redef class CmdSearch
	redef fun http_init(req) do
		query = req.string_arg("q")
		return super
	end
end

src/doc/commands/commands_http.nit:152,1--157,3

nitc :: term $ CmdSearch

redef class CmdSearch
	redef fun execute(no_color) do
		print_list("Search results for `{query.as(not null)}`:", results, no_color)
	end
end

src/doc/term/term.nit:190,1--194,3