jp.go.nict.langrid.wrapper.ws_1_2.similaritycalculation

Class AbstractSimilarityCalculationService

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.similaritycalculation.AbstractSimilarityCalculationService

All Implemented Interfaces:

SimilarityCalculationService

public abstract class AbstractSimilarityCalculationService
extends AbstractLanguageService
implements SimilarityCalculationService

Base class for the standard similarity calculation 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
AbstractSimilarityCalculationService() Constructor that doesn't take parameter(s).
AbstractSimilarityCalculationService(Collection<Language> supportedLanguages) Constructor that takes the set of supported languages as a parameter.
AbstractSimilarityCalculationService(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
double	calculate(String language, String sourceText, String targetText) Runs the text's similarity calculation.
protected abstract double	doCalculation(Language language, String text1, String text2) Execute similarity calculation.

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

AbstractSimilarityCalculationService

public AbstractSimilarityCalculationService()

Constructor that doesn't take parameter(s).

AbstractSimilarityCalculationService

public AbstractSimilarityCalculationService(Collection<Language> supportedLanguages)

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

Parameters:

supportedLanguages - Set of supported languages

AbstractSimilarityCalculationService

public AbstractSimilarityCalculationService(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

calculate

public double calculate(String language,
               String sourceText,
               String targetText)
                 throws AccessLimitExceededException,
                        InvalidParameterException,
                        LanguageNotUniquelyDecidedException,
                        NoAccessPermissionException,
                        NoValidEndpointsException,
                        ProcessFailedException,
                        ServerBusyException,
                        ServiceNotActiveException,
                        ServiceNotFoundException,
                        UnsupportedLanguageException

Description copied from interface: SimilarityCalculationService

Runs the text's similarity calculation.

Specified by:

calculate in interface SimilarityCalculationService

Parameters:

language - Language of text(RFC3066 compliant)

sourceText - Source text for comparison (required)

targetText - Destination text for comparison (required)

Returns:

Calculation results

Throws:

AccessLimitExceededException - Violated an access restriction

InvalidParameterException - One of either text1,text2,or language is null.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

NoAccessPermissionException - The user executing the call lacks execution privileges

NoValidEndpointsException - There is no valid endpoint

ProcessFailedException - Calculation process failed

ServerBusyException - The server is loaded and cannot process it.

ServiceNotActiveException - The service is not active

ServiceNotFoundException - The specified service was not found

doCalculation

protected abstract double doCalculation(Language language,
                   String text1,
                   String text2)
                                 throws InvalidParameterException,
                                        ProcessFailedException

Execute similarity calculation.

Parameters:

language - Language

text1 - Text to be calculated 1

text2 - Text to be calculated 2

Returns:

Calculation results

Throws:

InvalidParameterException - An invalid parameter was passed

ProcessFailedException - Process failed