A JsonStore can save and load json data from file system.

Introduced properties

fun clear

json :: JsonStore :: clear

Delete all stored data.
init defaultinit(store_dir: String)

json :: JsonStore :: defaultinit

fun has_collection(key: String): Bool

json :: JsonStore :: has_collection

Does key matches a collection?
fun has_key(key: String): Bool

json :: JsonStore :: has_key

Is there data are stored under key.
fun list_collection(key: String): JsonArray

json :: JsonStore :: list_collection

Get the list of keys stored under the collection key.
fun load_array(key: String): JsonArray

json :: JsonStore :: load_array

Load a JsonArray associated to key from store.
fun load_object(key: String): JsonObject

json :: JsonStore :: load_object

Load a JsonObject associated to key from store.
fun store_array(key: String, json: JsonArray)

json :: JsonStore :: store_array

Save json array under key.
fun store_dir: String

json :: JsonStore :: store_dir

Directory where data are stored.
protected fun store_dir=(store_dir: String)

json :: JsonStore :: store_dir=

Directory where data are stored.
fun store_object(key: String, json: JsonObject)

json :: JsonStore :: store_object

Save json object under key.

Redefined properties

redef type SELF: JsonStore

json $ JsonStore :: 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.
fun clear

json :: JsonStore :: clear

Delete all stored data.
init defaultinit(store_dir: String)

json :: JsonStore :: defaultinit

fun get_class: CLASS

core :: Object :: get_class

The meta-object representing the dynamic type of self.
fun has_collection(key: String): Bool

json :: JsonStore :: has_collection

Does key matches a collection?
fun has_key(key: String): Bool

json :: JsonStore :: has_key

Is there data are stored under key.
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.
fun list_collection(key: String): JsonArray

json :: JsonStore :: list_collection

Get the list of keys stored under the collection key.
fun load_array(key: String): JsonArray

json :: JsonStore :: load_array

Load a JsonArray associated to key from store.
fun load_object(key: String): JsonObject

json :: JsonStore :: load_object

Load a JsonObject associated to key from store.
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 serialization_hash: Int

core :: Object :: serialization_hash

Hash value use for serialization
fun store_array(key: String, json: JsonArray)

json :: JsonStore :: store_array

Save json array under key.
fun store_dir: String

json :: JsonStore :: store_dir

Directory where data are stored.
protected fun store_dir=(store_dir: String)

json :: JsonStore :: store_dir=

Directory where data are stored.
fun store_object(key: String, json: JsonObject)

json :: JsonStore :: store_object

Save json object under key.
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 json::JsonStore JsonStore core::Object Object json::JsonStore->core::Object

Parents

interface Object

core :: Object

The root of the class hierarchy.

Class definitions

json $ JsonStore
# A JsonStore can save and load json data from file system.
class JsonStore

	# Directory where data are stored.
	#
	# Directory is created lazilly at the first write.
	var store_dir: String

	# Delete all stored data.
	#
	# Warning: all `JsonStore` instances sharing the same `store_dir` will
	# be cleared.
	fun clear do
		if not store_dir.file_exists then return
		store_dir.rmdir
	end

	# Is there data are stored under `key`.
	fun has_key(key: String): Bool do
		return ("{store_dir}/{key}.json".simplify_path).file_exists
	end

	# Save `json` object under `key`.
	fun store_object(key: String, json: JsonObject) do
		store_json(key, json)
	end

	# Save `json` array under `key`.
	fun store_array(key: String, json: JsonArray) do
		store_json(key, json)
	end

	# Save `json` data under `key`.
	#
	# Only `JsonObject` and `JsonArray` are allowed in a json file.
	# Use `store_object` or `store_array` instead.
	private fun store_json(key: String, json: Serializable) do
		var path = "{store_dir}/{key}.json".simplify_path
		path.dirname.mkdir
		var file = new FileWriter.open(path)
		file.write(json.to_json)
		file.close
	end

	# Load a JsonObject associated to `key` from store.
	fun load_object(key: String): JsonObject do
		return load_json(key).as(JsonObject)
	end

	# Load a JsonArray associated to `key` from store.
	fun load_array(key: String): JsonArray do
		return load_json(key).as(JsonArray)
	end

	# Load a JsonObject associated to `key` from store.
	#
	# Ensure `has_data(key)`
	private fun load_json(key: String): nullable Serializable do
		assert has_key(key)
		var path = "{store_dir}/{key}.json".simplify_path
		var file = new FileReader.open(path)
		var text = file.read_all
		file.close
		return text.parse_json
	end

	# Get the list of keys stored under the collection `key`.
	fun list_collection(key: String): JsonArray do
		var res = new JsonArray
		var coll = ("{store_dir}/{key}".simplify_path).to_path
		if not coll.exists or not coll.stat.is_dir then return res
		for file in coll.files do
			if file.to_s.has_suffix(".json") then
				res.add(file.to_s.basename(".json"))
			end
		end
		return res
	end

	# Does `key` matches a collection?
	fun has_collection(key: String): Bool do
		var path = ("{store_dir}/{key}".simplify_path).to_path
		return path.exists and path.stat.is_dir
	end
end
lib/json/store.nit:95,1--179,3