OpenSim::Data::SQLite::SQLiteInventoryStore

OpenSim::Data::SQLite::SQLiteInventoryStore Class Reference

An Inventory Interface to the SQLite database. More...

Inheritance diagram for OpenSim::Data::SQLite::SQLiteInventoryStore:

OpenSim::Data::SQLite::SQLiteUtil OpenSim::Framework::IInventoryDataPlugin OpenSim::Framework::IPlugin List of all members.

Public Member Functions

void Initialise ()
 Default-initialises the plugin.
void Initialise (string dbconnect)
 
  • Initialises Inventory interface
  • Loads and initialises a new SQLite connection and maintains it.
  • use default URI if connect string string is empty.

void Dispose ()
 Closes the inventory interface.
InventoryItemBase buildItem (DataRow row)
void Shutdown ()
 TODO : DataSet commit.
List< InventoryItemBase > getInventoryInFolder (UUID folderID)
 Returns a list of inventory items contained within the specified folder.
List< InventoryFolderBase > getUserRootFolders (UUID user)
 Returns a list of the root folders within a users inventory.
InventoryFolderBase getUserRootFolder (UUID user)
 Returns the users inventory root folder.
List< InventoryFolderBase > getInventoryFolders (UUID parentID)
 Returns a list of inventory folders contained in the folder 'parentID'.
List< InventoryFolderBase > getFolderHierarchy (UUID parentID)
 See IInventoryDataPlugin.
InventoryItemBase getInventoryItem (UUID item)
 Returns an inventory item by its UUID.
InventoryFolderBase getInventoryFolder (UUID folder)
 Returns a specified inventory folder by its UUID.
void addInventoryItem (InventoryItemBase item)
 Creates a new inventory item based on item.
void updateInventoryItem (InventoryItemBase item)
 Updates an inventory item with item (updates based on ID).
void deleteInventoryItem (UUID itemID)
 Delete an inventory item.
void addInventoryFolder (InventoryFolderBase folder)
 Adds a new folder specified by folder.
void updateInventoryFolder (InventoryFolderBase folder)
 Updates a folder based on its ID with folder.
void moveInventoryFolder (InventoryFolderBase folder)
 Moves a folder based on its ID with folder.
void deleteInventoryFolder (UUID folderID)
 Delete a folder.
List< InventoryItemBase > fetchActiveGestures (UUID avatarID)
 Returns all activated gesture-items in the inventory of the specified avatar.

Protected Member Functions

void getInventoryFolders (ref List< InventoryFolderBase > folders, UUID parentID)
 Append a list of all the child folders of a parent folder.

Properties

string Name [get]
 The name of this DB provider.
string Version [get]
 Returns the version of this DB provider.

Detailed Description

An Inventory Interface to the SQLite database.

Member Function Documentation

void OpenSim::Data::SQLite::SQLiteInventoryStore::Initialise (  )  [inline]

Default-initialises the plugin.

Implements OpenSim::Framework::IPlugin.

void OpenSim::Data::SQLite::SQLiteInventoryStore::Initialise ( string  dbconnect  )  [inline]

Parameters:
dbconnect connect string

Implements OpenSim::Framework::IInventoryDataPlugin.

void OpenSim::Data::SQLite::SQLiteInventoryStore::Dispose (  )  [inline]

Closes the inventory interface.

InventoryItemBase OpenSim::Data::SQLite::SQLiteInventoryStore::buildItem ( DataRow  row  )  [inline]

Parameters:
row 
Returns:

void OpenSim::Data::SQLite::SQLiteInventoryStore::Shutdown (  )  [inline]

TODO : DataSet commit.

List<InventoryItemBase> OpenSim::Data::SQLite::SQLiteInventoryStore::getInventoryInFolder ( UUID  folderID  )  [inline]

Returns a list of inventory items contained within the specified folder.

Parameters:
folderID The UUID of the target folder
Returns:
A List of InventoryItemBase items

Implements OpenSim::Framework::IInventoryDataPlugin.

List<InventoryFolderBase> OpenSim::Data::SQLite::SQLiteInventoryStore::getUserRootFolders ( UUID  user  )  [inline]

Returns a list of the root folders within a users inventory.

Parameters:
user The user whos inventory is to be searched
Returns:
A list of folder objects

Implements OpenSim::Framework::IInventoryDataPlugin.

InventoryFolderBase OpenSim::Data::SQLite::SQLiteInventoryStore::getUserRootFolder ( UUID  user  )  [inline]

Returns the users inventory root folder.

Parameters:
user The UUID of the user who is having inventory being returned
Returns:
Root inventory folder, null if no root inventory folder was found

Implements OpenSim::Framework::IInventoryDataPlugin.

void OpenSim::Data::SQLite::SQLiteInventoryStore::getInventoryFolders ( ref List< InventoryFolderBase >  folders,
UUID  parentID 
) [inline, protected]

Append a list of all the child folders of a parent folder.

Parameters:
folders list where folders will be appended
parentID ID of parent

List<InventoryFolderBase> OpenSim::Data::SQLite::SQLiteInventoryStore::getInventoryFolders ( UUID  parentID  )  [inline]

Returns a list of inventory folders contained in the folder 'parentID'.

Parameters:
parentID The folder to get subfolders for
Returns:
A list of inventory folders

Implements OpenSim::Framework::IInventoryDataPlugin.

List<InventoryFolderBase> OpenSim::Data::SQLite::SQLiteInventoryStore::getFolderHierarchy ( UUID  parentID  )  [inline]

See IInventoryDataPlugin.

Parameters:
parentID 
Returns:

Implements OpenSim::Framework::IInventoryDataPlugin.

InventoryItemBase OpenSim::Data::SQLite::SQLiteInventoryStore::getInventoryItem ( UUID  item  )  [inline]

Returns an inventory item by its UUID.

Parameters:
item The UUID of the item to be returned
Returns:
A class containing item information

Implements OpenSim::Framework::IInventoryDataPlugin.

InventoryFolderBase OpenSim::Data::SQLite::SQLiteInventoryStore::getInventoryFolder ( UUID  folder  )  [inline]

Returns a specified inventory folder by its UUID.

Parameters:
folder The UUID of the folder to be returned
Returns:
A class containing folder information

Implements OpenSim::Framework::IInventoryDataPlugin.

void OpenSim::Data::SQLite::SQLiteInventoryStore::addInventoryItem ( InventoryItemBase  item  )  [inline]

Creates a new inventory item based on item.

Parameters:
item The item to be created

Implements OpenSim::Framework::IInventoryDataPlugin.

void OpenSim::Data::SQLite::SQLiteInventoryStore::updateInventoryItem ( InventoryItemBase  item  )  [inline]

Updates an inventory item with item (updates based on ID).

Parameters:
item The updated item

Implements OpenSim::Framework::IInventoryDataPlugin.

void OpenSim::Data::SQLite::SQLiteInventoryStore::deleteInventoryItem ( UUID  itemID  )  [inline]

Delete an inventory item.

Parameters:
item The item UUID

Implements OpenSim::Framework::IInventoryDataPlugin.

void OpenSim::Data::SQLite::SQLiteInventoryStore::addInventoryFolder ( InventoryFolderBase  folder  )  [inline]

Adds a new folder specified by folder.

Parameters:
folder The inventory folder

Implements OpenSim::Framework::IInventoryDataPlugin.

void OpenSim::Data::SQLite::SQLiteInventoryStore::updateInventoryFolder ( InventoryFolderBase  folder  )  [inline]

Updates a folder based on its ID with folder.

Parameters:
folder The inventory folder

Implements OpenSim::Framework::IInventoryDataPlugin.

void OpenSim::Data::SQLite::SQLiteInventoryStore::moveInventoryFolder ( InventoryFolderBase  folder  )  [inline]

Moves a folder based on its ID with folder.

Parameters:
folder The inventory folder

Implements OpenSim::Framework::IInventoryDataPlugin.

void OpenSim::Data::SQLite::SQLiteInventoryStore::deleteInventoryFolder ( UUID  folderID  )  [inline]

Delete a folder.

This will clean-up any child folders and child items as well

Parameters:
folderID the folder UUID

Implements OpenSim::Framework::IInventoryDataPlugin.

List<InventoryItemBase> OpenSim::Data::SQLite::SQLiteInventoryStore::fetchActiveGestures ( UUID  avatarID  )  [inline]

Returns all activated gesture-items in the inventory of the specified avatar.

Parameters:
avatarID The UUID of the avatar
Returns:
The list of gestures (InventoryItemBases)

Implements OpenSim::Framework::IInventoryDataPlugin.

Property Documentation

string OpenSim::Data::SQLite::SQLiteInventoryStore::Name [get]

The name of this DB provider.

Returns:
Name of DB provider

Implements OpenSim::Framework::IPlugin.

string OpenSim::Data::SQLite::SQLiteInventoryStore::Version [get]

Returns the version of this DB provider.

Returns:
A string containing the DB provider version

Implements OpenSim::Framework::IPlugin.

The documentation for this class was generated from the following file:
Generated on Tue Jan 6 01:00:47 2009 for OpenSim by  doxygen 1.5.1