Skip navigation links
A B C D E F G H I J L M N O P R S T U V W X 

A

ABSTRACT_PLATFORM_BINDINGS_PREFIX - Static variable in class com.xatkit.core.XatkitCore
The Configuration key prefix to store the abstract platform bindings.
acceptContentType(String) - Method in class com.xatkit.core.server.EmptyContentRestHandler
Returns true.
acceptContentType(String) - Method in class com.xatkit.core.server.JsonRestHandler
Returns true if the provided contentType represents a Json content, false otherwise.
acceptContentType(String) - Method in class com.xatkit.core.server.RestHandler
Returns whether the RestHandler accepts the provided contentType.
actionMap - Variable in class com.xatkit.core.platform.RuntimePlatform
The Map containing the RuntimeAction associated to this platform.
addAnnotator(String) - Method in class com.xatkit.core.recognition.processor.StanfordNLPService
Adds the provided annotator to the service.
addAnnotators(List<String>) - Method in class com.xatkit.core.recognition.processor.StanfordNLPService
Adds the provided list of annotators to the service.
addCustomEntityMapping(CustomEntityDefinition, String) - Method in class com.xatkit.core.recognition.dialogflow.DialogFlowEntityMapper
This method is disabled for DialogFlowEntityMapper.
addCustomEntityMapping(CustomEntityDefinition, String) - Method in class com.xatkit.core.recognition.EntityMapper
Adds a new mapping between the provided entityDefinition and the given concreteEntity.
addEntityMapping(EntityType, String) - Method in class com.xatkit.core.recognition.EntityMapper
Adds a new mapping between the provided abstractEntityType and the given concreteEntity.
addEntityMapping(EntityDefinition, String) - Method in class com.xatkit.core.recognition.EntityMapper
Adds a new mapping between the provided entityDefinition and the given concreteEntity.
addMatchableEvent(JsonEventMatcher.HeaderValue, JsonEventMatcher.FieldValue, String) - Method in class com.xatkit.core.platform.io.JsonEventMatcher
Registers a new EventInstance to match from the provided headerValue and fieldValue.
annotate(String) - Method in class com.xatkit.core.recognition.processor.StanfordNLPService
Annotates the provided input with the specified annotators.

B

beforeDelay(int) - Method in class com.xatkit.core.platform.action.RuntimeArtifactAction
A hook that is executed before any delay specified by RuntimeArtifactAction.MESSAGE_DELAY_KEY.
broadcastEventInstance(EventInstance) - Method in class com.xatkit.core.platform.io.RuntimeEventProvider
 
build() - Method in class com.xatkit.core.platform.io.EventInstanceBuilder
Creates a new EventInstance from the provided information.

C

call() - Method in class com.xatkit.core.platform.action.RuntimeAction
Runs the RuntimeAction and returns its result wrapped in a RuntimeActionResult.
call() - Method in class com.xatkit.core.platform.action.RuntimeArtifactAction
Runs the RuntimeArtifactAction and returns its result wrapped in a RuntimeActionResult.
checkOutContexts(IntentDefinition) - Static method in class com.xatkit.core.recognition.dialogflow.DialogFlowCheckingUtils
Checks the out Contexts of the provided intentDefinition.
CLEAN_AGENT_ON_STARTUP_KEY - Static variable in class com.xatkit.core.recognition.dialogflow.DialogFlowApi
The Configuration key to store whether to clean the DialogFlowApi.registeredIntents and DialogFlowApi.registeredEntityTypes when initializing the DialogFlowApi.
clear() - Method in class com.xatkit.core.platform.io.EventInstanceBuilder
Clears the builder and reset its internal fields.
clearEventDefinitions() - Method in class com.xatkit.core.EventDefinitionRegistry
Unregisters all the EventDefinitions from this registry.
clearRegisteredRestHandlers() - Method in class com.xatkit.core.server.XatkitServer
Clears the registered RestHandlers.
clearRuntimePlatforms() - Method in class com.xatkit.core.RuntimePlatformRegistry
Unregisters all the RuntimePlatforms from this registry.
clearXatkitSessions() - Method in class com.xatkit.core.XatkitCore
Invalidates all the XatkitSessions and clear the session registry.
close() - Method in class com.xatkit.core.platform.io.RuntimeEventProvider
Closes the RuntimeEventProvider and releases internal resources.
com.xatkit - package com.xatkit
Xatkit base package.
com.xatkit.core - package com.xatkit.core
Contains the core components of the Xatkit framework.
com.xatkit.core.interpreter - package com.xatkit.core.interpreter
Contains the Xatkit Common Language interpreter.
com.xatkit.core.interpreter.operation - package com.xatkit.core.interpreter.operation
Contains the abstract operations for the Xatkit Common Language interpreter.
com.xatkit.core.interpreter.operation.object - package com.xatkit.core.interpreter.operation.object
Contains Object-specific operation implementations for the Xatkit Common Language interpreter.
com.xatkit.core.platform - package com.xatkit.core.platform
Contains the abstract classes to implement to provide custom platforms.
com.xatkit.core.platform.action - package com.xatkit.core.platform.action
Contains the abstract classes to implement to provide custom platform's actions.
com.xatkit.core.platform.io - package com.xatkit.core.platform.io
Contains the abstract classes to implement to provide custom platform's input provider.
com.xatkit.core.recognition - package com.xatkit.core.recognition
Contains the abstract classes to implement to provide custom intent recognition.
com.xatkit.core.recognition.dialogflow - package com.xatkit.core.recognition.dialogflow
An intent recognition provider implementation for the DialogFlow platform.
com.xatkit.core.recognition.processor - package com.xatkit.core.recognition.processor
 
com.xatkit.core.recognition.regex - package com.xatkit.core.recognition.regex
 
com.xatkit.core.server - package com.xatkit.core.server
Contains the Xatkit server implementation.
com.xatkit.core.session - package com.xatkit.core.session
Contains the classes to manage sessions and contexts.
com.xatkit.util - package com.xatkit.util
Utility classes that are used by the Xatkit framework.
compute() - Method in class com.xatkit.core.platform.action.RestAction
Computes the REST request and returned the handled result.
compute() - Method in class com.xatkit.core.platform.action.RuntimeAction
The concrete implementation of the RuntimeAction's computation.
CONFIDENCE_THRESHOLD_KEY - Static variable in class com.xatkit.core.recognition.dialogflow.DialogFlowApi
The Configuration key to store the DialogFlow confidence threshold.
configuration - Variable in class com.xatkit.core.platform.RuntimePlatform
The Configuration used to initialize this class.
CONFIGURATION_FOLDER_PATH_KEY - Static variable in class com.xatkit.core.XatkitCore
The Configuration key to store the configuration folder path.
construct(Class<T>, Object[]) - Static method in class com.xatkit.util.Loader
Constructs a new instance of clazz with the given parameters.
construct(Class<T>) - Static method in class com.xatkit.util.Loader
Constructs a new instance of the provided clazz using its default constructor.
construct(Class<T>, Class<?>, Object) - Static method in class com.xatkit.util.Loader
Constructs a new instance of the provided clazz with the given parameter.
construct(Class<T>, Class<?>, Class<?>, Object, Object) - Static method in class com.xatkit.util.Loader
Constructs a new instance of the provided clazz with the given parameter1 and parameter2.
construct(Class<T>, List<Class<?>>, List<Object>) - Static method in class com.xatkit.util.Loader
Constructs a new instance of the provided clazz with the given parameters.
constructRuntimeEventProvider(Class<? extends RuntimeEventProvider>, RuntimePlatform, Configuration) - Static method in class com.xatkit.util.Loader
Constructs a new instance of the provided eventProviderClass with the given xatkitCore and configuration.
constructRuntimePlatform(Class<? extends RuntimePlatform>, XatkitCore, Configuration) - Static method in class com.xatkit.util.Loader
Constructs a new instance of the provided runtimePlatformClass with the given xatkitCore and configuration.
containsKeyInternal(String) - Method in class com.xatkit.util.XatkitEnvironmentConfiguration
Returns true if the configuration contains the provided key, false otherwise.
ContentHttpHandler - Class in com.xatkit.core.server
Handles the HTTP requests performed on the /content/ path.
ContentHttpHandler(XatkitServer) - Constructor for class com.xatkit.core.server.ContentHttpHandler
Constructs a new ContentHttpHandler managed by the provided xatkitServer.
convertJsonObjectToOutContext(JsonObject, EventInstanceBuilder) - Method in class com.xatkit.core.platform.io.JsonEventMatcher
Converts the provided jsonObject's fields into out context values set in the provided builder.
convertJsonObjectToOutContext(String, JsonObject, EventInstanceBuilder) - Method in class com.xatkit.core.platform.io.JsonEventMatcher
Converts the provided jsonObject's field into out context values set in the provided builder.
convertParameterValueToString(Value) - Method in class com.xatkit.core.recognition.dialogflow.DialogFlowApi
Converts the provided value into a String.
createEmptyContentRestHandler(RestHandlerFactory.EmptyContentRestHandlerFunction) - Static method in class com.xatkit.core.server.RestHandlerFactory
Creates an EmptyContentRestHandler and sets its handling method with the provided function.
createErrorEntity(RestHandlerException) - Static method in class com.xatkit.core.server.HttpEntityHelper
Creates an HttpEntity representing the error wrapped in the provided RestHandlerException.
createEventInstance(String, JsonElement) - Method in class com.xatkit.core.platform.io.JsonEventMatcher
Creates an EventInstance from the provided eventDefinitionName and content.
createHttpEntity(Object) - Static method in class com.xatkit.core.server.HttpEntityHelper
Creates an HttpEntity from the provided object.
createInContextNames(IntentDefinition) - Method in class com.xatkit.core.recognition.dialogflow.DialogFlowApi
Creates the DialogFlow input Context names from the provided intentDefinition.
createJsonRestHandler(RestHandlerFactory.JsonRestHandlerFunction) - Static method in class com.xatkit.core.server.RestHandlerFactory
Creates a JsonRestHandler and sets its handling method with the provided function.
createOrReplacePublicFile(XatkitSession, String, File) - Method in class com.xatkit.core.server.XatkitServer
Creates a publicly accessible file from the provided session, path, and origin.
createOrReplacePublicFile(XatkitSession, String, String) - Method in class com.xatkit.core.server.XatkitServer
Creates a publicly accessible file from the provided session, path, and content.
createOrReplacePublicFile(XatkitSession, String, byte[]) - Method in class com.xatkit.core.server.XatkitServer
 
createOutContexts(IntentDefinition) - Method in class com.xatkit.core.recognition.dialogflow.DialogFlowApi
Creates the DialogFlow output Contexts from the provided intentDefinition.
createParameters(List<Context>) - Method in class com.xatkit.core.recognition.dialogflow.DialogFlowApi
Creates the DialogFlow context parameters from the provided Xatkit contexts.
createRestHandler() - Method in class com.xatkit.core.platform.io.WebhookEventProvider
Returns the concrete RestHandler instance that handles incoming Rest requests.
createRuntimeAction(XMemberFeatureCall, List<Object>, XatkitSession) - Method in class com.xatkit.core.platform.RuntimePlatform
Creates a new RuntimeAction instance from the provided XMemberFeatureCall.
createSession(String) - Method in class com.xatkit.core.recognition.dialogflow.DialogFlowApi
Creates a new XatkitSession from the provided sessionId.
createSession(String) - Method in class com.xatkit.core.recognition.IntentRecognitionProvider
Creates a new XatkitSession from the provided sessionId.
createSession(String) - Method in class com.xatkit.core.recognition.regex.RegExIntentRecognitionProvider
Creates a new XatkitSession from the provided sessionId.
createTrainingPhrase(String, List<Context>) - Method in class com.xatkit.core.recognition.dialogflow.DialogFlowApi
Creates the DialogFlow's Intent.TrainingPhrase from the provided trainingSentence and outContexts.
CUSTOM_FOLLOWUP_LIFESPAN - Static variable in class com.xatkit.core.recognition.dialogflow.DialogFlowApi
The Configuration key to store the lifespan value to use when creating followup intents.
CUSTOM_LIBRARIES_KEY_PREFIX - Static variable in class com.xatkit.core.XatkitCore
The Configuration key prefix to store the custom library paths.
CUSTOM_PLATFORMS_KEY_PREFIX - Static variable in class com.xatkit.core.XatkitCore
The Configuration key prefix to store the custom platform paths.

D

decrementLifespanCounts() - Method in class com.xatkit.core.session.RuntimeContexts
Decrements the lifespanCount of all the stored contexts, and remove them if there lifespanCount decreases to 0.
DEFAULT_FALLBACK_INTENT - Static variable in class com.xatkit.core.recognition.regex.RegExIntentRecognitionProvider
The Default Fallback Intent that is returned when the user input does not match any registered Intent.
DEFAULT_IS_YES_NO_VALUE - Static variable in class com.xatkit.core.recognition.processor.IsEnglishYesNoQuestionPostProcessor
DEFAULT_LANGUAGE_CODE - Static variable in class com.xatkit.core.recognition.dialogflow.DialogFlowApi
The default language processed by DialogFlow.
DEFAULT_MESSAGE_DELAY - Static variable in class com.xatkit.core.platform.action.RuntimeArtifactAction
The default value of the RuntimeArtifactAction.MESSAGE_DELAY_KEY configuration key (0).
DEFAULT_SENTIMENT_VALUE - Static variable in class com.xatkit.core.recognition.processor.EnglishSentimentPostProcessor
The default value for the EnglishSentimentPostProcessor.SENTIMENT_PARAMETER_KEY parameter.
DEFAULT_SERVER_LOCATION - Static variable in interface com.xatkit.core.server.XatkitServerUtils
The default Xatkit server location.
DEFAULT_SERVER_PORT - Static variable in interface com.xatkit.core.server.XatkitServerUtils
The default port to use.
DEFAULT_VARIABLE_TIMEOUT_VALUE - Static variable in class com.xatkit.core.session.RuntimeContexts
The default amount of time to spend waiting for a context variable (in seconds).
deleteEntityDefinition(EntityDefinition) - Method in class com.xatkit.core.recognition.dialogflow.DialogFlowApi
Deletes the provided entityDefinition from the underlying intent recognition provider.
deleteEntityDefinition(EntityDefinition) - Method in class com.xatkit.core.recognition.IntentRecognitionProvider
Deletes the provided entityDefinition from the underlying intent recognition provider.
deleteEntityDefinition(EntityDefinition) - Method in class com.xatkit.core.recognition.regex.RegExIntentRecognitionProvider
Deletes the provided entityDefinition.
deleteIntentDefinition(IntentDefinition) - Method in class com.xatkit.core.recognition.dialogflow.DialogFlowApi
Deletes the provided intentDefinition from the underlying intent recognition provider.
deleteIntentDefinition(IntentDefinition) - Method in class com.xatkit.core.recognition.IntentRecognitionProvider
Deletes the provided intentDefinition from the underlying intent recognition provider.
deleteIntentDefinition(IntentDefinition) - Method in class com.xatkit.core.recognition.regex.RegExIntentRecognitionProvider
Deletes the provided intentDefinition.
DialogFlowApi - Class in com.xatkit.core.recognition.dialogflow
A concrete wrapper for the DialogFlow API client.
DialogFlowApi(XatkitCore, Configuration) - Constructor for class com.xatkit.core.recognition.dialogflow.DialogFlowApi
Constructs a DialogFlowApi with the provided configuration.
DialogFlowApi(XatkitCore, Configuration, RecognitionMonitor) - Constructor for class com.xatkit.core.recognition.dialogflow.DialogFlowApi
Constructs a DialogFlowApi with the provided configuration.
DialogFlowCheckingUtils - Class in com.xatkit.core.recognition.dialogflow
An utility class that provides checking methods for DialogFlow models.
DialogFlowEntityMapper - Class in com.xatkit.core.recognition.dialogflow
An EntityMapper initialized with DialogFlow's system entities.
DialogFlowEntityMapper() - Constructor for class com.xatkit.core.recognition.dialogflow.DialogFlowEntityMapper
Constructs a DialogFlowEntityMapper initialized with DialogFlow's system entities.
DialogFlowException - Exception in com.xatkit.core.recognition.dialogflow
Wraps all the exceptions returned by the DialogFlow API.
DialogFlowException() - Constructor for exception com.xatkit.core.recognition.dialogflow.DialogFlowException
Constructs a new DialogFlowException.
DialogFlowException(String) - Constructor for exception com.xatkit.core.recognition.dialogflow.DialogFlowException
Constructs a new DialogFlowException from the provided message.
DialogFlowException(String, Throwable) - Constructor for exception com.xatkit.core.recognition.dialogflow.DialogFlowException
Constructs a new DialogFlowException from the provided message and cause.
DialogFlowException(Throwable) - Constructor for exception com.xatkit.core.recognition.dialogflow.DialogFlowException
Constructs a new DialogFlowException from the provided cause.
DialogFlowException(String, Throwable, boolean, boolean) - Constructor for exception com.xatkit.core.recognition.dialogflow.DialogFlowException
Constructs a new DialogFlowException from the provided message, cause, enableSuppression, and writableStackTrace.
DialogFlowSession - Class in com.xatkit.core.recognition.dialogflow
A DialogFlow XatkitSession implementation that relies on DialogFlow internal sessions.
DialogFlowSession(SessionName) - Constructor for class com.xatkit.core.recognition.dialogflow.DialogFlowSession
Constructs a new DialogFlowSession from the provided sessionName.
DialogFlowSession(SessionName, Configuration) - Constructor for class com.xatkit.core.recognition.dialogflow.DialogFlowSession
Constructs a new DialogFlowSession from the provided sessionName and configuration.
disableAction(ActionDefinition) - Method in class com.xatkit.core.platform.RuntimePlatform
Disables the RuntimeAction defined by the provided ActionDefinition.
disableAllActions() - Method in class com.xatkit.core.platform.RuntimePlatform
Disables all the RuntimeActions of the RuntimePlatform.
doEvaluate(XExpression, IEvaluationContext, CancelIndicator) - Method in class com.xatkit.core.ExecutionService
Evaluates the provided expression.

E

EMFUtils - Class in com.xatkit.util
An utility class providing helpers for EMF objects.
EMFUtils() - Constructor for class com.xatkit.util.EMFUtils
 
EMPTY_FIELD_VALUE - Static variable in class com.xatkit.core.platform.io.JsonEventMatcher.FieldValue
A static JsonEventMatcher.FieldValue used to match requests without inspecting its Json fields.
EmptyContentRestHandler - Class in com.xatkit.core.server
A handler that receives HTTP requests with empty content and process them.
EmptyContentRestHandler() - Constructor for class com.xatkit.core.server.EmptyContentRestHandler
 
ENABLE_ENTITY_LOADING_KEY - Static variable in class com.xatkit.core.recognition.dialogflow.DialogFlowApi
The Configuration key to store whether to initialize the DialogFlowApi.registeredEntityTypes Map with the EntityTypes already stored in the DialogFlow project.
ENABLE_INTENT_LOADING_KEY - Static variable in class com.xatkit.core.recognition.dialogflow.DialogFlowApi
The Configuration key to store whether to initialize the DialogFlowApi.registeredIntents Map with the Intents already stored in the DialogFlow project.
ENABLE_LOCAL_CONTEXT_MERGE_KEY - Static variable in class com.xatkit.core.recognition.dialogflow.DialogFlowApi
The Configuration key to store whether to merge the local XatkitSession in the DialogFlow one.
ENABLE_RECOGNITION_ANALYTICS - Static variable in class com.xatkit.core.recognition.IntentRecognitionProviderFactory
The Configuration key used to specify whether to enable intent recognition monitoring.
enableAction(ActionDefinition) - Method in class com.xatkit.core.platform.RuntimePlatform
Retrieves and loads the RuntimeAction defined by the provided ActionDefinition.
EnglishSentimentPostProcessor - Class in com.xatkit.core.recognition.processor
Computes the sentiment associated to the last sentence of the user input.
EnglishSentimentPostProcessor() - Constructor for class com.xatkit.core.recognition.processor.EnglishSentimentPostProcessor
Constructs an instance of this post-processor.
entities - Variable in class com.xatkit.core.recognition.EntityMapper
The Map storing the abstract-to-concrete entity mappings.
EntityMapper - Class in com.xatkit.core.recognition
A mapper that bind concrete entity names to their abstract definitions.
EntityMapper() - Constructor for class com.xatkit.core.recognition.EntityMapper
Constructs a new EntityMapper.
entityMapper - Variable in class com.xatkit.core.recognition.regex.RegExIntentRecognitionProvider
The EntityMapper used to store system and dynamic entity mappings.
equals(Object) - Method in class com.xatkit.core.platform.io.JsonEventMatcher.FieldValue
Checks if the provided obj is equal to this JsonEventMatcher.FieldValue.
equals(Object) - Method in class com.xatkit.core.platform.io.JsonEventMatcher.HeaderValue
Checks if the provided obj is equal to this JsonEventMatcher.HeaderValue.
EventDefinitionRegistry - Class in com.xatkit.core
A registry that stores EventDefinitions and provide utility methods to retrieve them.
EventDefinitionRegistry() - Constructor for class com.xatkit.core.EventDefinitionRegistry
Constructs a new instance of the registry and initializes its EventDefinitionRegistry.eventDefinitionMap.
EventInstanceBuilder - Class in com.xatkit.core.platform.io
A fluent EventInstance builder.
eventInstanceBuilder - Variable in class com.xatkit.core.platform.io.JsonEventMatcher
The EventInstanceBuilder used to reify the received payloads into EventInstances.
eventProviderMap - Variable in class com.xatkit.core.platform.RuntimePlatform
The Map containing the RuntimePlatform.EventProviderThreads associated to this platform.
EventProviderThread(RuntimeEventProvider) - Constructor for class com.xatkit.core.platform.RuntimePlatform.EventProviderThread
Constructs a new RuntimePlatform.EventProviderThread to run the provided runtimeEventProvider
EXECUTION_MODEL_KEY - Static variable in class com.xatkit.core.XatkitCore
The Configuration key to store the ExecutionModel to use.
executionResourceSet - Variable in class com.xatkit.core.XatkitCore
The ResourceSet used to load the ExecutionModel and the referenced models.
ExecutionService - Class in com.xatkit.core
A service that handles EventInstances and executes the corresponding RuntimeActions defined in the provided ExecutionModel.
ExecutionService(ExecutionModel, RuntimePlatformRegistry, Configuration) - Constructor for class com.xatkit.core.ExecutionService
Constructs a new ExecutionService based on the provided executionModel and runtimePlatformRegistry.
executionService - Variable in class com.xatkit.core.XatkitCore
The ExecutionService used to handle EventInstances and execute the associated RuntimeActions.

F

FALLBACK_ENTITY_KEY - Static variable in class com.xatkit.core.recognition.EntityMapper
The key used to register the concrete fallback entity.
FieldValue(String, String) - Constructor for class com.xatkit.core.platform.io.JsonEventMatcher.FieldValue
Constructs a new JsonEventMatcher.FieldValue from the provided key and value.
FileUtils - Class in com.xatkit.util
Utility methods to load Xatkit-related files.
FileUtils() - Constructor for class com.xatkit.util.FileUtils
 
finalize() - Method in class com.xatkit.core.recognition.dialogflow.DialogFlowApi
Closes the DialogFlow session if it is not shutdown yet.
finalize() - Method in class com.xatkit.core.XatkitCore
Logs a warning message and stops the running services if the XatkitCore hasn't been closed properly.
FOLLOW_CONTEXT_NAME_SUFFIX - Static variable in class com.xatkit.core.recognition.regex.RegExIntentRecognitionProvider
The context name suffix used to identify follow-up contexts.
format(Object) - Method in class com.xatkit.core.platform.Formatter
Formats the provided obj.
Formatter - Class in com.xatkit.core.platform
Provides mapping function from execution-level Objects to their String representation.
Formatter() - Constructor for class com.xatkit.core.platform.Formatter
Constructs the Formatter and initializes its format functions.

G

get(String) - Method in class com.xatkit.core.session.XatkitSession
Retrieves the session value associated to the provided key.
getAccessControlAllowHeaders() - Method in class com.xatkit.core.server.RestHandler
Returns the Access-Control-Allow-Headers HTTP header values that must be set by the server when calling this handler.
getActionName(XMemberFeatureCall) - Static method in class com.xatkit.util.XbaseUtils
Returns the name of the action corresponding to the provided actionCall.
getActions() - Method in class com.xatkit.core.platform.RuntimePlatform
Returns all the RuntimeAction Classes associated to this RuntimePlatform.
getAllEventDefinitions() - Method in class com.xatkit.core.EventDefinitionRegistry
Returns an unmodifiable Collection containing all the registered EventDefinitions.
getAllIntentDefinitions() - Method in class com.xatkit.core.EventDefinitionRegistry
Returns an unmodifiable Collection containing all the registered IntentDefinitions.
getAnnotation(String, XatkitSession) - Method in class com.xatkit.core.recognition.processor.StanfordNLPPostProcessor
Computes the Annotation for the provided input.
getBaseURL() - Method in class com.xatkit.core.server.XatkitServer
Returns the URL of the XatkitServer.
getClientSession() - Method in class com.xatkit.core.platform.action.RuntimeArtifactAction
Returns the XatkitSession associated to the client of the artifact to send.
getConfiguration() - Method in class com.xatkit.core.platform.RuntimePlatform
Returns the platform's Configuration.
getConfiguration() - Method in class com.xatkit.core.session.XatkitSession
Returns the Configuration defining the session behavior.
getConfiguration() - Static method in class com.xatkit.Xatkit
Returns the Configuration used to initialize the XatkitCore instance.
getContextLifespanCount(String) - Method in class com.xatkit.core.session.RuntimeContexts
Returns the lifespan count of the provided context.
getContextMap() - Method in class com.xatkit.core.session.RuntimeContexts
Returns an unmodifiable Map representing the stored context values.
getContextValue(String, String) - Method in class com.xatkit.core.session.RuntimeContexts
Returns the context value associated to the provided key.
getContextVariables(String) - Method in class com.xatkit.core.session.RuntimeContexts
Returns all the variables stored in the given context.
getEndpointMethod() - Method in class com.xatkit.core.platform.io.WebhookEventProvider
Returns the HttpMethod of the REST endpoint to register the provided to.
getEndpointURI() - Method in class com.xatkit.core.platform.io.WebhookEventProvider
Returns the URI of the REST endpoint to register the provider to.
getErrorCode() - Method in exception com.xatkit.core.server.RestHandlerException
Returns the HTTP error code associated to this exception.
getEventDefinition(String) - Method in class com.xatkit.core.EventDefinitionRegistry
Returns the EventDefinition matching the provided name.
getEventDefinitionName() - Method in class com.xatkit.core.platform.io.EventInstanceBuilder
Returns the name of the EventDefinition to bind to the created EventInstance.
getEventDefinitionOutContext(String) - Method in class com.xatkit.core.EventDefinitionRegistry
Retrieve the Context matching the provided contextName from the registered EventDefinitions.
getEventDefinitionRegistry() - Method in class com.xatkit.core.XatkitCore
Returns the EventDefinitionRegistry associated to this instance.
getEventProviderMap() - Method in class com.xatkit.core.platform.RuntimePlatform
Returns Map containing the RuntimePlatform.EventProviderThreads associated to this platform.
getExecutionModel() - Method in class com.xatkit.core.ExecutionService
Returns the ExecutionModel associated to this ExecutionService.
getExecutionModel(Configuration) - Method in class com.xatkit.core.XatkitCore
Retrieves the ExecutionModel from the provided property.
getExecutionService() - Method in class com.xatkit.core.XatkitCore
Returns the underlying ExecutionService.
getExecutionTime() - Method in class com.xatkit.core.platform.action.RuntimeActionResult
Returns the execution time value (in milliseconds) stored in this RuntimeActionResult.
getExecutorService() - Method in class com.xatkit.core.ExecutionService
Returns the ExecutorService used to process RuntimeActions.
getFile(String, Configuration) - Static method in class com.xatkit.util.FileUtils
Retrieves the File corresponding to the provided path.
getFormatter(String) - Method in class com.xatkit.core.XatkitCore
Returns the Formatter associated to the provided formatterName.
getHeaderValue(List<Header>, String) - Method in class com.xatkit.core.server.RestHandler
Returns the Header value associated to the provided headerKey.
getHttpServer() - Method in class com.xatkit.core.server.XatkitServer
Returns the underlying HttpServer used to receive requests.
getInstance() - Static method in class com.xatkit.core.recognition.processor.StanfordNLPService
Returns the singleton instance of this class.
getIntent(String, XatkitSession) - Method in class com.xatkit.core.recognition.IntentRecognitionProvider
Returns the RecognizedIntent extracted from te provided input.
getIntentDefinition(String) - Method in class com.xatkit.core.EventDefinitionRegistry
Returns the IntentDefinition matching the provided name.
getIntentInternal(String, XatkitSession) - Method in class com.xatkit.core.recognition.dialogflow.DialogFlowApi
Returns the raw RecognizedIntent extracted from the provided input.
getIntentInternal(String, XatkitSession) - Method in class com.xatkit.core.recognition.IntentRecognitionProvider
Returns the raw RecognizedIntent extracted from the provided input.
getIntentInternal(String, XatkitSession) - Method in class com.xatkit.core.recognition.regex.RegExIntentRecognitionProvider
Computes the RecognizedIntent associated to the provided input.
getIntentRecognitionProvider(XatkitCore, Configuration) - Static method in class com.xatkit.core.recognition.IntentRecognitionProviderFactory
Returns the IntentRecognitionProvider matching the provided configuration.
getIntentRecognitionProvider() - Method in class com.xatkit.core.XatkitCore
Returns the underlying IntentRecognitionProvider.
getJsonBody(InputStream) - Static method in class com.xatkit.core.platform.action.RestAction
Extracts the JsonElement contained in the provided is.
getJsonElementFromHttpEntity(HttpEntity) - Static method in class com.xatkit.core.server.HttpEntityHelper
Returns a JsonElement extracted from the content of the provided entity.
getJsonElementFromJsonObject(JsonObject, String) - Static method in class com.xatkit.core.server.JsonRestHandler.JsonHelper
Returns the JsonElement associated to the given key in the provided object.
getKey() - Method in class com.xatkit.core.platform.io.JsonEventMatcher.FieldValue
Returns the key of the JsonEventMatcher.FieldValue.
getKey() - Method in class com.xatkit.core.platform.io.JsonEventMatcher.HeaderValue
Returns the key of the JsonEventMatcher.HeaderValue.
getLanguageCode() - Method in class com.xatkit.core.recognition.dialogflow.DialogFlowApi
Returns the code of the language processed by DialogFlow.
getLifespanCountsMap() - Method in class com.xatkit.core.session.RuntimeContexts
Returns an unmodifiable Map representing the stored lifespan counts.
getLoadedPlatformDefinitions() - Method in class com.xatkit.core.RuntimePlatformRegistry
Returns a Collection containing all the loaded PlatformDefinitions.
getMappingFor(EntityType) - Method in class com.xatkit.core.recognition.EntityMapper
Returns the concreteEntity mapped to the provided abstractEntityType.
getMappingFor(EntityDefinition) - Method in class com.xatkit.core.recognition.EntityMapper
Returns the concreteEntity mapped to the provided abstractEntity.
getMappingForCustomEntity(CustomEntityDefinition) - Method in class com.xatkit.core.recognition.dialogflow.DialogFlowEntityMapper
Maps the provided customEntityDefinition to its DialogFlow implementation.
getMappingForCustomEntity(CustomEntityDefinition) - Method in class com.xatkit.core.recognition.EntityMapper
Returns the String representing the entity mapped from the provided customEntityDefinition.
getMessage() - Method in class com.xatkit.core.platform.action.RuntimeMessageAction
Returns the processed message.
getName() - Method in class com.xatkit.core.platform.RuntimePlatform
Returns the name of the platform.
getName(EObject) - Static method in class com.xatkit.util.EMFUtils
Computes the name of the provided eObject.
getOrCreateXatkitSession(String) - Method in class com.xatkit.core.XatkitCore
Retrieves or creates the XatkitSession associated to the provided sessionId.
getOutContextValues() - Method in class com.xatkit.core.platform.io.EventInstanceBuilder
Returns an unmodifiable Map containing the output context parameters to bind to the EventInstance.
getParameters(HttpRequest) - Static method in class com.xatkit.core.server.HttpUtils
Returns a List containing the parameters associated to the provided httpRequest.
getParameterValue(String, List<NameValuePair>) - Static method in class com.xatkit.core.server.HttpUtils
Returns the value associated to the provided parameterName from the given parameters list.
getPath(HttpRequest) - Static method in class com.xatkit.core.server.HttpUtils
Returns the path associated to the provided httpRequest.
getPlatformDefinition(String) - Method in class com.xatkit.core.RuntimePlatformRegistry
 
getPlatformName(XMemberFeatureCall) - Static method in class com.xatkit.util.XbaseUtils
Returns the name of the platform corresponding to the provided actionCall.
getPort() - Method in class com.xatkit.core.server.XatkitServer
Returns the port the server is listening to.
getProjectId() - Method in class com.xatkit.core.recognition.dialogflow.DialogFlowApi
Returns the DialogFlow project unique identifier.
getPropertyInternal(String) - Method in class com.xatkit.util.XatkitEnvironmentConfiguration
Retrieves the value associated to the provided key.
getPublicFile(XatkitSession, String) - Method in class com.xatkit.core.server.XatkitServer
Retrieves the public File associated to the provided session and filePath.
getPublicFile(String) - Method in class com.xatkit.core.server.XatkitServer
Retrieves the public File associated to the provided filePath.
getPublicURL(File) - Method in class com.xatkit.core.server.XatkitServer
Retrieves the public URL associated to the provided file if it exists.
getRecognitionMonitor() - Method in class com.xatkit.core.recognition.dialogflow.DialogFlowApi
Returns the RecognitionMonitor associated to this intent recognition provider.
getRecognitionMonitor() - Method in class com.xatkit.core.recognition.IntentRecognitionProvider
Returns the RecognitionMonitor associated to this intent recognition provider.
getRecognitionMonitor() - Method in class com.xatkit.core.recognition.regex.RegExIntentRecognitionProvider
Returns the RecognitionMonitor associated to this intent recognition provider.
getRecognizedIntent(String, XatkitSession, XatkitCore) - Static method in class com.xatkit.core.platform.io.IntentRecognitionHelper
Returns the RecognizedIntent from the provided user input and session.
getRegisteredRestHandler(HttpMethod, String) - Method in class com.xatkit.core.server.XatkitServer
Returns the RestHandler associated to the provided uri with the given httpMethod.
getRegisteredRestHandlers() - Method in class com.xatkit.core.server.XatkitServer
Returns a Collection containing the registered RestHandlers.
getRestHandler() - Method in class com.xatkit.core.platform.io.WebhookEventProvider
Returns the RestHandler embedded in this provider.
getResult() - Method in class com.xatkit.core.platform.action.RuntimeActionResult
Returns the raw result stored in this RuntimeActionResult.
getRuntimeContexts() - Method in class com.xatkit.core.session.XatkitSession
Returns the session's RuntimeContexts holding context-related variables.
getRuntimeEventProvider() - Method in class com.xatkit.core.platform.RuntimePlatform.EventProviderThread
Returns the RuntimeEventProvider run by this Thread.
getRuntimePlatform() - Method in class com.xatkit.core.platform.io.RuntimeEventProvider
Returns the RuntimePlatform containing this RuntimeEventProvider.
getRuntimePlatform(String) - Method in class com.xatkit.core.RuntimePlatformRegistry
Returns the RuntimePlatform associated to the provided platformName.
getRuntimePlatform(PlatformDefinition) - Method in class com.xatkit.core.RuntimePlatformRegistry
Returns the RuntimePlatform associated to the provided platformDefinition.
getRuntimePlatformRegistry() - Method in class com.xatkit.core.ExecutionService
Returns the RuntimePlatformRegistry associated to this ExecutionService.
getRuntimePlatformRegistry() - Method in class com.xatkit.core.XatkitCore
Returns the RuntimePlatformRegistry associated to this instance.
getRuntimePlatforms() - Method in class com.xatkit.core.RuntimePlatformRegistry
Returns all the RuntimePlatforms stored in this registry.
getSession() - Method in class com.xatkit.core.platform.action.RuntimeAction
Returns the XatkitSession used to compute this action.
getSessionId() - Method in class com.xatkit.core.session.XatkitSession
Returns the unique identifier of the XatkitSession.
getSessionName() - Method in class com.xatkit.core.recognition.dialogflow.DialogFlowSession
Returns the raw DialogFlow session.
getSessionVariables() - Method in class com.xatkit.core.session.XatkitSession
Returns a Map containing the session variables.
getStringBody(InputStream) - Static method in class com.xatkit.core.platform.action.RestAction
Extracts the String contained in the provided is.
getStringFromHttpEntity(HttpEntity) - Static method in class com.xatkit.core.server.HttpEntityHelper
Returns the String representation of the content of the provided entity.
getThrownException() - Method in class com.xatkit.core.platform.action.RuntimeActionResult
Return the Exception that has been thrown during the computation.
getURIBuilderFrom(HttpRequest) - Static method in class com.xatkit.core.server.HttpUtils
Returns a URIBuilder from the provided httpRequest.
getValue() - Method in class com.xatkit.core.platform.io.JsonEventMatcher.FieldValue
Returns the value of the JsonEventMatcher.FieldValue.
getValue() - Method in class com.xatkit.core.platform.io.JsonEventMatcher.HeaderValue
Returns the value of the JsonEventMatcher.HeaderValue.
getVariableTimeout() - Method in class com.xatkit.core.session.RuntimeContexts
Returns the amount of time the RuntimeContexts can spend waiting for a context variable (in seconds).
getXatkitCore() - Method in class com.xatkit.core.platform.RuntimePlatform
Returns the XatkitCore instance associated to this platform.
getXatkitCore() - Static method in class com.xatkit.Xatkit
Returns the XatkitCore instance used to run the bot.
getXatkitDirectory() - Static method in class com.xatkit.util.FileUtils
Returns the Xatkit installation directory.
getXatkitServer() - Method in class com.xatkit.core.XatkitCore
Returns the XatkitServer used to capture incoming webhooks.
getXatkitSession(String) - Method in class com.xatkit.core.XatkitCore
Returns the XatkitSession associated to the provided sessionId
getXatkitSessions() - Method in class com.xatkit.core.XatkitCore
 
GOOGLE_CREDENTIALS_PATH_KEY - Static variable in class com.xatkit.core.recognition.dialogflow.DialogFlowApi
The Configuration key to store the path of the JSON credential file for DialogFlow.

H

handle(HttpRequest, HttpResponse, HttpContext) - Method in class com.xatkit.core.server.ContentHttpHandler
Handles the received request and fill the provided response with the retrieved File to serve.
handle(List<Header>, List<NameValuePair>, Object) - Method in interface com.xatkit.core.server.RestHandlerFactory.EmptyContentRestHandlerFunction
The handling function of EmptyContentRestHandler.
handle(List<Header>, List<NameValuePair>, JsonElement) - Method in interface com.xatkit.core.server.RestHandlerFactory.JsonRestHandlerFunction
The handling function of JsonRestHandler.
handleContent(List<Header>, List<NameValuePair>, Object) - Method in class com.xatkit.core.server.RestHandler
Handles the raw HTTP request.
handleEventInstance(EventInstance, XatkitSession) - Method in class com.xatkit.core.ExecutionService
Handles the provided eventInstance and executes the corresponding RuntimeActions defined in the ExecutionModel.
handleParsedContent(List<Header>, List<NameValuePair>, Object) - Method in class com.xatkit.core.server.EmptyContentRestHandler
Handles the request.
handleParsedContent(List<Header>, List<NameValuePair>, JsonElement) - Method in class com.xatkit.core.server.JsonRestHandler
Handles the received headers, params, and JsonElement parsed from the request payload.
handleParsedContent(List<Header>, List<NameValuePair>, C) - Method in class com.xatkit.core.server.RestHandler
Handles the received headers, params, and parsed payload.
handleResponse(Headers, int, InputStream) - Method in class com.xatkit.core.platform.action.RestAction
Handles the REST API response and computes the action's results
hashCode() - Method in class com.xatkit.core.platform.io.JsonEventMatcher.FieldValue
Computes the hash code associated to this JsonEventMatcher.FieldValue.
hashCode() - Method in class com.xatkit.core.platform.io.JsonEventMatcher.HeaderValue
Computes the hash code associated to this JsonEventMatcher.HeaderValue.
headers - Variable in class com.xatkit.core.platform.action.RestAction
A Map containing user-defined headers to include in the request.
HeaderValue(String, String) - Constructor for class com.xatkit.core.platform.io.JsonEventMatcher.HeaderValue
Constructs a new JsonEventMatcher.HeaderValue from the provided key and value.
HttpEntityHelper - Class in com.xatkit.core.server
Contains utility methods to manipulate and create HttpEntity instances.
HttpEntityHelper() - Constructor for class com.xatkit.core.server.HttpEntityHelper
 
HttpMethod - Enum in com.xatkit.core.server
Utility enum holding supported Http methods.
HttpUtils - Class in com.xatkit.core.server
Provides utility methods to manipulate Http-related objects.
HttpUtils() - Constructor for class com.xatkit.core.server.HttpUtils
 

I

init() - Method in class com.xatkit.core.platform.action.RuntimeAction
A hook method that is called after RuntimeAction.
init() - Method in class com.xatkit.core.platform.action.RuntimeArtifactAction
Retrieve the XatkitSession associated to the client of the artifact and merges it with the current one.
init() - Method in interface com.xatkit.core.recognition.processor.InputPreProcessor
Initializes the pre-processor.
init() - Method in interface com.xatkit.core.recognition.processor.IntentPostProcessor
Initializes the post-processor.
init() - Method in class com.xatkit.core.recognition.processor.StanfordNLPPostProcessor
Initialize the underlying StanfordNLPService and performs a warm-up annotation on it.
init() - Method in class com.xatkit.core.recognition.processor.StanfordNLPService
Initialize the underlying StanfordCoreNLP pipeline with the provided annotators.
InputPreProcessor - Interface in com.xatkit.core.recognition.processor
Applies a pre-processing function on the provided input.
intentPatterns - Variable in class com.xatkit.core.recognition.regex.RegExIntentRecognitionProvider
The Map used to store RegExp Patterns associated to the registered IntentDefinition.
IntentPostProcessor - Interface in com.xatkit.core.recognition.processor
Applies a post-processing function on the provided recognizedIntent.
IntentRecognitionHelper - Class in com.xatkit.core.platform.io
A helper class that provides method to extract intents from input text.
IntentRecognitionHelper() - Constructor for class com.xatkit.core.platform.io.IntentRecognitionHelper
 
IntentRecognitionProvider - Class in com.xatkit.core.recognition
A unified wrapper for concrete intent recognition providers.
IntentRecognitionProvider() - Constructor for class com.xatkit.core.recognition.IntentRecognitionProvider
 
IntentRecognitionProviderException - Exception in com.xatkit.core.recognition
Wraps all the exceptions thrown by the IntentRecognitionProviders.
IntentRecognitionProviderException() - Constructor for exception com.xatkit.core.recognition.IntentRecognitionProviderException
IntentRecognitionProviderException(String) - Constructor for exception com.xatkit.core.recognition.IntentRecognitionProviderException
Constructs a new IntentRecognitionProviderException from the provided message.
IntentRecognitionProviderException(String, Throwable) - Constructor for exception com.xatkit.core.recognition.IntentRecognitionProviderException
Constructs a new IntentRecognitionProviderException from the provided message and cause.
IntentRecognitionProviderException(Throwable) - Constructor for exception com.xatkit.core.recognition.IntentRecognitionProviderException
Constructs a new IntentRecognitionProviderException from the provided cause.
IntentRecognitionProviderException(String, Throwable, boolean, boolean) - Constructor for exception com.xatkit.core.recognition.IntentRecognitionProviderException
Constructs a new IntentRecognitionProviderException from the provided message, cause, enableSuppression, and writableStackTrace.
IntentRecognitionProviderFactory - Class in com.xatkit.core.recognition
Builds IntentRecognitionProviders from the provided configuration.
IntentRecognitionProviderFactory() - Constructor for class com.xatkit.core.recognition.IntentRecognitionProviderFactory
 
IS_YES_NO_PARAMETER_KEY - Static variable in class com.xatkit.core.recognition.processor.IsEnglishYesNoQuestionPostProcessor
The context parameter key used to store whether the user input is a yes/no question.
IsEnglishYesNoQuestionPostProcessor - Class in com.xatkit.core.recognition.processor
Computes whether the last sentence of the user input is a yes/no question.
IsEnglishYesNoQuestionPostProcessor() - Constructor for class com.xatkit.core.recognition.processor.IsEnglishYesNoQuestionPostProcessor
Constructs an instance of this post-processor.
isError() - Method in class com.xatkit.core.platform.action.RuntimeActionResult
Returns whether the RuntimeActionResult represents an errored computation.
isPlatformActionCall(XMemberFeatureCall, RuntimePlatformRegistry) - Static method in class com.xatkit.util.XbaseUtils
Returns true if the provided featureCall is a platform's action call, false otherwise.
isRestEndpoint(HttpMethod, String) - Method in class com.xatkit.core.server.XatkitServer
Returns whether the provided httpMethod on the given uri is associated to a REST endpoint.
isShutdown() - Method in class com.xatkit.core.ExecutionService
Returns whether the ExecutionService is shutdown.
isShutdown() - Method in class com.xatkit.core.recognition.dialogflow.DialogFlowApi
Returns whether the intent recognition provider client is shutdown.
isShutdown() - Method in class com.xatkit.core.recognition.IntentRecognitionProvider
Returns whether the intent recognition provider client is shutdown.
isShutdown() - Method in class com.xatkit.core.recognition.regex.RegExIntentRecognitionProvider
Returns whether the intent recognition provider client is shutdown.
isShutdown() - Method in class com.xatkit.core.XatkitCore
Returns whether the XatkitCore client is shutdown.
isStarted() - Method in class com.xatkit.core.server.XatkitServer
Returns true if the XatkitServer is started, false otherwise.

J

jsonContent - Variable in class com.xatkit.core.platform.action.RestAction
The JsonElement to include in the request's body.
JsonEventMatcher - Class in com.xatkit.core.platform.io
A matcher that creates EventInstances from Json webhook calls.
JsonEventMatcher(EventInstanceBuilder, Configuration) - Constructor for class com.xatkit.core.platform.io.JsonEventMatcher
Constructs a new JsonEventMatcher with the provided EventInstanceBuilder.
JsonEventMatcher.FieldValue - Class in com.xatkit.core.platform.io
A pair representing a field value to match.
JsonEventMatcher.HeaderValue - Class in com.xatkit.core.platform.io
A pair representing a Header value to match.
JsonHelper() - Constructor for class com.xatkit.core.server.JsonRestHandler.JsonHelper
 
JsonRestHandler - Class in com.xatkit.core.server
A handler that receives HTTP requests containing JSON and process them.
JsonRestHandler() - Constructor for class com.xatkit.core.server.JsonRestHandler
 
JsonRestHandler.JsonHelper - Class in com.xatkit.core.server
A static class containing utility methods to manipulate Json contents.

L

label - Variable in enum com.xatkit.core.server.HttpMethod
The literal of the enum value.
LANGUAGE_CODE_KEY - Static variable in class com.xatkit.core.recognition.dialogflow.DialogFlowApi
The Configuration key to store the code of the language processed by DialogFlow.
loadClass(String, Class<T>) - Static method in class com.xatkit.util.Loader
Loads the Class with the provided qualifiedName, and casts it to the provided superClass.
Loader - Class in com.xatkit.util
Provides a set of utility methods to dynamically load and construct classes.
Loader() - Constructor for class com.xatkit.util.Loader
 
logRecognizedIntent(XatkitSession, RecognizedIntent) - Method in class com.xatkit.core.recognition.RecognitionMonitor
Logs the recognition information from the provided recognizedIntent and session.

M

main(String[]) - Static method in class com.xatkit.Xatkit
Starts the underlying XatkitCore engine.
match(List<Header>, JsonElement) - Method in class com.xatkit.core.platform.io.JsonEventMatcher
Matches the provided headers and content against the registered EventInstances.
matchableEvents - Variable in class com.xatkit.core.platform.io.JsonEventMatcher
The internal Map used to store the header and field values to match.
MATCHED_EVENT_SESSION_KEY - Static variable in class com.xatkit.core.ExecutionService
The XatkitSession key used to store the matched event.
merge(RuntimeContexts) - Method in class com.xatkit.core.session.RuntimeContexts
Merges the provided other RuntimeContexts into this one.
merge(XatkitSession) - Method in class com.xatkit.core.session.XatkitSession
Merges this XatkitSession with the provided other.
mergeLocalSessionInDialogFlow(DialogFlowSession) - Method in class com.xatkit.core.recognition.dialogflow.DialogFlowApi
Merges the local DialogFlowSession in the remote DialogFlow API one.
message - Variable in class com.xatkit.core.platform.action.RuntimeMessageAction
The processed message.
MESSAGE_DELAY_KEY - Static variable in class com.xatkit.core.platform.action.RuntimeArtifactAction
The Configuration key used to specify the delay (in milliseconds) before sending a message.
method - Variable in class com.xatkit.core.platform.action.RestAction
The RestAction.MethodKind of the request to perform.

N

newBuilder(EventDefinitionRegistry) - Static method in class com.xatkit.core.platform.io.EventInstanceBuilder
Creates a new EventInstanceBuilder from the provided registry.
NLP_ANNOTATION_SESSION_KEY - Static variable in class com.xatkit.core.recognition.processor.StanfordNLPPostProcessor
The XatkitSession key used to store the last annotation.
NLP_CONTEXT_KEY - Static variable in class com.xatkit.core.recognition.processor.StanfordNLPPostProcessor
The context key used to store Stanford NLP information.
NLP_INPUT_SESSION_KEY - Static variable in class com.xatkit.core.recognition.processor.StanfordNLPPostProcessor
The XatkitSession key used to store the last annotated input.
notifyRestHandler(HttpMethod, String, List<Header>, List<NameValuePair>, Object, String) - Method in class com.xatkit.core.server.XatkitServer
Notifies the REST endpoint associated with the provided uri.

O

of(String, String) - Static method in class com.xatkit.core.platform.io.JsonEventMatcher.FieldValue
Constructs a new JsonEventMatcher.FieldValue from the provided key and value.
of(String, String) - Static method in class com.xatkit.core.platform.io.JsonEventMatcher.HeaderValue
Constructs a new JsonEventMatcher.HeaderValue from the provided key and value.

P

params - Variable in class com.xatkit.core.platform.action.RestAction
A Map containing user-defined parameters to include in the request.
parseContent(Object) - Method in class com.xatkit.core.server.EmptyContentRestHandler
Checks that the provided content object is null and returns it.
parseContent(Object) - Method in class com.xatkit.core.server.JsonRestHandler
Parses the provided raw HTTP request content into a JsonElement.
parseContent(Object) - Method in class com.xatkit.core.server.RestHandler
Parses the provided raw HTTP request content.
prettyPrintEventDefinition() - Method in class com.xatkit.core.platform.io.EventInstanceBuilder
Prints a pretty representation of the current EventDefinition to instantiate with this builder.
PRINT_BUILDER_CONTENT_KEY - Static variable in class com.xatkit.core.platform.io.JsonEventMatcher
The Configuration key to store whether to print the EventInstanceBuilder content before building the matched EventInstance.
printBuilder - Variable in class com.xatkit.core.platform.io.JsonEventMatcher
A flag telling whether to print the EventInstanceBuilder content before building the matched EventInstance.
process(RecognizedIntent, XatkitSession) - Method in class com.xatkit.core.recognition.processor.EnglishSentimentPostProcessor
Processes the provided recognizedIntent and sets the nlp.sentiment context parameter.
process(String, XatkitSession) - Method in interface com.xatkit.core.recognition.processor.InputPreProcessor
Processes the provided input.
process(RecognizedIntent, XatkitSession) - Method in interface com.xatkit.core.recognition.processor.IntentPostProcessor
Processes the provided recognizedIntent.
process(RecognizedIntent, XatkitSession) - Method in class com.xatkit.core.recognition.processor.IsEnglishYesNoQuestionPostProcessor
Processes the provided recognizedIntent and sets the nlp.isYesNo context parameter.
process(RecognizedIntent, XatkitSession) - Method in class com.xatkit.core.recognition.processor.RemoveEnglishStopWordsPostProcessor
Removes the English stop words from the recognizedIntent's parameter values extracted from any entities.
PROJECT_ID_KEY - Static variable in class com.xatkit.core.recognition.dialogflow.DialogFlowApi
The Configuration key to store the unique identifier of the DialogFlow project.
PUBLIC_CONTENT_URL_FRAGMENT - Static variable in interface com.xatkit.core.server.XatkitServerUtils
The URL fragment used to access Xatkit public content.
PUBLIC_DIRECTORY_NAME - Static variable in interface com.xatkit.core.server.XatkitServerUtils
The directory name used to store Xatkit public content.

R

RECOGNITION_POSTPROCESSORS_KEY - Static variable in class com.xatkit.core.recognition.IntentRecognitionProviderFactory
The Configuration key used to specify the IntentPostProcessors associated to the created IntentRecognitionProvider.
RECOGNITION_PREPROCESSORS_KEY - Static variable in class com.xatkit.core.recognition.IntentRecognitionProviderFactory
The Configuration key used to specify the InputPreProcessors associated to the created IntentRecognitionProvider.
RecognitionMonitor - Class in com.xatkit.core.recognition
Provides monitoring capabilities for IntentRecognitionProviders.
RecognitionMonitor(XatkitServer, Configuration) - Constructor for class com.xatkit.core.recognition.RecognitionMonitor
Constructs a RecognitionMonitor with the provided xatkitServer and configuration.
RegExEntityMapper - Class in com.xatkit.core.recognition.regex
An EntityMapper that uses RegExp to match system entities.
RegExEntityMapper() - Constructor for class com.xatkit.core.recognition.regex.RegExEntityMapper
Constructs a RegExEntityMapper that uses RegExp to match system entities.
RegExIntentRecognitionProvider - Class in com.xatkit.core.recognition.regex
A default IntentRecognitionProvider that relies on RegExp to match user inputs.
RegExIntentRecognitionProvider(Configuration) - Constructor for class com.xatkit.core.recognition.regex.RegExIntentRecognitionProvider
Constructs a RegExIntentRecognitionProvider with the provided Configuration.
RegExIntentRecognitionProvider(Configuration, RecognitionMonitor) - Constructor for class com.xatkit.core.recognition.regex.RegExIntentRecognitionProvider
Constructs a RegExIntentRecognitionProvider with the provided configuration.
registerEntityDefinition(EntityDefinition) - Method in class com.xatkit.core.recognition.dialogflow.DialogFlowApi
Registers the provided entityDefinition in the underlying intent recognition provider.
registerEntityDefinition(EntityDefinition) - Method in class com.xatkit.core.recognition.IntentRecognitionProvider
Registers the provided entityDefinition in the underlying intent recognition provider.
registerEntityDefinition(EntityDefinition) - Method in class com.xatkit.core.recognition.regex.RegExIntentRecognitionProvider
Registers the provided entityDefinition.
registerEventDefinition(EventDefinition) - Method in class com.xatkit.core.EventDefinitionRegistry
Registers the provided eventDefinition.
registerFormatFunction(Class<T>, Function<T, String>) - Method in class com.xatkit.core.platform.Formatter
Registers the provided function to the given clazz.
registerFormatter(String, Formatter) - Method in class com.xatkit.core.XatkitCore
Registers the provided formatter with the given formatterName.
registerIntentDefinition(IntentDefinition) - Method in class com.xatkit.core.recognition.dialogflow.DialogFlowApi
Registers the provided intentDefinition in the underlying intent recognition provider.
registerIntentDefinition(IntentDefinition) - Method in class com.xatkit.core.recognition.IntentRecognitionProvider
Registers the provided intentDefinition in the underlying intent recognition provider.
registerIntentDefinition(IntentDefinition) - Method in class com.xatkit.core.recognition.regex.RegExIntentRecognitionProvider
Registers the provided IntentDefinition.
registerLoadedPlatformDefinition(PlatformDefinition) - Method in class com.xatkit.core.RuntimePlatformRegistry
Registeres the provided platformDefinition using its name.
registerRestEndpoint(HttpMethod, String, RestHandler) - Method in class com.xatkit.core.server.XatkitServer
Registers the provided handler as a REST endpoint for the provided uri.
registerRuntimePlatform(RuntimePlatform) - Method in class com.xatkit.core.RuntimePlatformRegistry
Registers the provided platform using its name.
registerRuntimePlatform(String, RuntimePlatform) - Method in class com.xatkit.core.RuntimePlatformRegistry
Registers the provided platform with the provided name.
registerWebhookEventProvider(WebhookEventProvider) - Method in class com.xatkit.core.server.XatkitServer
RemoveEnglishStopWordsPostProcessor - Class in com.xatkit.core.recognition.processor
Removes the English stop words from the intent's parameter values extracted from any entities.
RemoveEnglishStopWordsPostProcessor() - Constructor for class com.xatkit.core.recognition.processor.RemoveEnglishStopWordsPostProcessor
Loads the stop words List.
removeMappingFor(EntityDefinition) - Method in class com.xatkit.core.recognition.EntityMapper
Removes the concreteEntity mapped to the provided abstractEntity.
RestAction<T extends RuntimePlatform> - Class in com.xatkit.core.platform.action
A generic REST action.
RestAction(T, XatkitSession, RestAction.MethodKind, Map<String, String>, String, Map<String, Object>, JsonElement) - Constructor for class com.xatkit.core.platform.action.RestAction
Constructs a new RestAction.
RestAction.MethodKind - Enum in com.xatkit.core.platform.action
The kind of REST methods supported by this class.
restEndpoint - Variable in class com.xatkit.core.platform.action.RestAction
The REST API endpoint to request.
RestGetAction<T extends RuntimePlatform> - Class in com.xatkit.core.platform.action
A generic REST GET action.
RestGetAction(T, XatkitSession, Map<String, String>, String, Map<String, Object>) - Constructor for class com.xatkit.core.platform.action.RestGetAction
Constructs a new RestGetAction.
RestHandler<C> - Class in com.xatkit.core.server
A generic Rest request handler.
RestHandler() - Constructor for class com.xatkit.core.server.RestHandler
 
RestHandlerException - Exception in com.xatkit.core.server
An exception thrown by RestHandlers to notify the XatkitServer.
RestHandlerException() - Constructor for exception com.xatkit.core.server.RestHandlerException
Constructs a RestHandlerException.
RestHandlerException(int, String) - Constructor for exception com.xatkit.core.server.RestHandlerException
Constructs a RestHandlerException with the provided HTTP errorCode and message.
RestHandlerException(String) - Constructor for exception com.xatkit.core.server.RestHandlerException
Constructs a RestHandlerException from the provided message.
RestHandlerException(String, Throwable) - Constructor for exception com.xatkit.core.server.RestHandlerException
Constructs a RestHandlerException from the provided message and cause.
RestHandlerException(int, String, Throwable) - Constructor for exception com.xatkit.core.server.RestHandlerException
Constructs a RestHandlerException from the provided HTTP errorCode, message, and cause.
RestHandlerException(Throwable) - Constructor for exception com.xatkit.core.server.RestHandlerException
Constructs a RestHandlerException from the provided cause.
RestHandlerException(int, Throwable) - Constructor for exception com.xatkit.core.server.RestHandlerException
Constructs a RestHandlerException from the provided HTTP errorCode and cause.
RestHandlerException(String, Throwable, boolean, boolean) - Constructor for exception com.xatkit.core.server.RestHandlerException
Constructs a RestHandlerException from the provided message, cause, enableSuppression, and writeableStackTrace.
RestHandlerFactory - Class in com.xatkit.core.server
A RestHandler factory providing utility methods to create specific RestHandler instances.
RestHandlerFactory() - Constructor for class com.xatkit.core.server.RestHandlerFactory
 
RestHandlerFactory.EmptyContentRestHandlerFunction - Interface in com.xatkit.core.server
A functional interface representing the handling function of EmptyContentRestHandler.
RestHandlerFactory.JsonRestHandlerFunction - Interface in com.xatkit.core.server
A functional interface representing the handling function of JsonRestHandler.
RestPostAction<T extends RuntimePlatform> - Class in com.xatkit.core.platform.action
A generic REST POST action.
RestPostAction(T, XatkitSession, Map<String, String>, String, Map<String, Object>, JsonElement) - Constructor for class com.xatkit.core.platform.action.RestPostAction
Constructs a new RestPostAction.
run() - Method in class com.xatkit.core.platform.io.WebhookEventProvider
Runs the provider.
RuntimeAction<T extends RuntimePlatform> - Class in com.xatkit.core.platform.action
The concrete implementation of an ActionDefinition definition.
RuntimeAction(T, XatkitSession) - Constructor for class com.xatkit.core.platform.action.RuntimeAction
Constructs a new RuntimeAction with the provided runtimePlatform and session.
RuntimeActionResult - Class in com.xatkit.core.platform.action
Stores the result of a computation and provides utility methods to manipulate it.
RuntimeActionResult(Object, long) - Constructor for class com.xatkit.core.platform.action.RuntimeActionResult
Constructs a new RuntimeActionResult from the provided result and executionTime.
RuntimeActionResult(Object, Exception, long) - Constructor for class com.xatkit.core.platform.action.RuntimeActionResult
Constructs a new RuntimeActionResult from the provided partialResult, thrownException, and executionTime.
RuntimeArtifactAction<T extends RuntimePlatform> - Class in com.xatkit.core.platform.action
An abstract RuntimeAction.
RuntimeArtifactAction(T, XatkitSession) - Constructor for class com.xatkit.core.platform.action.RuntimeArtifactAction
Constructs a new RuntimeArtifactAction with the provided runtimePlatform and session.
RuntimeContexts - Class in com.xatkit.core.session
A variable container bound to a XatkitSession.
RuntimeContexts() - Constructor for class com.xatkit.core.session.RuntimeContexts
Constructs a new empty RuntimeContexts.
RuntimeContexts(Configuration) - Constructor for class com.xatkit.core.session.RuntimeContexts
Constructs a new empty RuntimeContexts with the given configuration.
RuntimeEventProvider<T extends RuntimePlatform> - Class in com.xatkit.core.platform.io
An abstract class representing user input providers.
RuntimeEventProvider(T) - Constructor for class com.xatkit.core.platform.io.RuntimeEventProvider
Constructs a new RuntimeEventProvider with the provided runtimePlatform.
RuntimeEventProvider(T, Configuration) - Constructor for class com.xatkit.core.platform.io.RuntimeEventProvider
Constructs a new RuntimeEventProvider with the provided runtimePlatform and configuration.
RuntimeMessageAction<T extends RuntimePlatform> - Class in com.xatkit.core.platform.action
An abstract RuntimeAction processing a message.
RuntimeMessageAction(T, XatkitSession, String) - Constructor for class com.xatkit.core.platform.action.RuntimeMessageAction
Constructs a new RuntimeMessageAction with the provided runtimePlatform, session, and rawMessage.
runtimePlatform - Variable in class com.xatkit.core.platform.action.RuntimeAction
The RuntimePlatform subclass containing this action.
runtimePlatform - Variable in class com.xatkit.core.platform.io.RuntimeEventProvider
The RuntimePlatform subclass containing this action.
RuntimePlatform - Class in com.xatkit.core.platform
The concrete implementation of a PlatformDefinition.
RuntimePlatform(XatkitCore, Configuration) - Constructor for class com.xatkit.core.platform.RuntimePlatform
Constructs a new RuntimePlatform from the provided XatkitCore and Configuration.
RuntimePlatform(XatkitCore) - Constructor for class com.xatkit.core.platform.RuntimePlatform
Constructs a new RuntimePlatform from the provided XatkitCore.
RuntimePlatform.EventProviderThread - Class in com.xatkit.core.platform
The Thread class used to start RuntimeEventProviders.
RuntimePlatformRegistry - Class in com.xatkit.core
A registry that stores RuntimePlatforms.
RuntimePlatformRegistry() - Constructor for class com.xatkit.core.RuntimePlatformRegistry
Constructs a new instance of the registry and initializes its RuntimePlatformRegistry.platformToRuntime.

S

sendEventInstance(EventInstance, XatkitSession) - Method in class com.xatkit.core.platform.io.RuntimeEventProvider
Sends the provided eventInstance and session for computation to the Xatkit core component.
SENTIMENT_PARAMETER_KEY - Static variable in class com.xatkit.core.recognition.processor.EnglishSentimentPostProcessor
The context parameter key used to store the sentiment extracted from the user input.
SERVER_KEYSTORE_KEY_PASSWORD_KEY - Static variable in interface com.xatkit.core.server.XatkitServerUtils
The Configuration key used to specify the key password of the SSL keystore.
SERVER_KEYSTORE_LOCATION_KEY - Static variable in interface com.xatkit.core.server.XatkitServerUtils
The Configuration key used to specify the location of the keystore to create the SSL context from.
SERVER_KEYSTORE_STORE_PASSWORD_KEY - Static variable in interface com.xatkit.core.server.XatkitServerUtils
The Configuration key used to specify the store password of the SSL keystore.
SERVER_PORT_KEY - Static variable in interface com.xatkit.core.server.XatkitServerUtils
The Configuration key to store the server port to use.
SERVER_PUBLIC_URL_KEY - Static variable in interface com.xatkit.core.server.XatkitServerUtils
The Configuration key used to specify the Xatkit server location (public URL).
session - Variable in class com.xatkit.core.platform.action.RuntimeAction
The XatkitSession associated to this action.
setContext(ContextInstance) - Method in class com.xatkit.core.session.RuntimeContexts
Sets the context associated to the provided contextInstance.
setContext(String, int) - Method in class com.xatkit.core.session.RuntimeContexts
Sets the provided context with the given lifespanCount.
setContextValue(String, int, String, Object) - Method in class com.xatkit.core.session.RuntimeContexts
Stores the provided value in the given context with the provided key and lifespanCount.
setContextValue(ContextParameterValue) - Method in class com.xatkit.core.session.RuntimeContexts
Stores the provided contextParameterValue in the context.
setEventDefinitionName(String) - Method in class com.xatkit.core.platform.io.EventInstanceBuilder
Sets the name of the EventDefinition to bind to the created EventInstance.
setFallbackEntityMapping(String) - Method in class com.xatkit.core.recognition.EntityMapper
Sets the default mapping for abstractEntities that are not mapped to concrete implementations.
setOutContextValue(String, String) - Method in class com.xatkit.core.platform.io.EventInstanceBuilder
Sets the created EventInstance's output context parameter contextKey with the given contextValue.
setPostProcessors(List<? extends IntentPostProcessor>) - Method in class com.xatkit.core.recognition.IntentRecognitionProvider
setPreProcessors(List<? extends InputPreProcessor>) - Method in class com.xatkit.core.recognition.IntentRecognitionProvider
shutdown() - Method in class com.xatkit.core.ExecutionService
Shuts down the underlying ExecutorService.
shutdown() - Method in class com.xatkit.core.platform.RuntimePlatform
Shuts down the RuntimePlatform.
shutdown() - Method in class com.xatkit.core.recognition.dialogflow.DialogFlowApi
Shuts down the intent recognition provider client and invalidates the remaining sessions.
shutdown() - Method in class com.xatkit.core.recognition.IntentRecognitionProvider
Shuts down the intent recognition provider client and invalidates the remaining sessions.
shutdown() - Method in class com.xatkit.core.recognition.RecognitionMonitor
Commit the pending operations on the database and closes the connection.
shutdown() - Method in class com.xatkit.core.recognition.regex.RegExIntentRecognitionProvider
Shuts down the intent recognition provider client and invalidates the remaining sessions.
shutdown() - Method in class com.xatkit.core.XatkitCore
Shuts down the XatkitCore and the underlying engines.
StanfordNLPPostProcessor - Class in com.xatkit.core.recognition.processor
A IntentPostProcessor using Stanford NLP library to extract information from the user input.
StanfordNLPPostProcessor() - Constructor for class com.xatkit.core.recognition.processor.StanfordNLPPostProcessor
 
StanfordNLPService - Class in com.xatkit.core.recognition.processor
A singleton class that wraps a StanfordCoreNLP pipeline used to process user messages.
start() - Method in class com.xatkit.core.server.XatkitServer
Starts the underlying HttpServer.
startEventProvider(EventProviderDefinition) - Method in class com.xatkit.core.platform.RuntimePlatform
Starts the RuntimeEventProvider corresponding to the provided eventProviderDefinition.
stop() - Method in class com.xatkit.core.server.XatkitServer
Stops the underlying HttpServer.
store(String, Object) - Method in class com.xatkit.core.session.XatkitSession
Store the provided value with the given key as a session variable.
storeList(String, Object) - Method in class com.xatkit.core.session.XatkitSession
Store the provided value in the List associated to the provided key as a session variable.

T

toString() - Method in class com.xatkit.core.platform.io.JsonEventMatcher.FieldValue
Returns a String representation of this JsonEventMatcher.FieldValue.
toString() - Method in class com.xatkit.core.platform.io.JsonEventMatcher.HeaderValue
Returns a String representation of this JsonEventMatcher.HeaderValue.
toString() - Method in class com.xatkit.core.platform.RuntimePlatform
Returns a String representation of this platform.
toString() - Method in class com.xatkit.core.session.XatkitSession
Returns a String representation of the session.
trainMLEngine() - Method in class com.xatkit.core.recognition.dialogflow.DialogFlowApi
Trains the underlying intent recognition provider.
trainMLEngine() - Method in class com.xatkit.core.recognition.IntentRecognitionProvider
Trains the underlying intent recognition provider.
trainMLEngine() - Method in class com.xatkit.core.recognition.regex.RegExIntentRecognitionProvider
This method is not implemented and throws an UnsupportedOperationException.

U

unregisterEventDefinition(EventDefinition) - Method in class com.xatkit.core.EventDefinitionRegistry
Unregisters the provided eventDefinition.
unregisterRuntimePlatform(RuntimePlatform) - Method in class com.xatkit.core.RuntimePlatformRegistry
Unregisters the provided platform.
unregisterWebhookEventProvider(WebhookEventProvider) - Method in class com.xatkit.core.server.XatkitServer
Unregistered a WebhookEventProvider.

V

valueOf(String) - Static method in enum com.xatkit.core.platform.action.RestAction.MethodKind
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.xatkit.core.server.HttpMethod
Returns the enum constant of this type with the specified name.
values() - Static method in enum com.xatkit.core.platform.action.RestAction.MethodKind
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.xatkit.core.server.HttpMethod
Returns an array containing the constants of this enum type, in the order they are declared.
VARIABLE_TIMEOUT_KEY - Static variable in class com.xatkit.core.session.RuntimeContexts
The Configuration key to store maximum time to spend waiting for a context variable (in seconds).

W

WebhookEventProvider<T extends RuntimePlatform,H extends RestHandler> - Class in com.xatkit.core.platform.io
A specialised RuntimeEventProvider that handles Rest requests sent by the XatkitServer.
WebhookEventProvider(T) - Constructor for class com.xatkit.core.platform.io.WebhookEventProvider
Constructs a new WebhookEventProvider with the provided runtimePlatform.
WebhookEventProvider(T, Configuration) - Constructor for class com.xatkit.core.platform.io.WebhookEventProvider
Constructs a new WebhookEventProvider from the provided runtimePlatform and configuration.

X

Xatkit - Class in com.xatkit
The main Xatkit Class used to start a Xatkit bot instance.
Xatkit() - Constructor for class com.xatkit.Xatkit
 
xatkitCore - Variable in class com.xatkit.core.platform.io.RuntimeEventProvider
The XatkitCore instance used to handle events.
xatkitCore - Variable in class com.xatkit.core.platform.RuntimePlatform
The XatkitCore instance containing this platform.
XatkitCore - Class in com.xatkit.core
The core component of the xatkit framework.
XatkitCore(Configuration) - Constructor for class com.xatkit.core.XatkitCore
Constructs a new XatkitCore instance from the provided configuration.
XatkitEnvironmentConfiguration - Class in com.xatkit.util
A MapConfiguration initialized with System.getenv() variables.
XatkitEnvironmentConfiguration() - Constructor for class com.xatkit.util.XatkitEnvironmentConfiguration
Creates a XatkitEnvironmentConfiguration initialized with System.getenv() values.
XatkitException - Exception in com.xatkit.core
Xatkit top-level exception.
XatkitException() - Constructor for exception com.xatkit.core.XatkitException
Constructs a new XatkitException.
XatkitException(String) - Constructor for exception com.xatkit.core.XatkitException
Constructs a new XatkitException from the provided message.
XatkitException(String, Throwable) - Constructor for exception com.xatkit.core.XatkitException
Constructs a new XatkitException from the provided message and cause.
XatkitException(Throwable) - Constructor for exception com.xatkit.core.XatkitException
Constructs a new XatkitException from the provided cause.
XatkitException(String, Throwable, boolean, boolean) - Constructor for exception com.xatkit.core.XatkitException
Constructs a new XatkitException from the provided message, cause, enableSuppression, and writableStackTrace.
XatkitServer - Class in com.xatkit.core.server
The REST server used to receive external webhooks.
XatkitServer(Configuration) - Constructor for class com.xatkit.core.server.XatkitServer
Constructs a new XatkitServer with the given Configuration.
XatkitServerUtils - Interface in com.xatkit.core.server
Utility values for the XatkitServer.
XatkitSession - Class in com.xatkit.core.session
A session holding user-related information.
XatkitSession(String) - Constructor for class com.xatkit.core.session.XatkitSession
Constructs a new, empty XatkitSession with the provided sessionId.
XatkitSession(String, Configuration) - Constructor for class com.xatkit.core.session.XatkitSession
Constructs a new, empty XatkitSession with the provided sessionId and configuration.
XbaseUtils - Class in com.xatkit.util
An utility class providing helpers for Xbase objects.
XbaseUtils() - Constructor for class com.xatkit.util.XbaseUtils
 
A B C D E F G H I J L M N O P R S T U V W X 
Skip navigation links

Copyright © 2020 SOM Research Lab. All rights reserved.