com.exalead.linguistic

Class LinguisticFactory

java.lang.Object

com.exalead.linguistic.LinguisticFactory

public class LinguisticFactory
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
LinguisticFactory()

Method Summary

Modifier and Type	Method and Description
static Normalizer	buildNormalizer(NormalizerConfig spec, NormalizerResource rc) Sometimes we want to use a normalizer in stand-alone, pipeless mode.
static NormalizerResource	buildNormalizerResource(NormalizerConfig spec) Build a new NormalizerResource according to a specification.
static MOTPipe	buildPipe(LinguisticConfig linguisticConfig, java.lang.String tokenizationConfigName, java.util.List<SemanticProcessor> processors) Build a MOTPipe according to a LinguisticConfiguration.
static MOTPipe	buildPipe(java.util.List<Tokenizer> tokenizers, NormalizerConfig norm, java.util.List<SemanticProcessor> processors) Build a non-initialized MOTPipe.
static MOTPipe	buildPipe(java.util.List<Tokenizer> tokenizers, NormalizerConfig norm, java.util.List<SemanticProcessor> processors, ProcessingMode mode)
static MOTPipe	buildPipe(java.util.List<Tokenizer> tokenizers, NormalizerConfig norm, ProcessingMode mode)
static MOTPipe	buildPipe(MOTConfig config) Build a MOTPipe according to a MOTConfig.
static MOTPipe	buildPipe(MOTConfig config, ProcessingMode mode)
static MOTPipe	buildPipe(java.lang.String configPath) Build a MOTPipe according to a MOTConfig.xml file.
static MOTPipe	buildPipe(java.lang.String configPath, ProcessingMode mode)
static MOTPipe	buildPipe(java.lang.String linguisticConfig, java.lang.String tokenizationConfigName) Build a MOTPipe according to a LinguisticConfiguration.
static MOTPipe	buildPipe(java.lang.String linguisticConfig, java.lang.String tokenizationConfigName, java.util.List<SemanticProcessor> processors) Build a MOTPipe according to a LinguisticConfiguration.
static MOTPool	buildPipePool(java.util.List<Tokenizer> tokenizers, NormalizerConfig norm, java.util.List<SemanticProcessor> processors, ProcessingMode mode, int initialSize, int maxSize)
static MOTPool	buildPipePool(java.util.List<Tokenizer> tokenizers, NormalizerConfig norm, java.util.List<SemanticProcessor> processors, ProcessingMode mode, int initialSize, int maxSize, int minSize)
static MOTPipe	buildQueryPipe(java.util.List<Tokenizer> tokenizers, NormalizerConfig norm, java.util.List<SemanticProcessor> processors) Build a non-initialized MOTPipe for query.
static MOTPipe	buildSpellCheckerPipe(java.util.List<Tokenizer> tokenizers, NormalizerConfig norm, java.util.List<SemanticProcessor> processors) Build a non-initialized MOTPipe for spell checking.
static MOTPipe	buildSummaryPipe(java.util.List<Tokenizer> tokenizers, NormalizerConfig norm, java.util.List<SemanticProcessor> processors) Build a non-initialized MOTPipe for summary.
static javax.xml.bind.JAXBContext	getContext()
static LinguisticConfig	readLinguisticConfig(java.lang.String filepath) Read a linguistic configuration from a file without XML validation.
static LinguisticConfig	readLinguisticConfig(java.lang.String filepath, boolean validation) Read a Linguistic configuration from a file using XML validation.
static MOTConfig	readMOTConfig(java.io.InputStream input, boolean validation) Read a MOT configuration from an InputStream.
static MOTConfig	readMOTConfig(java.lang.String filepath) Read a MOT configuration from a file without XML validation.
static MOTConfig	readMOTConfig(java.lang.String filepath, boolean validation) Read a MOT configuration from a file without XML validation.

Methods inherited from class java.lang.Object

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

Constructor Detail

LinguisticFactory

public LinguisticFactory()

Method Detail

buildNormalizerResource

public static NormalizerResource buildNormalizerResource(NormalizerConfig spec)
                                                  throws ResourceNotFoundException,
                                                         ResourceAllocationFailedException

Build a new NormalizerResource according to a specification.

Parameters:

spec - The normalization specification.

Returns:

An initialized NormalizerResource.

Throws:

ResourceAllocationFailedException

ResourceNotFoundException

buildNormalizer

public static Normalizer buildNormalizer(NormalizerConfig spec,
                                         NormalizerResource rc)

Sometimes we want to use a normalizer in stand-alone, pipeless mode.

Parameters:

spec - normalization configuration that's been passed to buildNormalizerResource()

rc - we want to share the resource, so pass the result of buildNormalizerResource() as 2nd argument

Returns:

ready-to-use normalizer in stand-alone mode

buildPipe

public static MOTPipe buildPipe(MOTConfig config)
                         throws ResourceNotFoundException,
                                ResourceAllocationFailedException

Build a MOTPipe according to a MOTConfig.

Parameters:

config - The configuration.

Returns:

A non-initialized MOTPipe.

Throws:

ResourceAllocationFailedException

ResourceNotFoundException

buildPipe

public static MOTPipe buildPipe(MOTConfig config,
                                ProcessingMode mode)
                         throws ResourceNotFoundException,
                                ResourceAllocationFailedException

Throws:

ResourceNotFoundException

ResourceAllocationFailedException

buildPipe

public static MOTPipe buildPipe(java.lang.String configPath)
                         throws ResourceNotFoundException,
                                ResourceAllocationFailedException

Build a MOTPipe according to a MOTConfig.xml file.

Parameters:

configPath - The path of the configuration.

Returns:

A non-initialized MOTPipe.

Throws:

ResourceAllocationFailedException

ResourceNotFoundException

buildPipe

public static MOTPipe buildPipe(java.lang.String configPath,
                                ProcessingMode mode)
                         throws ResourceNotFoundException,
                                ResourceAllocationFailedException

Throws:

ResourceNotFoundException

ResourceAllocationFailedException

buildPipe

public static MOTPipe buildPipe(java.lang.String linguisticConfig,
                                java.lang.String tokenizationConfigName,
                                java.util.List<SemanticProcessor> processors)
                         throws ResourceAllocationFailedException,
                                ResourceNotFoundException

Build a MOTPipe according to a LinguisticConfiguration. The resources will be freed when no more pipes reference them.

Parameters:

linguisticConfig - The path to Linguistic.xml.

tokenizationConfigName - The TokenizationConfig name.

processors - The list of semantic processors.

Returns:

A non-initialized MOTPipe.

Throws:

ResourceAllocationFailedException

ResourceNotFoundException

buildPipe

public static MOTPipe buildPipe(LinguisticConfig linguisticConfig,
                                java.lang.String tokenizationConfigName,
                                java.util.List<SemanticProcessor> processors)
                         throws ResourceNotFoundException,
                                ResourceAllocationFailedException

Build a MOTPipe according to a LinguisticConfiguration. The resources will be freed when no more pipes reference them.

Parameters:

linguisticConfig - The LinguisticConfig

tokenizationConfigName - The TokenizationConfig name.

processors - The list of semantic processors.

Returns:

A non-initialized MOTPipe.

Throws:

ResourceAllocationFailedException

ResourceNotFoundException

buildPipe

public static MOTPipe buildPipe(java.lang.String linguisticConfig,
                                java.lang.String tokenizationConfigName)
                         throws ResourceAllocationFailedException,
                                ResourceNotFoundException

Build a MOTPipe according to a LinguisticConfiguration. The resources will be freed when no more pipes reference them.

Parameters:

linguisticConfig - The path to Linguistic.xml.

tokenizationConfigName - The TokenizationConfig name.

Returns:

A non-initialized MOTPipe.

Throws:

ResourceAllocationFailedException

ResourceNotFoundException

buildPipe

public static MOTPipe buildPipe(java.util.List<Tokenizer> tokenizers,
                                NormalizerConfig norm,
                                java.util.List<SemanticProcessor> processors)
                         throws ResourceNotFoundException,
                                ResourceAllocationFailedException

Build a non-initialized MOTPipe.

Parameters:

tokenizers - The list of tokenizers.

norm - The normalization configuration.

processors - The list of processors.

Returns:

A non-initialized MOTPipe.

Throws:

ResourceAllocationFailedException

ResourceNotFoundException

buildQueryPipe

public static MOTPipe buildQueryPipe(java.util.List<Tokenizer> tokenizers,
                                     NormalizerConfig norm,
                                     java.util.List<SemanticProcessor> processors)
                              throws ResourceNotFoundException,
                                     ResourceAllocationFailedException

Build a non-initialized MOTPipe for query.

Parameters:

tokenizers - The list of tokenizers.

norm - The normalization configuration.

processors - The list of processors.

Returns:

A non-initialized MOTPipe.

Throws:

ResourceAllocationFailedException

ResourceNotFoundException

buildSpellCheckerPipe

public static MOTPipe buildSpellCheckerPipe(java.util.List<Tokenizer> tokenizers,
                                            NormalizerConfig norm,
                                            java.util.List<SemanticProcessor> processors)
                                     throws ResourceNotFoundException,
                                            ResourceAllocationFailedException

Build a non-initialized MOTPipe for spell checking. Japanese tokenizer is configured with favor=precision to disable CJKProcessor and get an output compatible with the spellchecker

Parameters:

tokenizers - The list of tokenizers.

norm - The normalization configuration.

processors - The list of processors.

Returns:

A non-initialized MOTPipe.

Throws:

ResourceAllocationFailedException

ResourceNotFoundException

buildSummaryPipe

public static MOTPipe buildSummaryPipe(java.util.List<Tokenizer> tokenizers,
                                       NormalizerConfig norm,
                                       java.util.List<SemanticProcessor> processors)
                                throws ResourceNotFoundException,
                                       ResourceAllocationFailedException

Build a non-initialized MOTPipe for summary.

Parameters:

tokenizers - The list of tokenizers.

norm - The normalization configuration.

processors - The list of processors.

Returns:

A non-initialized MOTPipe.

Throws:

ResourceAllocationFailedException

ResourceNotFoundException

buildPipe

public static MOTPipe buildPipe(java.util.List<Tokenizer> tokenizers,
                                NormalizerConfig norm,
                                java.util.List<SemanticProcessor> processors,
                                ProcessingMode mode)
                         throws ResourceNotFoundException,
                                ResourceAllocationFailedException

Throws:

ResourceNotFoundException

ResourceAllocationFailedException

buildPipe

public static MOTPipe buildPipe(java.util.List<Tokenizer> tokenizers,
                                NormalizerConfig norm,
                                ProcessingMode mode)
                         throws ResourceNotFoundException,
                                ResourceAllocationFailedException

Throws:

ResourceNotFoundException

ResourceAllocationFailedException

buildPipePool

public static MOTPool buildPipePool(java.util.List<Tokenizer> tokenizers,
                                    NormalizerConfig norm,
                                    java.util.List<SemanticProcessor> processors,
                                    ProcessingMode mode,
                                    int initialSize,
                                    int maxSize,
                                    int minSize)
                             throws java.lang.Exception

Throws:

java.lang.Exception

buildPipePool

public static MOTPool buildPipePool(java.util.List<Tokenizer> tokenizers,
                                    NormalizerConfig norm,
                                    java.util.List<SemanticProcessor> processors,
                                    ProcessingMode mode,
                                    int initialSize,
                                    int maxSize)
                             throws java.lang.Exception

Throws:

java.lang.Exception

getContext

public static javax.xml.bind.JAXBContext getContext()
                                             throws javax.xml.bind.JAXBException

Throws:

javax.xml.bind.JAXBException

readLinguisticConfig

public static LinguisticConfig readLinguisticConfig(java.lang.String filepath)
                                             throws ResourceAllocationFailedException

Read a linguistic configuration from a file without XML validation.

Parameters:

filepath - The path to Linguistic.xml.

Returns:

A Linguistic configuration.

Throws:

ResourceAllocationFailedException

readLinguisticConfig

public static LinguisticConfig readLinguisticConfig(java.lang.String filepath,
                                                    boolean validation)
                                             throws ResourceAllocationFailedException

Read a Linguistic configuration from a file using XML validation.

Parameters:

filename - The path to Linguistic.xml.

validation - If true, validate the XML file before.

Returns:

A Linguistic configuration.

Throws:

ResourceAllocationFailedException

readMOTConfig

public static MOTConfig readMOTConfig(java.io.InputStream input,
                                      boolean validation)
                               throws ResourceAllocationFailedException

Read a MOT configuration from an InputStream.

Parameters:

input - The input stream

validation - If true, validate the XML file while unmarshalling.

Returns:

A MOT configuration.

Throws:

ResourceAllocationFailedException

readMOTConfig

public static MOTConfig readMOTConfig(java.lang.String filepath)
                               throws ResourceAllocationFailedException

Read a MOT configuration from a file without XML validation.

Parameters:

filepath - The path to MOTConfig.xml.

Returns:

A MOT configuration.

Throws:

ResourceAllocationFailedException

readMOTConfig

public static MOTConfig readMOTConfig(java.lang.String filepath,
                                      boolean validation)
                               throws ResourceAllocationFailedException

Read a MOT configuration from a file without XML validation.

Parameters:

filepath - The path to MOTConfig.xml.

validation - If true, validate the XML file before.

Returns:

A MOT configuration.

Throws:

ResourceAllocationFailedException