Package com.planet_ink.coffee_mud.Items.Software

Class DatabaseProgram

java.lang.Object

com.planet_ink.coffee_mud.Items.Basic.StdItem

com.planet_ink.coffee_mud.Items.Software.StdProgram

com.planet_ink.coffee_mud.Items.Software.GenSoftware

com.planet_ink.coffee_mud.Items.Software.GenShipProgram

com.planet_ink.coffee_mud.Items.Software.DatabaseProgram

All Implemented Interfaces:

Affectable, Behavable, CMObject, Contingent, DBIdentifiable, Environmental, Expireable, Modifiable, MsgListener, Physical, PhysicalAgent, Readable, Rider, StatsAffecting, Tickable, Item, Software, Technical, Wearable, java.lang.Cloneable, java.lang.Comparable<CMObject>

public class DatabaseProgram
extends GenShipProgram

Nested Class Summary

Nested classes/interfaces inherited from interface com.planet_ink.coffee_mud.Items.interfaces.Software

Software.SoftwareProcedure, Software.SWServices

Nested classes/interfaces inherited from interface com.planet_ink.coffee_mud.Items.interfaces.Technical

Technical.TechCommand, Technical.TechType

Nested classes/interfaces inherited from interface com.planet_ink.coffee_mud.Items.interfaces.Wearable

Wearable.CODES

Field Summary

Fields

Modifier and Type	Field	Description
protected MiniJSON.JSONObject	data
protected long	nextPowerCycleTmr
protected java.lang.StringBuffer	scr
protected BoundedObject.BoundedCube	spaceCube
Filterer<SpaceObject>	spaceFilter

Fields inherited from interface com.planet_ink.coffee_mud.core.interfaces.CMObject

idConverter

Fields inherited from class com.planet_ink.coffee_mud.Items.Software.GenShipProgram

activateProcedure, activationCounter, cachedComponents, components, dampers, deactivateProcedure, DEFAULT_ACT_8_SEC_COUNTDOWN, engines, miscsystems, readableText, sensors, shields, weapons

Fields inherited from class com.planet_ink.coffee_mud.Items.Software.GenSoftware

intName, parent, settings

Fields inherited from class com.planet_ink.coffee_mud.Items.Basic.StdItem

_name, affectPhyStats, affects, baseGoldValue, basePhyStats, behaviors, cachedImageName, CODES, databaseID, description, destroyed, displayText, dispossessionTime, material, me, miscText, myContainer, myUses, myWornCode, owner, phyStats, properWornBitmap, rawImageName, riding, scripts, secretIdentity, tickCtr, tickStatus, wornLogicalAnd, xtraValues

Fields inherited from class com.planet_ink.coffee_mud.Items.Software.StdProgram

cachedManufact, circuitKey, currentScreen, isActivated, manufacturer, nextMsg, svcs

Fields inherited from interface com.planet_ink.coffee_mud.Items.interfaces.Wearable

DEFAULT_WORN_CODES, DEFAULT_WORN_DEPENDENCYGRID, DEFAULT_WORN_DESCS, DEFAULT_WORN_ORDER, DEFAULT_WORN_USUAL_NAMES, DEFAULT_WORN_WEIGHT_POINTS, DEFAULT_WORN_WEIGHTS, FILTER_ANY, FILTER_MOBINVONLY, FILTER_ROOMONLY, FILTER_UNWORNONLY, FILTER_WORNONLY, HIGHEST_WORN_CODE, IN_INVENTORY, WORN_ABOUT_BODY, WORN_ARMS, WORN_BACK, WORN_EARS, WORN_EYES, WORN_FEET, WORN_FLOATING_NEARBY, WORN_HANDS, WORN_HEAD, WORN_HELD, WORN_LEFT_FINGER, WORN_LEFT_WRIST, WORN_LEGS, WORN_MOUTH, WORN_NECK, WORN_RIGHT_FINGER, WORN_RIGHT_WRIST, WORN_TORSO, WORN_WAIST, WORN_WIELD

Constructor Summary

Constructors

Constructor	Description
DatabaseProgram()

Method Summary

Modifier and Type	Method	Description
protected void	addLineToReadableScreen(java.lang.String s)
protected boolean	checkActivate(MOB mob, java.lang.String message)
protected boolean	checkDeactivate(MOB mob, java.lang.String message)
protected boolean	checkPowerCurrent(int value)
protected boolean	checkTyping(MOB mob, java.lang.String message)
protected long[]	convertStringToCoords(java.lang.String coordStr)
protected java.util.List<SpaceObject>	dbQuerySpaceObjects(java.lang.String query, boolean near)
protected void	decache()
protected java.lang.String	doDBQuery(java.util.List<java.lang.String> parsed, java.lang.String query)
protected boolean	doesNameExistInData(java.lang.String name, java.lang.String okKey)
protected java.util.Set<java.lang.String>	doKeyQuery(java.lang.String query, boolean noNotes)
protected java.lang.String	doSectorQuery(java.lang.String query)
protected java.util.List<SpaceObject>	findDBSpaceObjects(long[] coords, long radius)
java.lang.String	getActivationMenu()	Returns the menu name of this software, so that it can be identified on its parent screen.
protected java.util.List<SpaceObject>	getAllBoundSpaceObjects(BoundedObject.BoundedCube bcube)
protected java.lang.String	getAllSpaceObjectDataResults(long[] coords)
protected Software.SWServices[]	getAppreciatedServices()
protected long[]	getCheckedCoords(java.lang.String key)
java.lang.String	getCurrentScreenDisplay()	Returns the full screen appearance of this program when it is activated and on the screen.
protected java.lang.String	getCustomNotes(long[] coords)
protected long[]	getDataCoords(java.lang.String key)
protected java.lang.String	getDataName(java.lang.String key)
protected java.lang.String	getDataResults(java.lang.String key)
protected Software.SWServices[]	getProvidedServices()
protected java.lang.String	getReportOnSpaceObject(SpaceObject obj)
java.lang.String	getSettings()	Returns settings specific to this disk.
protected java.lang.String	getSpaceObjectDataResults(java.lang.String key, long[] ccoords, MiniJSON.JSONObject jo)
protected Pair<java.lang.String,java.lang.String>	getTargetKeyName(int context)
protected java.util.List<java.lang.String>	getValues(java.lang.String key, boolean noNotes)
java.lang.String	ID()	The CoffeeMud Java Class ID shared by all instances of this object.
boolean	isActivationString(java.lang.String word)	Returns whether the given computer-entry command should be responded to by THIS software object on an activation command.
boolean	isCommandString(java.lang.String word, boolean isActive)	Returns whether the given computer-entry command should be responded to by THIS software object on a WRITE/ENTER command.
protected boolean	isDBSpaceObject(SpaceObject sO)
boolean	isDeActivationString(java.lang.String word)	Returns whether the given computer-entry command should be responded to by THIS software object on a deactivation command.
protected void	onActivate(MOB mob, java.lang.String message)
protected void	onDeactivate(MOB mob, java.lang.String message)
protected void	onPowerCurrent(int value)
protected void	onTyping(MOB mob, java.lang.String message)
protected void	provideService(Software.SWServices service, Software S, java.lang.String[] parms, CMMsg msg)
void	setSettings(java.lang.String var)	Sets settings specific to this disk.
protected void	shutdown()
protected SpaceObject	spaceCubeMatch(java.lang.String query)
protected java.util.List<SpaceObject>	spaceCubeSearch(java.lang.String query)

Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.Behavable

addBehavior, addScript, behaviors, delAllBehaviors, delAllScripts, delBehavior, delScript, eachBehavior, eachScript, fetchBehavior, fetchBehavior, fetchScript, numBehaviors, numScripts, scripts

Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.CMObject

copyOf, initializeClass, newInstance

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.DBIdentifiable

canSaveDatabaseID, databaseID, setDatabaseID

Methods inherited from class com.planet_ink.coffee_mud.Items.Software.GenShipProgram

executeMsg, findComponentByID, findComponentByName, findCoordinates, findEngineByName, findEngineByPort, findSensorByName, findShieldByName, findWeaponByName, getComponent, getDampeners, getEngines, getShipSensors, getShipShields, getShipWeapons, getSystemMiscComponents, getTechComponents, getTechType, isWeaponLauncher, onActivationTimer, onPowerTimer, sendMessage, trySendMsgToItem

Methods inherited from class com.planet_ink.coffee_mud.Items.Software.GenSoftware

getInternalName, getParentMenu, getStat, getStatCodes, isGeneric, readableText, sameAs, setInternalName, setMiscText, setParentMenu, setReadableText, setStat, text

Methods inherited from interface com.planet_ink.coffee_mud.Items.interfaces.Item

baseGoldValue, container, material, numberOfItems, owner, rawSecretIdentity, recursiveWeight, removeFromOwnerContainer, secretIdentity, setBaseValue, setContainer, setMaterial, setOwner, setSecretIdentity, setUsesRemaining, stopTicking, subjectToWearAndTear, ultimateContainer, usesRemaining, value

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.Readable

isReadable, setReadable

Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.Rider

riding, setRiding

Methods inherited from class com.planet_ink.coffee_mud.Items.Basic.StdItem

abilityImbuesMagic, addBehavior, addEffect, addNonUninvokableEffect, addScript, affectCharState, affectCharStats, affectPhyStats, alreadyWornMsg, amBeingWornProperly, amDestroyed, amWearingAt, baseGoldValue, basePhyStats, behaviors, canSaveDatabaseID, canWear, canWearComplete, cloneFix, compareProperLocations, compareTo, container, copyOf, databaseID, delAllBehaviors, delAllEffects, delAllScripts, delBehavior, delEffect, delScript, description, description, destroy, displayText, displayText, eachBehavior, eachEffect, eachScript, effects, expirationDate, fetchBehavior, fetchBehavior, fetchEffect, fetchEffect, fetchScript, fitsOn, getSaveStatIndex, getTickStatus, I, image, initializeClass, isReadable, isSavable, isStat, L, material, maxRange, minRange, miscTextFormat, name, name, Name, newInstance, numBehaviors, numberOfItems, numEffects, numScripts, owner, phyStats, rawImage, rawLogicalAnd, rawProperLocationBitmap, rawSecretIdentity, rawWornCode, recoverPhyStats, recursiveWeight, removeFromOwnerContainer, riding, scripts, secretIdentity, setBasePhyStats, setBaseValue, setContainer, setDatabaseID, setDescription, setDisplayText, setExpirationDate, setImage, setMaterial, setName, setOwner, setRawLogicalAnd, setRawProperLocationBitmap, setRawWornCode, setReadable, setRiding, setSavable, setSecretIdentity, setUsesRemaining, stopTicking, subjectToWearAndTear, tackOns, tick, ultimateContainer, unWear, usesRemaining, value, wearAt, wearEvenIfImpossible, wearIfPossible, wearIfPossible, whereCantWear

Methods inherited from class com.planet_ink.coffee_mud.Items.Software.StdProgram

addScreenMessage, display, display, display, displayPerSec, doServiceRequests, doServiceTransaction, forceNewMenuRead, forceNewMessageScan, forceUpMenu, genericName, getFinalManufacturer, getManufacturerName, getMyComputer, getPeerComputers, getPeerComputingRooms, getRequiredServices, getResponseComputers, getScreenMessage, handleServices, okMessage, sendServiceMsg, sendSoftwareRespMsg, setCircuitKey, setCurrentScreenDisplay, setManufacturerName, setTechLevel, techLevel, trimColorsAndTrim

Methods inherited from interface com.planet_ink.coffee_mud.Items.interfaces.Wearable

amBeingWornProperly, amWearingAt, canWear, compareProperLocations, fitsOn, rawLogicalAnd, rawProperLocationBitmap, rawWornCode, setRawLogicalAnd, setRawProperLocationBitmap, setRawWornCode, unWear, wearAt, wearEvenIfImpossible, wearIfPossible, wearIfPossible, whereCantWear

Field Detail

nextPowerCycleTmr

protected volatile long nextPowerCycleTmr

scr

protected final java.lang.StringBuffer scr

data

protected MiniJSON.JSONObject data

spaceCube

protected BoundedObject.BoundedCube spaceCube

spaceFilter

public final Filterer<SpaceObject> spaceFilter

Constructor Detail

DatabaseProgram

public DatabaseProgram()

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, Tech. The name is typically identical to the class name.

Specified by:

ID in interface CMObject

Overrides:

ID in class GenShipProgram

Returns:

the name of this class

decache

protected void decache()

Overrides:

decache in class GenShipProgram

getSettings

public java.lang.String getSettings()

Description copied from interface: Software

Returns settings specific to this disk.

Specified by:

getSettings in interface Software

Overrides:

getSettings in class GenSoftware

Returns:

settings

See Also:

Software.setSettings(String)

setSettings

public void setSettings(java.lang.String var)

Description copied from interface: Software

Sets settings specific to this disk.

Specified by:

setSettings in interface Software

Overrides:

setSettings in class GenSoftware

Parameters:

var - the new settings

See Also:

Software.getSettings()

getProvidedServices

protected Software.SWServices[] getProvidedServices()

Overrides:

getProvidedServices in class StdProgram

getAppreciatedServices

protected Software.SWServices[] getAppreciatedServices()

Overrides:

getAppreciatedServices in class StdProgram

isActivationString

public boolean isActivationString(java.lang.String word)

Description copied from interface: Software

Returns whether the given computer-entry command should be responded to by THIS software object on an activation command.

Specified by:

isActivationString in interface Software

Overrides:

isActivationString in class GenShipProgram

Parameters:

word - the computer-entry command entered

Returns:

true if this software should respond.

isDeActivationString

public boolean isDeActivationString(java.lang.String word)

Description copied from interface: Software

Returns whether the given computer-entry command should be responded to by THIS software object on a deactivation command.

Specified by:

isDeActivationString in interface Software

Overrides:

isDeActivationString in class GenShipProgram

Parameters:

word - the computer-entry command entered

Returns:

true if this software should respond.

onDeactivate

protected void onDeactivate(MOB mob,
                            java.lang.String message)

Overrides:

onDeactivate in class GenShipProgram

isCommandString

public boolean isCommandString(java.lang.String word,
                               boolean isActive)

Description copied from interface: Software

Returns whether the given computer-entry command should be responded to by THIS software object on a WRITE/ENTER command.

Specified by:

isCommandString in interface Software

Overrides:

isCommandString in class GenShipProgram

Parameters:

word - the computer-entry command

isActive - true if the software is already activated

Returns:

true if this software can respond

getActivationMenu

public java.lang.String getActivationMenu()

Description copied from interface: Software

Returns the menu name of this software, so that it can be identified on its parent screen.

Specified by:

getActivationMenu in interface Software

Overrides:

getActivationMenu in class GenShipProgram

Returns:

the menu name of this software

shutdown

protected void shutdown()

checkDeactivate

protected boolean checkDeactivate(MOB mob,
                                  java.lang.String message)

Overrides:

checkDeactivate in class GenShipProgram

checkTyping

protected boolean checkTyping(MOB mob,
                              java.lang.String message)

Overrides:

checkTyping in class GenShipProgram

checkPowerCurrent

protected boolean checkPowerCurrent(int value)

Overrides:

checkPowerCurrent in class GenShipProgram

getCurrentScreenDisplay

public java.lang.String getCurrentScreenDisplay()

Description copied from interface: Software

Returns the full screen appearance of this program when it is activated and on the screen. Only those intentially looking at the screen again, or forced by the program, will see this larger message.

Specified by:

getCurrentScreenDisplay in interface Software

Overrides:

getCurrentScreenDisplay in class StdProgram

Returns:

the entire screen message

See Also:

Software.addScreenMessage(String), Software.getScreenMessage()

checkActivate

protected boolean checkActivate(MOB mob,
                                java.lang.String message)

Overrides:

checkActivate in class GenShipProgram

onActivate

protected void onActivate(MOB mob,
                          java.lang.String message)

Overrides:

onActivate in class GenShipProgram

addLineToReadableScreen

protected void addLineToReadableScreen(java.lang.String s)

convertStringToCoords

protected long[] convertStringToCoords(java.lang.String coordStr)

Overrides:

convertStringToCoords in class GenShipProgram

getCheckedCoords

protected long[] getCheckedCoords(java.lang.String key)

getDataCoords

protected long[] getDataCoords(java.lang.String key)

isDBSpaceObject

protected boolean isDBSpaceObject(SpaceObject sO)

getDataName

protected java.lang.String getDataName(java.lang.String key)

findDBSpaceObjects

protected java.util.List<SpaceObject> findDBSpaceObjects(long[] coords,
                                                         long radius)

getCustomNotes

protected java.lang.String getCustomNotes(long[] coords)

getReportOnSpaceObject

protected java.lang.String getReportOnSpaceObject(SpaceObject obj)

spaceCubeMatch

protected SpaceObject spaceCubeMatch(java.lang.String query)

spaceCubeSearch

protected java.util.List<SpaceObject> spaceCubeSearch(java.lang.String query)

getAllSpaceObjectDataResults

protected java.lang.String getAllSpaceObjectDataResults(long[] coords)

getSpaceObjectDataResults

protected java.lang.String getSpaceObjectDataResults(java.lang.String key,
                                                     long[] ccoords,
                                                     MiniJSON.JSONObject jo)

getDataResults

protected java.lang.String getDataResults(java.lang.String key)

doSectorQuery

protected java.lang.String doSectorQuery(java.lang.String query)

getAllBoundSpaceObjects

protected java.util.List<SpaceObject> getAllBoundSpaceObjects(BoundedObject.BoundedCube bcube)

dbQuerySpaceObjects

protected java.util.List<SpaceObject> dbQuerySpaceObjects(java.lang.String query,
                                                          boolean near)

getValues

protected java.util.List<java.lang.String> getValues(java.lang.String key,
                                                     boolean noNotes)

doKeyQuery

protected java.util.Set<java.lang.String> doKeyQuery(java.lang.String query,
                                                     boolean noNotes)

doesNameExistInData

protected boolean doesNameExistInData(java.lang.String name,
                                      java.lang.String okKey)

doDBQuery

protected java.lang.String doDBQuery(java.util.List<java.lang.String> parsed,
                                     java.lang.String query)

onTyping

protected void onTyping(MOB mob,
                        java.lang.String message)

Overrides:

onTyping in class GenShipProgram

onPowerCurrent

protected void onPowerCurrent(int value)

Overrides:

onPowerCurrent in class GenShipProgram

getTargetKeyName

protected Pair<java.lang.String,java.lang.String> getTargetKeyName(int context)

provideService

protected void provideService(Software.SWServices service,
                              Software S,
                              java.lang.String[] parms,
                              CMMsg msg)

Overrides:

provideService in class StdProgram