Class SimpleZDB::DataBase
In: simplezdb.cpp
Parent: Object

Wrapper of SlZDataBase class.

Usage

  require 'simpleZDB'
  include SimpleZDB
  db = DataBase.new(DataBase::ADDRESSBOOK)
  # ... typically use sort or filter method here ...
  db.each do |card|
     #  write "break if ..." in order to abort the loop
     puts card.card_id
     puts card['FULL']
  end
  db.close

Otherwise, 

  require 'simpleZDB'
  include SimpleZDB
  DataBase.open(DataBase::ADDRESSBOOK) do |db|
    # ...
  end

Methods

cancel_edit_card   close   closed?   delete_card   disable_filter   each   enable_filter   filter   filtered?   find_item_info   finish_edit_card   inspect_fields   is_closed   is_filtered   is_opened   kill_idx_resume   length   new   open   open   opened?   read_categories   read_item   read_time_field   search_cond   search_field   size   sort!   sort_exp!   start_edit_card   unfilter   update_categories   write_item   write_time_field  

Included Modules

Enumerable

Attributes

class_of_card  [RW] 
item_info  [R] 

Public Class methods

DataBase.new(database_type, is_readonly = false, class_of_card = SimpleZDB::Card, filename = nil) → database

Document-method: SimpleZDB::DataBase#initialize

Open the database and return the DataBase object. Possible values of database_type are: 

  DataBase::ADDRESSBOOK
  DataBase::TODOLIST
  DataBase::DATEBOOK
  DataBase::MAIL_INBOX
  DataBase::MAIL_OUTBOX
  DataBase::MEMO

The third argument, class_of_card is used by DataBase#each method in order to create an object as the block argument. Normally it is SimpleZDB::Card or its subclass. This class is expected that it has a constructor called with two arguments, database and card_id.

database.open(is_readonly) → true or false

Open the database (again). Notice: when DataBase instance is created, database is already opened.

Public Instance methods

database.cancel_edit_card → true or false

(Normally not used directly. Called from Card.) Cancel editing the card.

database.delete_card → true or false

(Normally not used directly. Called from Card.) Delete the card.

database.disable_filter(is_idx_delete) → true or false

Wrapper of SlZDataManager::disableFilter(bool)

database.each {|card| ... } → database

Document-method: SimpleZDB::DataBase#each

the class of the block argument is determined by the instance variable @class_of_card, which can be accessed by database.class_of_card method. Normally it is SimpleZDB::Card.

database.enable_filter(category_id) → true or false

Wrapper of SlZDataManager::enableFilter(CategoryId).

database.filter(search_exp, sort_exp, filter_mode, is_suspend_index = false) → true or false

Wrapper of SlZDataManager::filter(const char*, ulong, const char*, ulong, FilterFor, bool = false). search_exp and sort_exp are undocumented. Possible filter_mode values are: 

  DataBase::FOR_CURRENT_INDEX
  DataBase::FOR_MASTER_INDEX
  DataBase::FOR_SUSPENDED_INDEX
database.is_filtered → true or false
database.filtered? → true or false

Document-method: is_filtered, filtered?

Wrapper of SlZDataManager::isFiltered().

database.finish_edit_card(card_id) → fixnum or false

(Normally not used directly. Called from Card.) Finish editing the card. You should call this after writing items. Return the new card_id.

database.is_filtered → true or false
database.filtered? → true or false

Document-method: is_filtered, filtered?

Wrapper of SlZDataManager::isFiltered().

database.is_opened() → true or false
database.opened?() → true or false

Document-method: is_opened, opened?

Ask if the database is opened.

database.kill_idx_resume → database

Wrapper of SlZDataManager::killIdxResume().

database.open(is_readonly) → true or false

Open the database (again). Notice: when DataBase instance is created, database is already opened.

database.is_opened() → true or false
database.opened?() → true or false

Document-method: is_opened, opened?

Ask if the database is opened.

database.read_categories(card_id) → array

(Normally not used directly. Called from DataBase#read_item.) Return the categories of the card card_id.

database.read_item(key, card_id) → object

(Normally not used directly. Called from Card#[]) Return the value specified by key of the card card_id.

database.read_time_field(field, card_id) → datetime or date

(Normally not used directly. Called from DataBase#read_item.) Return the date/time value specified by the field (i.e., return value of ItemInfo#field(name)) of the card card_id.

database.search_cond(cond, is_next, attr_mask, attr_cond, attr_flag, idx_name = nil) → card or nil
database.search_cond(cond, is_next, idx_name = nil) → card or nil

Wrapper of SlZDataManager::search(CardId*, const char*, bool, uchar, uchar, uchar, const char*) and SlZDataManager::search(CardId*, const char*, bool, const char*). The format of cond is undocumented.

database.search_field(str, field, search_mode, is_next = true) → card or nil

Wrapper of SlZDataBase::searchField(CardId*, QString, int, uchar, bool). Valid search_mode values are undocumented.

database.sort!(key = nil, is_ascendent = true) → database

Sort cards by key. This method affects the result of each. If key is invalid, do nothing. If key is nil, sort by the default index. If key responds to to_exp, call implicitly sort_exp!(key.to_exp). (see SimpleZDB::SortKey class). Otherwise, sort by the named key. Throw RuntimeError when sort failed.

database.sort_exp!(exp, is_ascendent = true) → database

Wrapper of SlZDataManager::sort(const char*, int, bool). The format of exp is undocumented. If failed, raise runtime error.

database.start_edit_card(card_id) → true or false

(Normally not used directly. Called from Card.) Start editing the card. You should call this before writing items.

database.unfilter(is_resume_index = true) → true or false

Wrapper of SlZDataManager::unfilter(bool = true). If failed, raise runtime error.

database.upcate_categories(card_id, categories) → true or false

(Normally not used directly. Called from Card.) Update the categories off the current card. If any one of the categories does not exist in the CategorySet, add it.

database.write_item(key, val) → true or false

(Normally not used directly. Called from Card#save.) Write the value specified by the key of the current card.

database.write_time_field(field, val) → true or false

(Normally not used directly. Called from DataBase#write_item) Write the date/time value specified by the field (i.e., return value of the ItemInfo#field(key)) of the current card.

[Validate]