com.xatkit.core

Class EventDefinitionRegistry

java.lang.Object

com.xatkit.core.EventDefinitionRegistry

public class EventDefinitionRegistry
extends Object

A registry that stores EventDefinitions and provide utility methods to retrieve them.

This class provides methods to retrieve specific EventDefinitions, filter IntentDefinitions, and retrieve an existing Context stored in a registered EventDefinition.

Constructor Summary

Constructors

Constructor and Description
EventDefinitionRegistry() Constructs a new instance of the registry and initializes its eventDefinitionMap.

Method Summary

Modifier and Type	Method and Description
void	clearEventDefinitions() Unregisters all the EventDefinitions from this registry.
Collection<com.xatkit.intent.EventDefinition>	getAllEventDefinitions() Returns an unmodifiable Collection containing all the registered EventDefinitions.
Collection<com.xatkit.intent.IntentDefinition>	getAllIntentDefinitions() Returns an unmodifiable Collection containing all the registered IntentDefinitions.
com.xatkit.intent.EventDefinition	getEventDefinition(String name) Returns the EventDefinition matching the provided name.
com.xatkit.intent.Context	getEventDefinitionOutContext(String contextName) Retrieve the Context matching the provided contextName from the registered EventDefinitions.
com.xatkit.intent.IntentDefinition	getIntentDefinition(String name) Returns the IntentDefinition matching the provided name.
void	registerEventDefinition(com.xatkit.intent.EventDefinition eventDefinition) Registers the provided eventDefinition.
void	unregisterEventDefinition(com.xatkit.intent.EventDefinition eventDefinition) Unregisters the provided eventDefinition.

Methods inherited from class java.lang.Object

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

Constructor Detail

EventDefinitionRegistry

public EventDefinitionRegistry()

Constructs a new instance of the registry and initializes its eventDefinitionMap.

Method Detail

registerEventDefinition

public void registerEventDefinition(com.xatkit.intent.EventDefinition eventDefinition)

Registers the provided eventDefinition.

Parameters:

eventDefinition - the EventDefinition to register

unregisterEventDefinition

public void unregisterEventDefinition(com.xatkit.intent.EventDefinition eventDefinition)

Unregisters the provided eventDefinition.

Parameters:

eventDefinition - the EventDefinition to unregister

getEventDefinition

public com.xatkit.intent.EventDefinition getEventDefinition(String name)

Returns the EventDefinition matching the provided name.

Parameters:

name - the name of the EventDefinition to retrieve

Returns:

the EventDefinition matching the provided name

See Also:

getAllEventDefinitions()

getIntentDefinition

public com.xatkit.intent.IntentDefinition getIntentDefinition(String name)

Returns the IntentDefinition matching the provided name.

Parameters:

name - the name of the IntentDefinition to retrieve

Returns:

the IntentDefinition matching the provided name

See Also:

getAllIntentDefinitions()

getAllEventDefinitions

public Collection<com.xatkit.intent.EventDefinition> getAllEventDefinitions()

Returns an unmodifiable Collection containing all the registered EventDefinitions.

To retrieve a single EventDefinition from its name see getEventDefinition(String).

Returns:

an unmodifiable Collection containing all the registered EventDefinitions

getAllIntentDefinitions

public Collection<com.xatkit.intent.IntentDefinition> getAllIntentDefinitions()

Returns an unmodifiable Collection containing all the registered IntentDefinitions.

This method returns a subset of the Collection returned by getAllEventDefinitions() that contains only IntentDefinition instances.

To retrieve a single IntentDefinition from its name see getIntentDefinition(String).

Returns:

an unmodifiable Collection containing all the registered IntentDefinitions

getEventDefinitionOutContext

public com.xatkit.intent.Context getEventDefinitionOutContext(String contextName)

Retrieve the Context matching the provided contextName from the registered EventDefinitions.

This method performs a lookup on the registered EventDefinition and searches for an output Context matching the provided contextName. Note that name comparison is not case sensitive.

If there are multiple output Context that match the provided contextName the first one is returned.

Parameters:

contextName - the name of the output Context to retrieve

Returns:

the output Context matching the provided contextName

clearEventDefinitions

public void clearEventDefinitions()

Unregisters all the EventDefinitions from this registry.