jp.go.nict.langrid.wrapper.ws_1_2.conceptdictionary

Class AbstractConceptDictionaryService

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.conceptdictionary.AbstractConceptDictionaryService

All Implemented Interfaces:

ConceptDictionaryService

public abstract class AbstractConceptDictionaryService
extends AbstractLanguageService
implements ConceptDictionaryService

Abstract class for the concept dictionary.

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

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract Collection<Concept>	doGetRelatedConcepts(Language language, String conceptId, ConceptualRelation relation) Runs a search on related concepts.
protected abstract Collection<Concept>	doSearchConcepts(Language language, String word, MatchingMethod matchingMethod) Runs a search on concepts.
Concept[]	getRelatedConcepts(String language, String conceptId, String relation) Gets concepts related to a concept by specific relationships
Concept[]	searchConcepts(String language, String word, String matchingMethod) Search concepts.
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

AbstractConceptDictionaryService

public AbstractConceptDictionaryService()

Constructor that doesn't take parameter(s).

AbstractConceptDictionaryService

public AbstractConceptDictionaryService(Collection<Language> supportedLanguages)

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

Parameters:

supportedLanguages - Set of supported languages

AbstractConceptDictionaryService

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

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

Parameters:

serviceContext - Service context

supportedLanguages - Set of supported languages

Method Detail

searchConcepts

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

Description copied from interface: ConceptDictionaryService

Search concepts.

Specified by:

searchConcepts in interface ConceptDictionaryService

Parameters:

language - The language of the concept headword(s)

word - Concept headword

matchingMethod - Search method

Returns:

Array(s) of concepts expressed by concept headword(s)

Throws:

AccessLimitExceededException - Exceeded the access limit

InvalidParameterException - An invalid parameter given

LanguageNotUniquelyDecidedException - Multiple searchable languages exist, and one is not singly determined

UnsupportedLanguageException - An unsupported language was specified.

UnsupportedMatchingMethodException - An unsupported matching method was specified.

NoAccessPermissionException - The user making the call does not have execution privileges.

NoValidEndpointsException - No valid endpoint exists.

ProcessFailedException - The process failed.

ServerBusyException - The server is in a busy state and could not complete the process.

ServiceNotActiveException - The service is not active.

ServiceNotFoundException - The service called was not found.

getRelatedConcepts

public final Concept[] getRelatedConcepts(String language,
                           String conceptId,
                           String relation)
                                   throws AccessLimitExceededException,
                                          InvalidParameterException,
                                          LanguageNotUniquelyDecidedException,
                                          NoAccessPermissionException,
                                          ProcessFailedException,
                                          NoValidEndpointsException,
                                          ServerBusyException,
                                          ServiceNotActiveException,
                                          ServiceNotFoundException,
                                          UnsupportedLanguageException

Description copied from interface: ConceptDictionaryService

Gets concepts related to a concept by specific relationships

Specified by:

getRelatedConcepts in interface ConceptDictionaryService

Parameters:

language - Language that expresses the concept

conceptId - The Concept's ID

relation - Relation between concepts

Returns:

An array of concepts associated by specified relations to a concept expressed as a concept ID-language pair.

Throws:

AccessLimitExceededException - Exceeded an access restriction

InvalidParameterException - An invalid parameter was passed.

LanguageNotUniquelyDecidedException - Multiple languages supported by the service exist, and one is not singly determined.

UnsupportedLanguageException - An unsupported language was specified.

NoAccessPermissionException - The user executing the call lacks execution privileges.

ProcessFailedException - Process failed.

NoValidEndpointsException - No valid endpoint exists.

ServerBusyException - Cannot complete the process as the server is in a busy state

ServiceNotActiveException - The service is not active.

ServiceNotFoundException - The requested service was not found.

doSearchConcepts

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

Runs a search on concepts.

Parameters:

language - Language

word - Word

matchingMethod - Matching method

Returns:

Set of supported concepts

Throws:

InvalidParameterException - An invalid parameter was passed

ProcessFailedException - Process failed

doGetRelatedConcepts

protected abstract Collection<Concept> doGetRelatedConcepts(Language language,
                                       String conceptId,
                                       ConceptualRelation relation)
                                                     throws InvalidParameterException,
                                                            ProcessFailedException

Runs a search on related concepts.

Parameters:

language - Language

conceptId - Concept ID

relation - Relation with concept ID

Returns:

Set of related concepts

Throws:

InvalidParameterException - An invalid parameter was passed

ProcessFailedException - Process failed

setSupportedMatchingMethods

protected void setSupportedMatchingMethods(Set<MatchingMethod> supportedMatchingMethods)

Sets supported search methods.

Parameters:

supportedMatchingMethods - Set of supported search methods