jp.go.nict.langrid.service_1_2.bilingualdictionary

Interface BilingualDictionaryService

All Known Subinterfaces:

BilingualDictionaryHeadwordsExtractionService, BilingualDictionaryWithLongestMatchSearchService

All Known Implementing Classes:

AbstractBilingualDictionaryService, AbstractBilingualDictionaryWithLongestMatchSearchService, AxisBilingualDictionaryWithLongestMatchSearchServiceExecutor, BilingualDictionaryService, BilingualDictionaryService, BilingualDictionaryWithLongestMatchSearch, BilingualDictionaryWithLongestMatchSearch, RewordingDictionaryService

public interface BilingualDictionaryService

Defines the interface for the bilingual dictionary service. If you're providing the bilingual dictionary service, then if you implement this class, ... You can access it using a client provided by langrid.

Version:

$Revision: 587 $

Author:

$Author: t-nakaguchi $

Method Summary

Methods

Modifier and Type	Method and Description
Calendar	getLastUpdate() Returns the last date of change to the dictionary data.
LanguagePair[]	getSupportedLanguagePairs() Gets the dictionary's supported language.
String[]	getSupportedMatchingMethods() Returns the search methods supported by the dictionary wrapper.
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.

Method Detail

search

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

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 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)

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

UnsupportedLanguagePairException - The specified language pair is not supported.

UnsupportedMatchingMethodException - The specified matching method is not supported

getSupportedLanguagePairs

LanguagePair[] getSupportedLanguagePairs()
                                         throws AccessLimitExceededException,
                                                NoAccessPermissionException,
                                                NoValidEndpointsException,
                                                ProcessFailedException,
                                                ServerBusyException,
                                                ServiceNotActiveException,
                                                ServiceNotFoundException

Gets the dictionary's supported language.

Returns:

Array of languages

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

getSupportedMatchingMethods

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

Returns the search methods supported by the dictionary wrapper.

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

getLastUpdate

Calendar getLastUpdate()
                       throws AccessLimitExceededException,
                              NoAccessPermissionException,
                              NoValidEndpointsException,
                              ProcessFailedException,
                              ServerBusyException,
                              ServiceNotActiveException,
                              ServiceNotFoundException

Returns the last date of change to the dictionary data.

Returns:

Date of last change

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