io.spokestack.spokestack.nlu

Class NLUContext

java.lang.Object

io.spokestack.spokestack.nlu.NLUContext

public final class NLUContext
extends Object

Context for NLU operations, including request metadata and a facility for dispatch of trace events.

Constructor Summary

Constructors

Constructor and Description
NLUContext(SpeechConfig config) Create a new dispatcher.

Method Summary

Modifier and Type	Method and Description
void	addTraceListener(TraceListener listener) Add a listener interested in receiving NLU trace events.
boolean	canTrace(EventTracer.Level level) indicates whether a message will be traced at a level.
HashMap<String,Object>	getRequestMetadata()
void	removeTraceListener(TraceListener listener) Remove a trace listener, allowing it to be garbage collected.
void	reset() Resets state held by the context object, including request metadata.
void	setRequestMetadata(HashMap<String,Object> metadata) Set the metadata for the current request.
void	trace(EventTracer.Level level, String format, Object... params) Raises a trace event.
void	traceDebug(String format, Object... params) Traces a debug level message.
void	traceError(String format, Object... params) Traces an error level message.
void	traceInfo(String format, Object... params) Traces an informational level message.
void	tracePerf(String format, Object... params) Traces a performance level message.
void	traceWarn(String format, Object... params) Traces a warning level message.

Methods inherited from class java.lang.Object

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

Constructor Detail

NLUContext

public NLUContext(SpeechConfig config)

Create a new dispatcher.

Parameters:

config - the dispatcher's configuration

Method Detail

addTraceListener

public void addTraceListener(TraceListener listener)

Add a listener interested in receiving NLU trace events.

Parameters:

listener - the listener to add

removeTraceListener

public void removeTraceListener(TraceListener listener)

Remove a trace listener, allowing it to be garbage collected.

Parameters:

listener - the listener to remove

getRequestMetadata

public HashMap<String,Object> getRequestMetadata()

Returns:

the metadata for the current request.

setRequestMetadata

public void setRequestMetadata(HashMap<String,Object> metadata)

Set the metadata for the current request.

Parameters:

metadata - the metadata for the current request.

reset

public void reset()

Resets state held by the context object, including request metadata.

traceDebug

public void traceDebug(String format,
                       Object... params)

Traces a debug level message.

Parameters:

format - trace message format string

params - trace message format parameters

tracePerf

public void tracePerf(String format,
                      Object... params)

Traces a performance level message.

Parameters:

format - trace message format string

params - trace message format parameters

traceInfo

public void traceInfo(String format,
                      Object... params)

Traces an informational level message.

Parameters:

format - trace message format string

params - trace message format parameters

traceWarn

public void traceWarn(String format,
                      Object... params)

Traces a warning level message.

Parameters:

format - trace message format string

params - trace message format parameters

traceError

public void traceError(String format,
                       Object... params)

Traces an error level message.

Parameters:

format - trace message format string

params - trace message format parameters

canTrace

public boolean canTrace(EventTracer.Level level)

indicates whether a message will be traced at a level.

Parameters:

level - tracing level

Returns:

true if tracing will occur, false otherwise

trace

public void trace(EventTracer.Level level,
                  String format,
                  Object... params)

Raises a trace event.

Parameters:

level - tracing level

format - trace message format string

params - trace message format parameters