org.myrobotlab.service

Class ProgramAB

java.lang.Object

org.myrobotlab.framework.MessageService

org.myrobotlab.framework.Service

org.myrobotlab.service.ProgramAB

All Implemented Interfaces:

java.io.Serializable, java.lang.Runnable, Attachable, Invoker, LoggingSink, MessageSender, MessageSubscriber, NameProvider, NameTypeProvider, ServiceInterface, ServiceQueue, StateSaver, TypeProvider, QueueReporter, TextListener, TextPublisher

public class ProgramAB
extends Service
implements TextListener, TextPublisher

Program AB service for MyRobotLab Uses AIML 2.0 to create a ChatBot This is a reboot of the Old AIML spec to be more 21st century. More Info at http://aitools.org/ProgramAB

Author:

kwatters

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ProgramAB.Response

Field Summary

Fields

Modifier and Type	Field and Description
boolean	aimlError
boolean	loading
static org.slf4j.Logger	log
java.lang.String	wasCleanyShutdowned

Fields inherited from class org.myrobotlab.framework.Service

cfgDir, dnaPool, MESSAGE_RECORDING_FORMAT_BINARY, MESSAGE_RECORDING_FORMAT_XML

Constructor Summary

Constructors

Constructor and Description
ProgramAB(java.lang.String name)

Method Summary

Modifier and Type	Method and Description
void	addOOBTextListener(TextListener service)
void	addResponseListener(Service service)
void	addTextListener(TextListener service)
void	addTextPublisher(TextPublisher service)
void	addToMap(java.lang.String mapName, java.lang.String mapKey, java.lang.String mapValue)
void	addToSet(java.lang.String setName, java.lang.String setValue)
void	attach(Attachable attachable) This attach when overriden "routes" to the appropriately typed parameterized attach within a service.
org.alicebot.ab.Chat	getChat(java.lang.String userName, java.lang.String botName)
java.lang.String	getCurrentBotName()
java.lang.String	getCurrentUserName()
int	getMaxConversationDelay()
static ServiceType	getMetaData() This static method returns all the details of the class without it having to be constructed.
java.lang.String	getPath()
java.lang.String	getPredicate(java.lang.String username, java.lang.String predicateName)
ProgramAB.Response	getResponse(java.lang.String text)
ProgramAB.Response	getResponse(java.lang.String username, java.lang.String text)
ProgramAB.Response	getResponse(java.lang.String session, java.lang.String text, java.lang.Long delay) Only respond if the last response was longer than delay ms ago
ProgramAB.Response	getResponse(java.lang.String username, java.lang.String botName, java.lang.String text)
java.util.Set<java.lang.String>	getSessionNames()
boolean	isEnableAutoConversation()
boolean	isProcessOOB()
java.util.ArrayList<java.lang.String>	listPatterns(java.lang.String botName) Return a list of all patterns that the AIML Bot knows to match against.
static void	main(java.lang.String[] s)
long	millisecondsSinceLastResponse() Return the number of milliseconds since the last response was given -1 if a response has never been given.
void	onText(java.lang.String text)
java.lang.String	publishOOBText(java.lang.String oobText)
ProgramAB.Response	publishResponse(ProgramAB.Response response)
java.lang.String	publishResponseText(ProgramAB.Response response)
java.lang.String	publishText(java.lang.String text)
void	reloadSession(java.lang.String session, java.lang.String botName)
void	reloadSession(java.lang.String path, java.lang.String username, java.lang.String botname)
void	reloadSession(java.lang.String path, java.lang.String username, java.lang.String botname, java.lang.Boolean killAimlIf)
void	removePredicate(java.lang.String userName, java.lang.String predicateName)
void	removePredicate(java.lang.String userName, java.lang.String botName, java.lang.String predicateName)
void	repetition_count(int val)
java.lang.String	resolveSessionKey(java.lang.String username, java.lang.String botname)
void	savePredicates() Persist the predicates for all known sessions in the robot.
void	setCurrentBotName(java.lang.String currentBotName)
void	setCurrentUserName(java.lang.String currentUserName)
void	setEnableAutoConversation(boolean enableAutoConversation)
void	setMaxConversationDelay(int maxConversationDelay)
void	setPath(java.lang.String path)
void	setPredicate(java.lang.String username, java.lang.String predicateName, java.lang.String predicateValue)
void	setProcessOOB(boolean processOOB)
boolean	setUsername(java.lang.String username) setUsername will check if username correspond to current session If no, a new session is started
void	startSession()
void	startSession(java.lang.String session)
void	startSession(java.lang.String session, java.lang.String botName) Load the AIML 2.0 Bot config and start a chat session.
void	startSession(java.lang.String path, java.lang.String userName, java.lang.String botName)
void	stopService() Stops the service.
void	unsetPredicate(java.lang.String username, java.lang.String predicateName)
void	writeAIML()
void	writeAIMLIF()
void	writeAndQuit()
void	writeAndQuit(java.lang.Boolean killAimlIf) writeAndQuit will clean shutdown BOT so next stratup is sync & faaaast

Methods inherited from class org.myrobotlab.framework.Service

addListener, addListener, addTask, addTask, addTask, addTaskOneShot, allowDisplay, allowDisplay, attach, broadcastState, buildDna, buildDna, buildDnaKeys, buildDnaNames, clearLastError, close, containsTask, copyShallowFrom, createPeer, createPeer, createRootReserved, detach, detach, detach, echoHeartbeat, error, error, error, getAttached, getCfgDir, getComm, getDeclaredMethodNames, getDeclaredMethods, getDescription, getDna, getDnaString, getHostName, getInbox, getInstanceId, getIntanceName, getInterfaceSet, getLastError, getMessageSet, getMetaData, getMethodMap, getMethodNames, getMethods, getMethodToolTip, getMsg, getName, getNotifyList, getNotifyListKeySet, getOutbox, getPeerKey, getPeerName, getServiceResourceFile, getSimpleName, getTasks, getThisThread, getType, hasError, hasPeers, help, help, in, info, info, invoke, invoke, invoke, invokeOn, isAttached, isAttached, isLocal, isReady, isRunning, isRuntime, isVirtual, load, load, logTimeEnable, mergeDna, mergeDna, mergePeerDna, movePeerDna, out, out, preProcessHook, preRoutingHook, publishError, publishQueueStats, publishState, publishStats, publishStatus, purgeTask, purgeTasks, releasePeers, releaseService, removeAllListeners, removeListener, requiresSecurity, reserve, reserve, reserveRoot, reserveRoot, reserveRootAs, run, save, save, save, send, send, send, send, sendBlocking, sendBlocking, sendBlocking, sendBlocking, sendPeer, setInstanceId, setName, setPeer, setSecurityProvider, setState, setThisThread, setVirtual, sleep, stackToString, startHeartbeat, startPeer, startPeer, startRecording, startService, stopHeartbeat, stopMsgRecording, subscribe, subscribe, subscribe, toString, unsubscribe, unsubscribe, unsubscribe, updateStats, warn, warn

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.myrobotlab.service.interfaces.TextListener

getName

Methods inherited from interface org.myrobotlab.service.interfaces.TextPublisher

getName

Field Detail

log

public static final transient org.slf4j.Logger log

aimlError

public boolean aimlError

loading

public boolean loading

wasCleanyShutdowned

public java.lang.String wasCleanyShutdowned

Constructor Detail

ProgramAB

public ProgramAB(java.lang.String name)

Method Detail

addOOBTextListener

public void addOOBTextListener(TextListener service)

addResponseListener

public void addResponseListener(Service service)

addTextListener

public void addTextListener(TextListener service)

Specified by:

addTextListener in interface TextPublisher

addTextPublisher

public void addTextPublisher(TextPublisher service)

getMaxConversationDelay

public int getMaxConversationDelay()

getResponse

public ProgramAB.Response getResponse(java.lang.String text)

getResponse

public ProgramAB.Response getResponse(java.lang.String username,
                                      java.lang.String botName,
                                      java.lang.String text)

Parameters:

text - - the query string to the bot brain

username - - the user that is sending the query

botName - - the name of the bot you which to get the response from

Returns:

the response for a user from a bot given the input text.

getResponse

public ProgramAB.Response getResponse(java.lang.String username,
                                      java.lang.String text)

resolveSessionKey

public java.lang.String resolveSessionKey(java.lang.String username,
                                          java.lang.String botname)

repetition_count

public void repetition_count(int val)

getChat

public org.alicebot.ab.Chat getChat(java.lang.String userName,
                                    java.lang.String botName)

removePredicate

public void removePredicate(java.lang.String userName,
                            java.lang.String predicateName)

removePredicate

public void removePredicate(java.lang.String userName,
                            java.lang.String botName,
                            java.lang.String predicateName)

addToSet

public void addToSet(java.lang.String setName,
                     java.lang.String setValue)

addToMap

public void addToMap(java.lang.String mapName,
                     java.lang.String mapKey,
                     java.lang.String mapValue)

setPredicate

public void setPredicate(java.lang.String username,
                         java.lang.String predicateName,
                         java.lang.String predicateValue)

unsetPredicate

public void unsetPredicate(java.lang.String username,
                           java.lang.String predicateName)

getPredicate

public java.lang.String getPredicate(java.lang.String username,
                                     java.lang.String predicateName)

getResponse

public ProgramAB.Response getResponse(java.lang.String session,
                                      java.lang.String text,
                                      java.lang.Long delay)

Only respond if the last response was longer than delay ms ago

Parameters:

session - - current session/username

text - - text to get a response for

delay - - min amount of time that must have transpired since the last response.

Returns:

the response

isEnableAutoConversation

public boolean isEnableAutoConversation()

isProcessOOB

public boolean isProcessOOB()

listPatterns

public java.util.ArrayList<java.lang.String> listPatterns(java.lang.String botName)

Return a list of all patterns that the AIML Bot knows to match against.

Parameters:

botName - the bots name from which to return it's patterns.

Returns:

a list of all patterns loaded into the aiml brain

millisecondsSinceLastResponse

public long millisecondsSinceLastResponse()

Return the number of milliseconds since the last response was given -1 if a response has never been given.

Returns:

milliseconds

onText

public void onText(java.lang.String text)

Specified by:

onText in interface TextListener

publishOOBText

public java.lang.String publishOOBText(java.lang.String oobText)

publishResponse

public ProgramAB.Response publishResponse(ProgramAB.Response response)

publishResponseText

public java.lang.String publishResponseText(ProgramAB.Response response)

publishText

public java.lang.String publishText(java.lang.String text)

Specified by:

publishText in interface TextPublisher

reloadSession

public void reloadSession(java.lang.String session,
                          java.lang.String botName)

reloadSession

public void reloadSession(java.lang.String path,
                          java.lang.String username,
                          java.lang.String botname)

reloadSession

public void reloadSession(java.lang.String path,
                          java.lang.String username,
                          java.lang.String botname,
                          java.lang.Boolean killAimlIf)

savePredicates

public void savePredicates()
                    throws java.io.IOException

Persist the predicates for all known sessions in the robot.

Throws:

java.io.IOException

setEnableAutoConversation

public void setEnableAutoConversation(boolean enableAutoConversation)

setMaxConversationDelay

public void setMaxConversationDelay(int maxConversationDelay)

setProcessOOB

public void setProcessOOB(boolean processOOB)

startSession

public void startSession()

startSession

public void startSession(java.lang.String session)

getSessionNames

public java.util.Set<java.lang.String> getSessionNames()

startSession

public void startSession(java.lang.String session,
                         java.lang.String botName)

Load the AIML 2.0 Bot config and start a chat session. This must be called after the service is created.

Parameters:

session - - The new session name

botName - - The name of the bot to load. (example: alice2)

startSession

public void startSession(java.lang.String path,
                         java.lang.String userName,
                         java.lang.String botName)

setPath

public void setPath(java.lang.String path)

setCurrentBotName

public void setCurrentBotName(java.lang.String currentBotName)

setUsername

public boolean setUsername(java.lang.String username)

setUsername will check if username correspond to current session If no, a new session is started

Parameters:

username - - The new username

Returns:

boolean - True if username changed

Throws:

java.io.IOException

writeAIML

public void writeAIML()

writeAIMLIF

public void writeAIMLIF()

writeAndQuit

public void writeAndQuit()

writeAndQuit

public void writeAndQuit(java.lang.Boolean killAimlIf)

writeAndQuit will clean shutdown BOT so next stratup is sync & faaaast

Parameters:

killAimlIf - - Delete aimlif and restart bot from aiml - Useful to push aiml modifications in realtime - Without restart whole script

attach

public void attach(Attachable attachable)

Description copied from class: Service

This attach when overriden "routes" to the appropriately typed parameterized attach within a service. When overriden, the first thing it should do is check to see if the referenced service is already attached. If it is already attached it should simply return. If its attached to this service, it should first attach itself, modifying its own data if necessary. The last thing it should do is call the parameterized service's attach. This gives the other service an opportunity to attach. e.g.

 
 public void attach(Attachable service) {
    if (ServoControl.class.isAssignableFrom(service.getClass())) {
        attachServoControl((ServoControl) service);
        return;
    }
    
    ...  route to more attach functions   ....
    
    error("%s doesn't know how to attach a %s", getClass().getSimpleName(), service.getClass().getSimpleName());
  }
  
  And within attachServoControl :
  
  public void attachServoControl(ServoControl service) {
       // guard
       if (!isAttached(service)){
           return;
       }
       
       ... attach logic ....
 
       // call to attaching service
       service.attach(this);  
 }  
 

Specified by:

attach in interface Attachable

Overrides:

attach in class Service

Parameters:

attachable - - the service to attach from this service

stopService

public void stopService()

Description copied from class: Service

Stops the service. Stops threads.

Specified by:

stopService in interface ServiceInterface

Overrides:

stopService in class Service

getMetaData

public static ServiceType getMetaData()

This static method returns all the details of the class without it having to be constructed. It has description, categories, dependencies, and peer definitions.

Returns:

ServiceType - returns all the data

main

public static void main(java.lang.String[] s)
                 throws java.io.IOException

Throws:

java.io.IOException

getPath

public java.lang.String getPath()

getCurrentUserName

public java.lang.String getCurrentUserName()

setCurrentUserName

public void setCurrentUserName(java.lang.String currentUserName)

getCurrentBotName

public java.lang.String getCurrentBotName()