jp.go.nict.langrid.wrapper.ws_1_2.pictogramdictionary

Class AbstractPictogramDictionaryService

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.pictogramdictionary.AbstractPictogramDictionaryService

All Implemented Interfaces:

PictogramDictionaryService

public abstract class AbstractPictogramDictionaryService
extends AbstractLanguageService
implements PictogramDictionaryService

Abstract class for the pictogram service.

Version:

$Revision: 265 $

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
AbstractPictogramDictionaryService() Constructor that doesn't take parameter(s).
AbstractPictogramDictionaryService(Collection<Language> supportedLanguages) Constructor that takes the set of supported languages as a parameter.
AbstractPictogramDictionaryService(ServiceContext context, Collection<Language> supportedLanguages) Constructor that takes the service context and set of supported languages as a parameter(s).

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract Collection<Pictogram>	doSearch(Language language, String word, MatchingMethod matchingMethod) Returns the corresponding to the term.
String[]	getSupportedMatchingMethods()
Pictogram[]	search(String language, String word, String matchingMethod)
protected void	setSupportedMatchingMethods(Set<MatchingMethod> supportedMatchingMethods)

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

AbstractPictogramDictionaryService

public AbstractPictogramDictionaryService()

Constructor that doesn't take parameter(s).

AbstractPictogramDictionaryService

public AbstractPictogramDictionaryService(Collection<Language> supportedLanguages)

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

Parameters:

supportedLanguages - Set of supported languages

AbstractPictogramDictionaryService

public AbstractPictogramDictionaryService(ServiceContext context,
                                  Collection<Language> supportedLanguages)

Constructor that takes the service context and set of supported languages as a parameter(s).

Parameters:

context - Service context

supportedLanguages - Set of supported languages

Method Detail

search

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

Specified by:

search in interface PictogramDictionaryService

Parameters:

language - Language of word

word - A word that searches pictograms

matchingMethod - Matching method (MatchingMethod enumerated value)

Returns:

Icon search results.An empty array when not found

Throws:

AccessLimitExceededException - Violated an access restriction

InvalidParameterException - Either text or language is null or else an empty string.language does not comply with RFC3066

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 - Paraphrasing process failed

ServerBusyException - The server is loaded and cannot process it.

ServiceNotActiveException - The service is not active

ServiceNotFoundException - The specified service was not found

doSearch

protected abstract Collection<Pictogram> doSearch(Language language,
                             String word,
                             MatchingMethod matchingMethod)
                                           throws InvalidParameterException,
                                                  ProcessFailedException

Returns the corresponding to the term. When none exist, returns a collection of 0 elements.

Parameters:

language - Language

word - Word

matchingMethod - Matching method

Returns:

Array of pictograms corresponding to the term

Throws:

InvalidParameterException - An invalid parameter was passed

ProcessFailedException - Process failed

getSupportedMatchingMethods

public String[] getSupportedMatchingMethods()
                                     throws AccessLimitExceededException,
                                            NoAccessPermissionException,
                                            NoValidEndpointsException,
                                            ProcessFailedException,
                                            ServerBusyException,
                                            ServiceNotActiveException,
                                            ServiceNotFoundException

Throws:

AccessLimitExceededException

NoAccessPermissionException

NoValidEndpointsException

ProcessFailedException

ServerBusyException

ServiceNotActiveException

ServiceNotFoundException

setSupportedMatchingMethods

protected void setSupportedMatchingMethods(Set<MatchingMethod> supportedMatchingMethods)