jp.go.nict.langrid.wrapper.ws_1_2.bilingualdictionary

Class AbstractBilingualDictionaryWithLongestMatchSearchService

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.AbstractLanguagePairService

jp.go.nict.langrid.wrapper.ws_1_2.bilingualdictionary.AbstractBilingualDictionaryWithLongestMatchSearchService

All Implemented Interfaces:

BilingualDictionaryService, BilingualDictionaryWithLongestMatchSearchService

Direct Known Subclasses:

BilingualDictionaryService, BilingualDictionaryService, RewordingDictionaryService

public abstract class AbstractBilingualDictionaryWithLongestMatchSearchService
extends AbstractLanguagePairService
implements BilingualDictionaryWithLongestMatchSearchService

The base class of the specialized translation service.

Version:

$Revision:1495 $

Author:

$Author:koyama $

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
AbstractBilingualDictionaryWithLongestMatchSearchService() Constructor.
AbstractBilingualDictionaryWithLongestMatchSearchService(Collection<LanguagePair> supportedPairs) Constructor.
AbstractBilingualDictionaryWithLongestMatchSearchService(ServiceContext serviceContext)

Method Summary

Methods

Modifier and Type	Method and Description
static void	clearCache()
protected Calendar	doGetLastUpdate()
protected abstract Collection<Translation>	doSearch(Language headLang, Language targetLang, String headWord, MatchingMethod matchingMethod) Searches the bilingual dictionary using the specified search term(s) and matching method, and returns bilingual translation.
protected Collection<TranslationWithPosition>	doSearchLongestMatchingTerms(Language headLang, Language targetLang, Morpheme[] morphemes)
String[]	getSupportedMatchingMethods() Returns the search methods supported by the dictionary wrapper.
protected boolean	isCacheSearchResult()
protected Collection<TranslationWithPosition>	scan(Language headLang, Language targetLang, Morpheme[] morphemes) Runs a scan.
Translation[]	search(String headLang, String targetLang, String headWord, String matchingMethod) Searches the bilingual dictionary using the specified search term(s) and matching method, and returns bilingual translation.
TranslationWithPosition[]	searchLongestMatchingTerms(String headLang, String targetLang, Morpheme[] morphemes) Runs a search based on an array of morphemes.
void	setCacheSearchResult(boolean cacheSearchResult)
void	setCacheTtlSec(int cacheTtlSec)
protected void	setSupportedMatchingMethods(Set<MatchingMethod> supportedMatchingMethods) Sets supported search methods.

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

getSupportedLanguagePairCollection, getSupportedLanguagePairs, setSupportedLanguagePairs

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

acquireSemaphore, checkStartupException, convertLanguagePairs, convertLanguages, 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

Methods inherited from interface jp.go.nict.langrid.service_1_2.bilingualdictionary.BilingualDictionaryService

getLastUpdate, getSupportedLanguagePairs

Constructor Detail

AbstractBilingualDictionaryWithLongestMatchSearchService

public AbstractBilingualDictionaryWithLongestMatchSearchService()

Constructor. It does not take parameter(s).

AbstractBilingualDictionaryWithLongestMatchSearchService

public AbstractBilingualDictionaryWithLongestMatchSearchService(ServiceContext serviceContext)

AbstractBilingualDictionaryWithLongestMatchSearchService

public AbstractBilingualDictionaryWithLongestMatchSearchService(Collection<LanguagePair> supportedPairs)

Constructor. Takes the set of supported language pairs as a parameter.

Parameters:

supportedPairs - Set of supported language pairs

Method Detail

setCacheSearchResult

public void setCacheSearchResult(boolean cacheSearchResult)

setCacheTtlSec

public void setCacheTtlSec(int cacheTtlSec)

search

public Translation[] search(String headLang,
                   String targetLang,
                   String headWord,
                   String matchingMethod)
                     throws AccessLimitExceededException,
                            InvalidParameterException,
                            LanguagePairNotUniquelyDecidedException,
                            NoAccessPermissionException,
                            NoValidEndpointsException,
                            ProcessFailedException,
                            ServerBusyException,
                            ServiceNotActiveException,
                            ServiceNotFoundException,
                            UnsupportedLanguagePairException,
                            UnsupportedMatchingMethodException

Description copied from interface: BilingualDictionaryService

Searches the bilingual dictionary using the specified search term(s) and matching method, and returns bilingual translation.

Specified by:

search in interface BilingualDictionaryService

Parameters:

headLang - Source language of bilingual translation(RFC3066 compliant)

targetLang - Target language of bilingual translation (RFC3066 compliant)

headWord - Bilingual translation search phrase

matchingMethod - Matching method (one of either "COMPLETE","PREFIX","SUFFIX","PARTIAL","REGEX")

Returns:

Search results

Throws:

AccessLimitExceededException - Violated an access restriction

InvalidParameterException - One of either headLang,targetLang,searchMethod is null or else is an empty string. headLang or targetLang do not comply with RFC3066.String not provided for by searchMethod

LanguagePairNotUniquelyDecidedException - The bilingual translation language pair candidates could not be singly resolved(Ex:When headLang, or else targetLang is specified as zh, the case where zh-Hans and zh-Hant both exist as supported language pairs)

UnsupportedLanguagePairException - The specified language pair 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 - Search process failed

ServerBusyException - The server is loaded and cannot process it.

ServiceNotActiveException - The service is not active

ServiceNotFoundException - The specified service was not found

searchLongestMatchingTerms

public TranslationWithPosition[] searchLongestMatchingTerms(String headLang,
                                                   String targetLang,
                                                   Morpheme[] morphemes)
                                                     throws AccessLimitExceededException,
                                                            InvalidParameterException,
                                                            LanguagePairNotUniquelyDecidedException,
                                                            NoAccessPermissionException,
                                                            NoValidEndpointsException,
                                                            ProcessFailedException,
                                                            ServerBusyException,
                                                            ServiceNotActiveException,
                                                            ServiceNotFoundException,
                                                            UnsupportedLanguagePairException,
                                                            UnsupportedMatchingMethodException

Description copied from interface: BilingualDictionaryWithLongestMatchSearchService

Runs a search based on an array of morphemes. Combines the morphemes (excluding verbs), and searches the resulting word. Adds the largest word from the found words to the search results. There is a possibility that multiple searches will be run, and multiple search results that differ from the head word will be returned.

Specified by:

searchLongestMatchingTerms in interface BilingualDictionaryWithLongestMatchSearchService

Parameters:

headLang - Source language of bilingual translation(RFC3066 compliant)

targetLang - Target language of bilingual translation (RFC3066 compliant)

morphemes - Array of morphemes

Returns:

Search results

Throws:

AccessLimitExceededException - Violated an access restriction

InvalidParameterException - One of either headLang,targetLang,searchMethod is null or else is an empty string. headLang or targetLang do not comply with RFC3066.String not provided for by searchMethod

LanguagePairNotUniquelyDecidedException - The bilingual translation language pair candidates could not be singly resolved(Ex:When headLang, or else targetLang is specified as zh, the case where zh-Hans and zh-Hant both exist as supported language pairs)

UnsupportedLanguagePairException - The specified language pair 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 - Search process failed

ServerBusyException - The server is loaded and cannot process it.

ServiceNotActiveException - The service is not active

ServiceNotFoundException - The specified service was not found

getSupportedMatchingMethods

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

Description copied from interface: BilingualDictionaryService

Returns the search methods supported by the dictionary wrapper.

Specified by:

getSupportedMatchingMethods in interface BilingualDictionaryService

Returns:

Array of supported search methods

Throws:

AccessLimitExceededException - Violated an access restriction

NoAccessPermissionException - The user executing the call lacks execution privileges

NoValidEndpointsException - There is no valid endpoint

ProcessFailedException - Search process failed

ServerBusyException - The server is loaded and cannot process it.

ServiceNotActiveException - The service is not active

ServiceNotFoundException - The specified service was not found

clearCache

public static void clearCache()

setSupportedMatchingMethods

protected void setSupportedMatchingMethods(Set<MatchingMethod> supportedMatchingMethods)

Sets supported search methods.

Parameters:

supportedMatchingMethods - Set of supported search methods

doSearch

protected abstract Collection<Translation> doSearch(Language headLang,
                               Language targetLang,
                               String headWord,
                               MatchingMethod matchingMethod)
                                             throws InvalidParameterException,
                                                    ProcessFailedException

Searches the bilingual dictionary using the specified search term(s) and matching method, and returns bilingual translation.

Parameters:

headLang - Source language of bilingual translation(RFC3066 compliant)

targetLang - Target language of bilingual translation (RFC3066 compliant)

headWord - Bilingual translation search language

matchingMethod - Search method

Returns:

Array with search results stored.If none exist, an empty array.

Throws:

InvalidParameterException - One of either headLang,targetLang,matchingMethod is null or else is an empty string. headLang or targetLang do not comply with RFC3066.String not provided for by matchingMethod

ProcessFailedException - Bilingual translation search failed due to some cause

doSearchLongestMatchingTerms

protected Collection<TranslationWithPosition> doSearchLongestMatchingTerms(Language headLang,
                                                               Language targetLang,
                                                               Morpheme[] morphemes)
                                                                    throws InvalidParameterException,
                                                                           ProcessFailedException

Throws:

InvalidParameterException

ProcessFailedException

doGetLastUpdate

protected Calendar doGetLastUpdate()
                            throws ProcessFailedException

Overrides:

doGetLastUpdate in class AbstractService

Throws:

ProcessFailedException

scan

protected Collection<TranslationWithPosition> scan(Language headLang,
                                       Language targetLang,
                                       Morpheme[] morphemes)
                                            throws InvalidParameterException,
                                                   ProcessFailedException

Runs a scan.

Parameters:

languages - Bilingual translation languages

morphemes - Array of morphemes

Returns:

Results array

Throws:

InvalidParameterException - One of either headLang,targetLang,matchingMethod is null or else is an empty string. headLang or targetLang do not comply with RFC3066.String not provided for by matchingMethod

ProcessFailedException - Bilingual translation search failed due to some cause

isCacheSearchResult

protected boolean isCacheSearchResult()