com.exalead.search.query.linguistic

Class LinguisticExpanderResource

java.lang.Object

com.exalead.search.query.linguistic.LinguisticExpanderResource

public class LinguisticExpanderResource
extends java.lang.Object

Global thread-safe resource for linguistic expansion.
Building a resource is expensive, be careful to reuse this between queries.

The resource contains:

• The MOT tokenization configuration
• The MOT normalization configuration
• A set of processors, each being made of:
  • A MOT processor
  • A LinguisticPostProcessor

As the resource acts as a factory, we don't pass a MOT Processor and a LinguisticPostProcessor, but a SemanticProcessor and a PostProcessorFactory.
As a helper, you can give the resource a "Handler", which serves as factory.

The resource is meant to be configured through calls to #setTokenizers, #setNormalizer and addProcessor(java.lang.String, com.exalead.search.query.linguistic.LinguisticExpanderResource.Handler).
It must then be initialized though init(java.util.List<com.exalead.linguistic.v10.Tokenizer>, com.exalead.linguistic.v10.NormalizerConfig).
The resource can then be used to retrieve SemanticProcessor and LinguisticPostProcessor.

See Also:

SemanticProcessor, LinguisticPostProcessor, LinguisticExpander

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	LinguisticExpanderResource.Handler A Handler is a factory for: a set of SemanticProcessor to annotate the TokenizedNode a factory of PostProcessor
static class	LinguisticExpanderResource.PostProcessorFactory Abstract factory that creates a LinguisticPostProcessor.

Constructor Summary

Constructors

Constructor and Description
LinguisticExpanderResource() Build a non-configured, non-initialized resource.

Method Summary

Modifier and Type	Method and Description
JaZhDisambiguisator	acquireJaZhDisambiguisator() Acquire a standalone JaZhDisambiguisator
Normalizer	acquireNormalizer(java.lang.String tokenizationConfig) Acquire a standalone normalizer
MOTPipe	acquireRTMOTPipe(java.lang.String tokenizationConfig) Get a MOT pipe from the resource. The pipe returned must be released with releaseRTMOTPipe(java.lang.String, com.exalead.mot.core.MOTPipe) in order to be recycled properly.
MOTPipe	acquireUnitsOfMeasurementMOTPipe() Get a MOT pipe from the resource. The pipe returned must be released with releaseUnitsOfMeasurementMOTPipe(com.exalead.mot.core.MOTPipe) in order to be recycled properly.
void	addProcessor(java.lang.String name, LinguisticExpanderResource.Handler handler) Add a linguistic processor to this expander, using the Handler factory class.
void	addProcessor(java.lang.String name, java.util.List<SemanticProcessor> semanticProcessor, LinguisticExpanderResource.PostProcessorFactory postProcFact) Add a linguistic processor to this expander, defined by its semantic processor and post processor factory.
void	addTokenizationConfig(TokenizationConfig config)
LinguisticExpander	buildExpander(com.exalead.flis.FLISServiceClient client, UQLConfig config) Factory method
int	getTrustLevel(java.lang.String tokenizationConfigName, java.lang.String tag, int defaultValue)
void	init() Deprecated.
void	init(java.util.List<Tokenizer> tokenizers, NormalizerConfig nConfig) Deprecated.
void	init(java.lang.String defaultTokenizationConfig) Initialize the resource. A resource cannot be used before being initialized.
void	release() Release MOT resources
void	releaseJaZhDisambiguisator(JaZhDisambiguisator jaZh) Release a standalone JaZhDisambiguisator acquired via acquireJaZhDisambiguisator
void	releaseNormalizer(java.lang.String tokenizationConfig, Normalizer n) Release a standalone normalizer acquired via acquireNormalizer
void	releaseRTMOTPipe(java.lang.String tokenizationConfig, MOTPipe pipe) Release a MOT pipe to the resource.
void	releaseUnitsOfMeasurementMOTPipe(MOTPipe pipe) Release a MOT pipe to the resource.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LinguisticExpanderResource

public LinguisticExpanderResource()

Build a non-configured, non-initialized resource.

Method Detail

addTokenizationConfig

public void addTokenizationConfig(TokenizationConfig config)

getTrustLevel

public int getTrustLevel(java.lang.String tokenizationConfigName,
                         java.lang.String tag,
                         int defaultValue)

addProcessor

public void addProcessor(java.lang.String name,
                         LinguisticExpanderResource.Handler handler)

Add a linguistic processor to this expander, using the Handler factory class.

Parameters:

name - This name is only used for tracing and debugging purposes.

handler - The factory building the linguistic processors.

See Also:

LinguisticExpanderResource.Handler

addProcessor

public void addProcessor(java.lang.String name,
                         java.util.List<SemanticProcessor> semanticProcessor,
                         LinguisticExpanderResource.PostProcessorFactory postProcFact)

Add a linguistic processor to this expander, defined by its semantic processor and post processor factory.

init

@Deprecated
public void init(java.util.List<Tokenizer> tokenizers,
                             NormalizerConfig nConfig)

Deprecated.

Warning: Don't use this in production code, only for tests

init

@Deprecated
public void init()

Deprecated.

init

public void init(java.lang.String defaultTokenizationConfig)

Initialize the resource.
A resource cannot be used before being initialized.

release

public void release()

Release MOT resources

buildExpander

public LinguisticExpander buildExpander(com.exalead.flis.FLISServiceClient client,
                                        UQLConfig config)

Factory method

acquireRTMOTPipe

public MOTPipe acquireRTMOTPipe(java.lang.String tokenizationConfig)
                         throws QueryProcessingException

Get a MOT pipe from the resource.
The pipe returned must be released with releaseRTMOTPipe(java.lang.String, com.exalead.mot.core.MOTPipe) in order to be recycled properly. Used by the KeywordPrefix.

Returns:

A recyclable MOT pipe.

Throws:

QueryProcessingException

acquireUnitsOfMeasurementMOTPipe

public MOTPipe acquireUnitsOfMeasurementMOTPipe()
                                         throws QueryProcessingException

Get a MOT pipe from the resource.
The pipe returned must be released with releaseUnitsOfMeasurementMOTPipe(com.exalead.mot.core.MOTPipe) in order to be recycled properly. Used by the UnitsOfMeasurementPrefix.

Returns:

A recyclable MOT pipe.

Throws:

QueryProcessingException

acquireNormalizer

public Normalizer acquireNormalizer(java.lang.String tokenizationConfig)

Acquire a standalone normalizer

releaseNormalizer

public void releaseNormalizer(java.lang.String tokenizationConfig,
                              Normalizer n)

Release a standalone normalizer acquired via acquireNormalizer

acquireJaZhDisambiguisator

public JaZhDisambiguisator acquireJaZhDisambiguisator()

Acquire a standalone JaZhDisambiguisator

releaseJaZhDisambiguisator

public void releaseJaZhDisambiguisator(JaZhDisambiguisator jaZh)

Release a standalone JaZhDisambiguisator acquired via acquireJaZhDisambiguisator

releaseRTMOTPipe

public void releaseRTMOTPipe(java.lang.String tokenizationConfig,
                             MOTPipe pipe)

Release a MOT pipe to the resource. Used by the KeywordPrefix.

Parameters:

pipe - A used MOT pipe obtained through acquireRTMOTPipe(java.lang.String)

releaseUnitsOfMeasurementMOTPipe

public void releaseUnitsOfMeasurementMOTPipe(MOTPipe pipe)

Release a MOT pipe to the resource. Used by the UnitsOfMeasurementPrefix.

Parameters:

pipe - A used MOT pipe obtained through acquireUnitsOfMeasurementMOTPipe()