com.planet_ink.coffee_mud.core.database
Class DBInterface

java.lang.Object
  com.planet_ink.coffee_mud.core.database.DBInterface

All Implemented Interfaces:

CMObject, CMLibrary, DatabaseEngine, java.lang.Cloneable, java.lang.Comparable<CMObject>

public class DBInterface
extends java.lang.Object
implements DatabaseEngine

Nested Class Summary

Nested classes/interfaces inherited from interface com.planet_ink.coffee_mud.Libraries.interfaces.DatabaseEngine

DatabaseEngine.PlayerData

Constructor Summary

DBInterface(DBConnector DB)

Method Summary

boolean	activate()
int	compareTo(CMObject o)
CMObject	copyOf() Similar to Cloneable.clone(), but does its best to make sure that any internal objects to this class are also copyOfed.
void	DBClanFill(java.lang.String clan, java.util.Vector members, java.util.Vector roles, java.util.Vector lastDates)
int	DBCountData(java.lang.String playerID, java.lang.String section)
int	DBCountJournal(java.lang.String Journal, java.lang.String from, java.lang.String to)
void	DBCreateAbility(java.lang.String classID, java.lang.String data)
void	DBCreateArea(Area A)
void	DBCreateCharacter(MOB mob)
void	DBCreateClan(Clan C)
void	DBCreateClass(java.lang.String classID, java.lang.String data)
void	DBCreateData(java.lang.String player, java.lang.String section, java.lang.String key, java.lang.String data)
void	DBCreatePoll(java.lang.String name, java.lang.String player, java.lang.String subject, java.lang.String description, java.lang.String optionXML, int flag, java.lang.String qualZapper, java.lang.String results, long expiration)
void	DBCreateRace(java.lang.String raceID, java.lang.String data)
void	DBCreateRoom(Room room)
void	DBCreateStat(long startTime, long endTime, java.lang.String data)
void	DBCreateThisItem(java.lang.String roomID, Item thisItem)
void	DBCreateThisMOB(java.lang.String roomID, MOB thisMOB)
void	DBCreateVFSFile(java.lang.String filename, int bits, java.lang.String creator, java.lang.Object data)
void	DBDeleteAbility(java.lang.String classID)
void	DBDeleteArea(Area A)
void	DBDeleteClan(Clan C)
void	DBDeleteClass(java.lang.String classID)
void	DBDeleteData(java.lang.String section)
void	DBDeleteData(java.lang.String playerID, java.lang.String section)
void	DBDeleteData(java.lang.String playerID, java.lang.String section, java.lang.String key)
void	DBDeleteItem(java.lang.String roomID, Item item)
void	DBDeleteJournal(java.lang.String oldkey)
void	DBDeleteJournal(java.lang.String Journal, int which)
void	DBDeleteMOB(MOB mob)
void	DBDeleteMOB(java.lang.String roomID, MOB mob)
void	DBDeletePlayerData(java.lang.String name)
void	DBDeletePlayerJournals(java.lang.String name)
void	DBDeletePoll(java.lang.String name)
void	DBDeleteRace(java.lang.String raceID)
void	DBDeleteRoom(Room room)
void	DBDeleteStat(long startTime)
void	DBDeleteVFSFile(java.lang.String filename)
java.lang.String	DBEmailSearch(java.lang.String email)
java.lang.String[]	DBFetchEmailData(java.lang.String name)
java.lang.String	DBGetRealJournalName(java.lang.String possibleName)
java.util.Vector	DBReadAbilities()
void	DBReadAllClans()
java.util.Vector	DBReadAllPlayerData(java.lang.String playerID)
void	DBReadAllRooms(RoomnumberSet roomsToRead)
java.util.Vector	DBReadAreaData(java.lang.String areaID, boolean reportStatus)
RoomnumberSet	DBReadAreaRoomList(java.lang.String areaName, boolean reportStatus)
void	DBReadArtifacts()
void	DBReadCatalogs()
java.util.Vector	DBReadClasses()
void	DBReadContent(Room thisRoom, java.util.Vector rooms)
java.util.Vector	DBReadData(java.lang.String section)
java.util.Vector	DBReadData(java.lang.String playerID, java.lang.String section)
java.util.Vector	DBReadData(java.lang.String playerID, java.lang.String section, java.lang.String key)
java.util.Vector	DBReadData(java.lang.String player, java.util.Vector sections)
java.util.Vector	DBReadDataKey(java.lang.String key)
java.util.Vector	DBReadDataKey(java.lang.String section, java.lang.String keyMask)
void	DBReadFollowers(MOB mob, boolean bringToLife)
java.util.Vector	DBReadJournalMsgs(java.lang.String Journal)
java.util.Vector	DBReadJournals()
long	DBReadNewJournalDate(java.lang.String Journal, java.lang.String name)
void	DBReadPlayer(MOB mob)
java.util.Vector	DBReadPoll(java.lang.String name)
java.util.Vector	DBReadPollList()
void	DBReadQuests(MudHost myHost)
java.util.Vector	DBReadRaces()
java.util.Vector	DBReadRoomData(java.lang.String roomID, boolean reportStatus)
java.lang.String	DBReadRoomDesc(java.lang.String roomID)
void	DBReadRoomExits(java.lang.String roomID, java.util.Vector allRooms, boolean reportStatus)
java.lang.String	DBReadRoomMOBData(java.lang.String roomID, java.lang.String mobID)
java.lang.Object	DBReadStat(long startTime)
java.util.Vector	DBReadStats(long startTime)
boolean	DBReadUserOnly(MOB mob)
java.util.Vector	DBReadVFSDirectory()
CMFile.CMVFSFile	DBReadVFSFile(java.lang.String filename)
void	DBReCreate(Room room, java.lang.String oldID)
void	DBReCreateData(java.lang.String name, java.lang.String section, java.lang.String key, java.lang.String xml)
java.util.Vector	DBScanFollowers(MOB mob)
void	DBUpdateArea(java.lang.String keyName, Area A)
void	DBUpdateClan(Clan C)
void	DBUpdateClanMembership(java.lang.String name, java.lang.String clan, int role)
void	DBUpdateData(java.lang.String key, java.lang.String xml)
void	DBUpdateEmail(MOB mob)
void	DBUpdateExits(Room room)
void	DBUpdateFollowers(MOB mob)
void	DBUpdateItem(java.lang.String roomID, Item item)
void	DBUpdateItems(Room room)
void	DBUpdateJournal(java.lang.String key, java.lang.String subject, java.lang.String msg)
void	DBUpdateMOB(java.lang.String roomID, MOB mob)
void	DBUpdateMOBs(Room room)
void	DBUpdatePassword(MOB mob)
void	DBUpdatePlayer(MOB mob)
void	DBUpdatePlayerAbilities(MOB mob)
void	DBUpdatePlayerItems(MOB mob)
void	DBUpdatePlayerStatsOnly(MOB mob)
void	DBUpdatePoll(java.lang.String oldName, java.lang.String name, java.lang.String player, java.lang.String subject, java.lang.String description, java.lang.String optionXML, int flag, java.lang.String qualZapper, java.lang.String results, long expiration)
void	DBUpdatePollResults(java.lang.String name, java.lang.String results)
void	DBUpdateQuest(Quest Q)
void	DBUpdateQuests(java.util.Vector quests)
void	DBUpdateRoom(Room room)
void	DBUpdateStat(long startTime, java.lang.String data)
void	DBUpdateTheseItems(Room room, java.util.Vector items)
void	DBUpdateTheseMOBs(Room room, java.util.Vector mobs)
boolean	DBUserSearch(MOB mob, java.lang.String Login)
void	DBWriteJournal(java.lang.String Journal, java.lang.String from, java.lang.String to, java.lang.String subject, java.lang.String message, int which)
java.lang.String	errorStatus()
DBConnector	getConnector()
java.util.Vector	getExtendedUserList()
ThreadEngine.SupportThread	getSupportThread()
java.util.Vector	getUserList()
java.lang.String	ID() The CoffeeMud Java Class ID shared by all instances of this object.
void	initializeClass() Called ONCE after all objects are loaded, but before the map is read in during initialization.
boolean	isConnected()
CMObject	newInstance() Returns a new instance of this class.
void	resetconnections()
boolean	shutdown()
void	vassals(MOB mob, java.lang.String liegeID)
DVector	worshippers(java.lang.String deityID)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DBInterface

public DBInterface(DBConnector DB)

Method Detail

ID

public java.lang.String ID()

Description copied from interface: CMObject

The CoffeeMud Java Class ID shared by all instances of this object. Unlike the Java Class name, this method does not include package information. However, it must return a String value unique to its class category in the ClassLoader. Class categories include Libraries, Common, Areas, Abilities, Behaviors, CharClasses, Commands, Exits Locales, MOBS, Races, WebMacros, Basic Items, Armor, Weapons, ClanItems, MiscTech. The name is typically identical to the class name.

Specified by:

ID in interface CMObject

Returns:

the name of this class

newInstance

public CMObject newInstance()

Description copied from interface: CMObject

Returns a new instance of this class.

Specified by:

newInstance in interface CMObject

Returns:

a new instance of this class

initializeClass

public void initializeClass()

Description copied from interface: CMObject

Called ONCE after all objects are loaded, but before the map is read in during initialization.

Specified by:

initializeClass in interface CMObject

copyOf

public CMObject copyOf()

Description copied from interface: CMObject

Similar to Cloneable.clone(), but does its best to make sure that any internal objects to this class are also copyOfed.

Specified by:

copyOf in interface CMObject

Returns:

a clone of this object

compareTo

public int compareTo(CMObject o)

Specified by:

compareTo in interface java.lang.Comparable<CMObject>

getConnector

public DBConnector getConnector()

Specified by:

getConnector in interface DatabaseEngine

activate

public boolean activate()

Specified by:

activate in interface CMLibrary

shutdown

public boolean shutdown()

Specified by:

shutdown in interface CMLibrary

getSupportThread

public ThreadEngine.SupportThread getSupportThread()

Specified by:

getSupportThread in interface CMLibrary

vassals

public void vassals(MOB mob,
                    java.lang.String liegeID)

Specified by:

vassals in interface DatabaseEngine

worshippers

public DVector worshippers(java.lang.String deityID)

Specified by:

worshippers in interface DatabaseEngine

getUserList

public java.util.Vector getUserList()

Specified by:

getUserList in interface DatabaseEngine

isConnected

public boolean isConnected()

Specified by:

isConnected in interface DatabaseEngine

DBReadAllClans

public void DBReadAllClans()

Specified by:

DBReadAllClans in interface DatabaseEngine

DBClanFill

public void DBClanFill(java.lang.String clan,
                       java.util.Vector members,
                       java.util.Vector roles,
                       java.util.Vector lastDates)

Specified by:

DBClanFill in interface DatabaseEngine

DBUpdateClanMembership

public void DBUpdateClanMembership(java.lang.String name,
                                   java.lang.String clan,
                                   int role)

Specified by:

DBUpdateClanMembership in interface DatabaseEngine

DBUpdateClan

public void DBUpdateClan(Clan C)

Specified by:

DBUpdateClan in interface DatabaseEngine

DBDeleteClan

public void DBDeleteClan(Clan C)

Specified by:

DBDeleteClan in interface DatabaseEngine

DBCreateClan

public void DBCreateClan(Clan C)

Specified by:

DBCreateClan in interface DatabaseEngine

DBUpdateEmail

public void DBUpdateEmail(MOB mob)

Specified by:

DBUpdateEmail in interface DatabaseEngine

DBEmailSearch

public java.lang.String DBEmailSearch(java.lang.String email)

Specified by:

DBEmailSearch in interface DatabaseEngine

DBUpdatePassword

public void DBUpdatePassword(MOB mob)

Specified by:

DBUpdatePassword in interface DatabaseEngine

DBFetchEmailData

public java.lang.String[] DBFetchEmailData(java.lang.String name)

Specified by:

DBFetchEmailData in interface DatabaseEngine

DBUpdatePlayerAbilities

public void DBUpdatePlayerAbilities(MOB mob)

Specified by:

DBUpdatePlayerAbilities in interface DatabaseEngine

DBUpdatePlayerItems

public void DBUpdatePlayerItems(MOB mob)

Specified by:

DBUpdatePlayerItems in interface DatabaseEngine

DBUpdateFollowers

public void DBUpdateFollowers(MOB mob)

Specified by:

DBUpdateFollowers in interface DatabaseEngine

DBReadAreaData

public java.util.Vector DBReadAreaData(java.lang.String areaID,
                                       boolean reportStatus)

Specified by:

DBReadAreaData in interface DatabaseEngine

DBReadRoomData

public java.util.Vector DBReadRoomData(java.lang.String roomID,
                                       boolean reportStatus)

Specified by:

DBReadRoomData in interface DatabaseEngine

DBReadAllRooms

public void DBReadAllRooms(RoomnumberSet roomsToRead)

Specified by:

DBReadAllRooms in interface DatabaseEngine

DBReadRoomExits

public void DBReadRoomExits(java.lang.String roomID,
                            java.util.Vector allRooms,
                            boolean reportStatus)

Specified by:

DBReadRoomExits in interface DatabaseEngine

DBReadCatalogs

public void DBReadCatalogs()

Specified by:

DBReadCatalogs in interface DatabaseEngine

DBReadContent

public void DBReadContent(Room thisRoom,
                          java.util.Vector rooms)

Specified by:

DBReadContent in interface DatabaseEngine

DBReadAreaRoomList

public RoomnumberSet DBReadAreaRoomList(java.lang.String areaName,
                                        boolean reportStatus)

Specified by:

DBReadAreaRoomList in interface DatabaseEngine

DBCreateThisItem

public void DBCreateThisItem(java.lang.String roomID,
                             Item thisItem)

Specified by:

DBCreateThisItem in interface DatabaseEngine

DBCreateThisMOB

public void DBCreateThisMOB(java.lang.String roomID,
                            MOB thisMOB)

Specified by:

DBCreateThisMOB in interface DatabaseEngine

DBUpdateExits

public void DBUpdateExits(Room room)

Specified by:

DBUpdateExits in interface DatabaseEngine

DBReadQuests

public void DBReadQuests(MudHost myHost)

Specified by:

DBReadQuests in interface DatabaseEngine

DBUpdateQuest

public void DBUpdateQuest(Quest Q)

Specified by:

DBUpdateQuest in interface DatabaseEngine

DBUpdateQuests

public void DBUpdateQuests(java.util.Vector quests)

Specified by:

DBUpdateQuests in interface DatabaseEngine

DBReadRoomMOBData

public java.lang.String DBReadRoomMOBData(java.lang.String roomID,
                                          java.lang.String mobID)

Specified by:

DBReadRoomMOBData in interface DatabaseEngine

DBReadRoomDesc

public java.lang.String DBReadRoomDesc(java.lang.String roomID)

Specified by:

DBReadRoomDesc in interface DatabaseEngine

DBUpdateTheseMOBs

public void DBUpdateTheseMOBs(Room room,
                              java.util.Vector mobs)

Specified by:

DBUpdateTheseMOBs in interface DatabaseEngine

DBUpdateTheseItems

public void DBUpdateTheseItems(Room room,
                               java.util.Vector items)

Specified by:

DBUpdateTheseItems in interface DatabaseEngine

DBUpdateMOBs

public void DBUpdateMOBs(Room room)

Specified by:

DBUpdateMOBs in interface DatabaseEngine

DBDeletePlayerJournals

public void DBDeletePlayerJournals(java.lang.String name)

Specified by:

DBDeletePlayerJournals in interface DatabaseEngine

DBDeleteJournal

public void DBDeleteJournal(java.lang.String oldkey)

Specified by:

DBDeleteJournal in interface DatabaseEngine

DBGetRealJournalName

public java.lang.String DBGetRealJournalName(java.lang.String possibleName)

Specified by:

DBGetRealJournalName in interface DatabaseEngine

DBDeleteJournal

public void DBDeleteJournal(java.lang.String Journal,
                            int which)

Specified by:

DBDeleteJournal in interface DatabaseEngine

DBReadJournals

public java.util.Vector DBReadJournals()

Specified by:

DBReadJournals in interface DatabaseEngine

DBReadJournalMsgs

public java.util.Vector DBReadJournalMsgs(java.lang.String Journal)

Specified by:

DBReadJournalMsgs in interface DatabaseEngine

DBCountJournal

public int DBCountJournal(java.lang.String Journal,
                          java.lang.String from,
                          java.lang.String to)

Specified by:

DBCountJournal in interface DatabaseEngine

DBReadNewJournalDate

public long DBReadNewJournalDate(java.lang.String Journal,
                                 java.lang.String name)

Specified by:

DBReadNewJournalDate in interface DatabaseEngine

DBWriteJournal

public void DBWriteJournal(java.lang.String Journal,
                           java.lang.String from,
                           java.lang.String to,
                           java.lang.String subject,
                           java.lang.String message,
                           int which)

Specified by:

DBWriteJournal in interface DatabaseEngine

DBUpdateJournal

public void DBUpdateJournal(java.lang.String key,
                            java.lang.String subject,
                            java.lang.String msg)

Specified by:

DBUpdateJournal in interface DatabaseEngine

DBCreateRoom

public void DBCreateRoom(Room room)

Specified by:

DBCreateRoom in interface DatabaseEngine

DBUpdateRoom

public void DBUpdateRoom(Room room)

Specified by:

DBUpdateRoom in interface DatabaseEngine

DBUpdatePlayer

public void DBUpdatePlayer(MOB mob)

Specified by:

DBUpdatePlayer in interface DatabaseEngine

DBUpdatePlayerStatsOnly

public void DBUpdatePlayerStatsOnly(MOB mob)

Specified by:

DBUpdatePlayerStatsOnly in interface DatabaseEngine

DBUpdateMOB

public void DBUpdateMOB(java.lang.String roomID,
                        MOB mob)

Specified by:

DBUpdateMOB in interface DatabaseEngine

DBUpdateItem

public void DBUpdateItem(java.lang.String roomID,
                         Item item)

Specified by:

DBUpdateItem in interface DatabaseEngine

DBDeleteMOB

public void DBDeleteMOB(java.lang.String roomID,
                        MOB mob)

Specified by:

DBDeleteMOB in interface DatabaseEngine

DBDeleteItem

public void DBDeleteItem(java.lang.String roomID,
                         Item item)

Specified by:

DBDeleteItem in interface DatabaseEngine

DBUpdateItems

public void DBUpdateItems(Room room)

Specified by:

DBUpdateItems in interface DatabaseEngine

DBReCreate

public void DBReCreate(Room room,
                       java.lang.String oldID)

Specified by:

DBReCreate in interface DatabaseEngine

DBUserSearch

public boolean DBUserSearch(MOB mob,
                            java.lang.String Login)

Specified by:

DBUserSearch in interface DatabaseEngine

DBReadUserOnly

public boolean DBReadUserOnly(MOB mob)

Specified by:

DBReadUserOnly in interface DatabaseEngine

DBCreateArea

public void DBCreateArea(Area A)

Specified by:

DBCreateArea in interface DatabaseEngine

DBDeleteArea

public void DBDeleteArea(Area A)

Specified by:

DBDeleteArea in interface DatabaseEngine

DBUpdateArea

public void DBUpdateArea(java.lang.String keyName,
                         Area A)

Specified by:

DBUpdateArea in interface DatabaseEngine

DBDeleteRoom

public void DBDeleteRoom(Room room)

Specified by:

DBDeleteRoom in interface DatabaseEngine

DBReadPlayer

public void DBReadPlayer(MOB mob)

Specified by:

DBReadPlayer in interface DatabaseEngine

getExtendedUserList

public java.util.Vector getExtendedUserList()

Specified by:

getExtendedUserList in interface DatabaseEngine

DBReadFollowers

public void DBReadFollowers(MOB mob,
                            boolean bringToLife)

Specified by:

DBReadFollowers in interface DatabaseEngine

DBScanFollowers

public java.util.Vector DBScanFollowers(MOB mob)

Specified by:

DBScanFollowers in interface DatabaseEngine

DBDeleteMOB

public void DBDeleteMOB(MOB mob)

Specified by:

DBDeleteMOB in interface DatabaseEngine

DBCreateCharacter

public void DBCreateCharacter(MOB mob)

Specified by:

DBCreateCharacter in interface DatabaseEngine

DBDeletePlayerData

public void DBDeletePlayerData(java.lang.String name)

Specified by:

DBDeletePlayerData in interface DatabaseEngine

DBReadAllPlayerData

public java.util.Vector DBReadAllPlayerData(java.lang.String playerID)

Specified by:

DBReadAllPlayerData in interface