jp.go.nict.langrid.wrapper.ws_1_2.adjacencypair

Class AbstractAdjacencyPairService

java.lang.Object

jp.go.nict.langrid.servicecontainer.service.AbstractService

jp.go.nict.langrid.wrapper.ws_1_2.AbstractService

jp.go.nict.langrid.wrapper.ws_1_2.AbstractLanguageService

jp.go.nict.langrid.wrapper.ws_1_2.adjacencypair.AbstractAdjacencyPairService

All Implemented Interfaces:

AdjacencyPairService

Direct Known Subclasses:

AdjacencyPairService

public abstract class AbstractAdjacencyPairService
extends AbstractLanguageService
implements AdjacencyPairService

Base class for the adjacency pair service.

Version:

$Revision: 409 $

Author:

$Author: t-nakaguchi $

Field Summary

Fields inherited from class jp.go.nict.langrid.wrapper.ws_1_2.AbstractService

ALL_MATCHINGMETHODS, EMPTY_LANGUAGEPAIRS, EMPTY_LANGUAGEPATHS, EMPTY_LANGUAGES, MINIMUM_MATCHINGMETHODS

Constructor Summary

Constructors

Constructor and Description
AbstractAdjacencyPairService() Constructor that doesn't take parameter(s).
AbstractAdjacencyPairService(Collection<Language> supportedLanguages) Constructor that takes the set of supported languages as a parameter.
AbstractAdjacencyPairService(ServiceContext serviceContext) The Constructor.
AbstractAdjacencyPairService(ServiceContext serviceContext, Collection<Language> supportedLanguages) Constructor that takes the service context and supported language pair(s) as a parameter(s).

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract Collection<AdjacencyPair>	doSearch(String category, Language language, String firstTurn, MatchingMethod matchingMethod) Gets a list of responses corresponding to the specified utterance.
AdjacencyPair[]	search(String category, String language, String firstTurn, String matchingMethod) Gets a list of responses corresponding to the specified utterance.
protected void	setSupportedMatchingMethods(Set<MatchingMethod> supportedMatchingMethods) Sets supported search methods.

Methods inherited from class jp.go.nict.langrid.wrapper.ws_1_2.AbstractLanguageService

getSupportedLanguageCollection, getSupportedLanguagePairCollection, getSupportedLanguages, setSupportedLanguageCollection, setSupportedLanguages

Methods inherited from class jp.go.nict.langrid.wrapper.ws_1_2.AbstractService

acquireSemaphore, checkStartupException, convertLanguagePairs, convertLanguages, doGetLastUpdate, getCurrentServiceContext, getDoDoubleSearch, getEliminateDuplicates, getInitParameter, getInitParameterBoolean, getInitParameterInt, getInitParameterLong, getInitParameters, getInitParameterString, getInitParameterUsingTransformer, getLastUpdate, getLogListener, getMaxResults, getMaxWaitMillisForExternalProcess, getRequestMimeHeaders, getServiceContext, getWorkDirectory, getWorkFile, log, parseDateMacro, processEnd, processEnd, processLap, processStart, releaseSemaphore, setCurrentServiceContext, setDoubleSearchResults, setEliminateDuplicates, setLogListener, setMaxResults, setMaxThreads, setMaxWaitMillisForExternalProcess, setMaxWaitMillisForThread, setMeasureProcessTime, setProcessTimeWarningThreasholdMillis, setStartupException

Methods inherited from class jp.go.nict.langrid.servicecontainer.service.AbstractService

getComponentServiceFactory, getFile, getServiceName, setComponentServiceFactory, setServiceName

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractAdjacencyPairService

public AbstractAdjacencyPairService()

Constructor that doesn't take parameter(s).

AbstractAdjacencyPairService

public AbstractAdjacencyPairService(ServiceContext serviceContext)

The Constructor.

Parameters:

serviceContext - The service context.

AbstractAdjacencyPairService

public AbstractAdjacencyPairService(Collection<Language> supportedLanguages)

Constructor that takes the set of supported languages as a parameter.

Parameters:

supportedLanguages - Set of supported languages

AbstractAdjacencyPairService

public AbstractAdjacencyPairService(ServiceContext serviceContext,
                            Collection<Language> supportedLanguages)

Constructor that takes the service context and supported language pair(s) as a parameter(s).

Parameters:

serviceContext - Service context

supportedLanguages - Set of supported languages

Method Detail

search

public AdjacencyPair[] search(String category,
                     String language,
                     String firstTurn,
                     String matchingMethod)
                       throws AccessLimitExceededException,
                              InvalidParameterException,
                              NoAccessPermissionException,
                              NoValidEndpointsException,
                              LanguageNotUniquelyDecidedException,
                              ProcessFailedException,
                              ServerBusyException,
                              ServiceNotActiveException,
                              ServiceNotFoundException,
                              UnsupportedLanguageException,
                              UnsupportedMatchingMethodException

Description copied from interface: AdjacencyPairService

Gets a list of responses corresponding to the specified utterance.

Specified by:

search in interface AdjacencyPairService

Parameters:

category - Category. an empty string when omitted

language - Language of utterance (RFC3066 compliant.)

firstTurn - Utterance(required)

matchingMethod - Search method (MatchingMethod enumerated value)

Returns:

Search results

Throws:

AccessLimitExceededException - Violated an access restriction

InvalidParameterException - language, firstPart or searchMethod is null or else an empty string.language does not comply with RFC3066. String not provided for by searchMethod

LanguageNotUniquelyDecidedException - A supported language candidate could not be singly determined (Ex: when the language is specified as zh, the case where zh-Hans and zh-Hant exist as supported languages)

UnsupportedLanguageException - The specified language is not supported

UnsupportedMatchingMethodException - The specified matching method is not supported

NoAccessPermissionException - The user executing the call lacks execution privileges

NoValidEndpointsException - There is no valid endpoint

ProcessFailedException - Response search failed due to some cause

ServerBusyException - The server is loaded and cannot process it.

ServiceNotActiveException - The service is not active

ServiceNotFoundException - The specified service was not found

setSupportedMatchingMethods

protected void setSupportedMatchingMethods(Set<MatchingMethod> supportedMatchingMethods)

Sets supported search methods.

Parameters:

supportedMatchingMethods - Set of supported search methods

doSearch

protected abstract Collection<AdjacencyPair> doSearch(String category,
                                 Language language,
                                 String firstTurn,
                                 MatchingMethod matchingMethod)
                                               throws InvalidParameterException,
                                                      ProcessFailedException

Gets a list of responses corresponding to the specified utterance.

Parameters:

category - Category

language - Language of utterance (RFC3066 compliant)

firstTurn - Utterance(required)

matchingMethod - Search method

Returns:

Search results

Throws:

InvalidParameterException - language, firstPart or matchingMethod is null or else an empty string.language does not comply with RFC3066. String not provided for by matchingMethod

SearchFailedException - The response search failed due to some cause

ServiceConfigurationException - The service is not set up appropriately

UnknownException - An unknown error occurred

ProcessFailedException