org.botlibre.sense

Class BasicSense

java.lang.Object

org.botlibre.sense.BasicSense

All Implemented Interfaces:

Sense

Direct Known Subclasses:

Chat, Context, Email, Facebook, Http, IRC, Kik, RemoteService, Skype, Slack, Telegram, TextEntry, Timer, Twilio, Twitter, Vision, WeChat

public class BasicSense
extends java.lang.Object
implements Sense

Defines an external interface. i.e. - text - voice - hearing - vision

Field Summary

Fields

Modifier and Type	Field and Description
int	conversations
static long	DAY
static java.lang.String	DEFAULT_SPEAKER Default user if none specified.
int	engaged
static long	HOUR
static int	MAX_FILE_SIZE
static long	MINUTE
static int	RETRY Number of attempt to retry sensory input on failure.

Constructor Summary

Constructors

Constructor and Description
BasicSense()

Method Summary

Modifier and Type	Method and Description
void	addListener(ExceptionEventListener listener) Add the exception listener.
void	awake() Start sensing.
void	checkEngaged(Vertex conversation) Record the engaged statistic if the conversation is engaged (over 3 messages).
boolean	checkSentence(Vertex sentence, Network network, Vertex currentTime) Check if the sentence has been discovered.
boolean	discover(Vertex input, Network network, Vertex currentTime) Attempt to discover information on the vertex.
void	discoverSentence(Vertex sentence, Network network, Vertex currentTime) Attempt to discover information on the sentence words.
java.lang.String	getAction()
Bot	getBot() Return the associated Bot instance.
EmotionalState	getEmotionalState() Return the current conversational mood.
Language.LanguageState	getLanguageState() Return the current conversational state.
java.util.List<ExceptionEventListener>	getListeners()
java.lang.String	getName() Return the name that identifies the sense.
Primitive	getPrimitive() Allows senses to be referenced by memory.
ResponseListener	getResponseListener()
Network	getShortTermMemory() Return the short term memory.
void	initialize(java.util.Map<java.lang.String,java.lang.Object> properties) Initialize any configurable settings from the properties.
void	input(java.lang.Object input) Receive any input from the sense.
void	input(java.lang.Object input, Network network) Receive any input from the sense.
boolean	isEnabled() Return if the sense is enabled.
void	log(java.lang.String message, java.util.logging.Level level) Log the message if the debug level is greater or equal to the level.
void	log(java.lang.String message, java.util.logging.Level level, java.lang.Object... arguments) Log the message if the debug level is greater or equal to the level.
void	log(java.lang.Throwable error) Log the exception.
void	migrateProperties() Migrate to new properties system.
void	notifyExceptionListeners(java.lang.Throwable exception)
void	notifyResponseListener()
void	output(Vertex output) Output the active network to the sense.
void	pool() Reset state when instance is pooled.
java.lang.String	printInput(Vertex input) Convert the input into text.
void	removeListener(ExceptionEventListener listener)
void	saveProperties()
void	setAction(java.lang.String action) Set the current action.
void	setBot(Bot Bot) Set the associated Bot instance.
void	setEmotionalState(EmotionalState emotionalState) Set the current conversational mood.
void	setIsEnabled(boolean isEnabled) Allow the sense to disabled/enabled.
void	setLanguageState(Language.LanguageState languageState) Set the current conversational state.
void	setName(java.lang.String name) Set the name that identifies the sense.
void	setResponseListener(ResponseListener responseListener)
void	shutdown() Stop sensing.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

MINUTE

public static long MINUTE

HOUR

public static long HOUR

DAY

public static long DAY

RETRY

public static int RETRY

Number of attempt to retry sensory input on failure.

MAX_FILE_SIZE

public static int MAX_FILE_SIZE

DEFAULT_SPEAKER

public static java.lang.String DEFAULT_SPEAKER

Default user if none specified.

conversations

public int conversations

engaged

public int engaged

Constructor Detail

BasicSense

public BasicSense()

Method Detail

notifyResponseListener

public void notifyResponseListener()

getResponseListener

public ResponseListener getResponseListener()

setResponseListener

public void setResponseListener(ResponseListener responseListener)

checkEngaged

public void checkEngaged(Vertex conversation)

Record the engaged statistic if the conversation is engaged (over 3 messages).

isEnabled

public boolean isEnabled()

Return if the sense is enabled.

Specified by:

isEnabled in interface Sense

setIsEnabled

public void setIsEnabled(boolean isEnabled)

Allow the sense to disabled/enabled.

Specified by:

setIsEnabled in interface Sense

getLanguageState

public Language.LanguageState getLanguageState()

Return the current conversational state.

Specified by:

getLanguageState in interface Sense

setLanguageState

public void setLanguageState(Language.LanguageState languageState)

Set the current conversational state.

Specified by:

setLanguageState in interface Sense

getEmotionalState

public EmotionalState getEmotionalState()

Return the current conversational mood.

setEmotionalState

public void setEmotionalState(EmotionalState emotionalState)

Set the current conversational mood.

Specified by:

setEmotionalState in interface Sense

getAction

public java.lang.String getAction()

setAction

public void setAction(java.lang.String action)

Set the current action.

Specified by:

setAction in interface Sense

awake

public void awake()

Start sensing.

Specified by:

awake in interface Sense

migrateProperties

public void migrateProperties()

Migrate to new properties system.

Specified by:

migrateProperties in interface Sense

shutdown

public void shutdown()

Stop sensing.

Specified by:

shutdown in interface Sense

pool

public void pool()

Reset state when instance is pooled.

Specified by:

pool in interface Sense

input

public void input(java.lang.Object input)

Receive any input from the sense.

Specified by:

input in interface Sense

input

public void input(java.lang.Object input,
                  Network network)
           throws java.lang.Exception

Receive any input from the sense.

Specified by:

input in interface Sense

Throws:

java.lang.Exception

output

public void output(Vertex output)

Output the active network to the sense.

Specified by:

output in interface Sense

getName

public java.lang.String getName()

Return the name that identifies the sense.

Specified by:

getName in interface Sense

setName

public void setName(java.lang.String name)

Set the name that identifies the sense.

Specified by:

setName in interface Sense

getShortTermMemory

public Network getShortTermMemory()

Return the short term memory.

log

public void log(java.lang.String message,
                java.util.logging.Level level,
                java.lang.Object... arguments)

Log the message if the debug level is greater or equal to the level.

log

public void log(java.lang.String message,
                java.util.logging.Level level)

Log the message if the debug level is greater or equal to the level.

log

public void log(java.lang.Throwable error)

Log the exception.

getPrimitive

public Primitive getPrimitive()

Description copied from interface: Sense

Allows senses to be referenced by memory.

Specified by:

getPrimitive in interface Sense

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getBot

public Bot getBot()

Return the associated Bot instance.

Specified by:

getBot in interface Sense

setBot

public void setBot(Bot Bot)

Set the associated Bot instance.

Specified by:

setBot in interface Sense

initialize

public void initialize(java.util.Map<java.lang.String,java.lang.Object> properties)

Initialize any configurable settings from the properties.

Specified by:

initialize in interface Sense

discover

public boolean discover(Vertex input,
                        Network network,
                        Vertex currentTime)

Attempt to discover information on the vertex.

checkSentence

public boolean checkSentence(Vertex sentence,
                             Network network,
                             Vertex currentTime)

Check if the sentence has been discovered.

discoverSentence

public void discoverSentence(Vertex sentence,
                             Network network,
                             Vertex currentTime)

Attempt to discover information on the sentence words.

printInput

public java.lang.String printInput(Vertex input)

Convert the input into text.

notifyExceptionListeners

public void notifyExceptionListeners(java.lang.Throwable exception)

Specified by:

notifyExceptionListeners in interface Sense

getListeners

public java.util.List<ExceptionEventListener> getListeners()

addListener

public void addListener(ExceptionEventListener listener)

Add the exception listener. It will be notified of any exceptions.

removeListener

public void removeListener(ExceptionEventListener listener)

saveProperties

public void saveProperties()

Specified by:

saveProperties in interface Sense