com.exalead.indexing.analysis.v10

Class AnalysisConfig

java.lang.Object

com.exalead.indexing.analysis.v10.AnalysisConfig

All Implemented Interfaces:

com.exalead.util.Checkable, java.io.Serializable

public class AnalysisConfig
extends java.lang.Object
implements com.exalead.util.Checkable, java.io.Serializable

AnalysisConfig represents a self-contained module for Document Analysis.
AnalysisConfig is referenced by a BuildGroup.
An analysis module defines a set of pipelines that are applied in this module.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
java.util.List<AnalysisPipeline>	analysisPipeline
static boolean	DEFAULT_LINGUISTIC
boolean	linguistic Deprecated.
java.lang.String	name

Constructor Summary

Constructors

Constructor and Description
AnalysisConfig()
AnalysisConfig(AnalysisConfig o) Copy constructor

Method Summary

Modifier and Type	Method and Description
void	check(boolean deep, java.lang.String errorContext) Checks this AnalysisConfig.
static AnalysisConfig	fromString(java.lang.String s) String representation of this AnalysisConfig.
java.util.List<AnalysisPipeline>	getAnalysisPipeline()
java.util.Map<java.lang.String,AnalysisPipeline>	getAnalysisPipelineAsMap() Get the map of AnalysisPipeline, indexed by name
AnalysisPipeline	getAnalysisPipelineByName(java.lang.String _lookup) Get the AnalysisPipeline for which the name matches _lookup
java.lang.String	getName() Name of the analysis module. Must be unique.
boolean	isLinguistic() Deprecated.
AnalysisConfig	makeCopy() Creates and returns a deep copy of this AnalysisConfig.
static AnalysisConfig	readFrom(java.io.InputStream is) Read this AnalysisConfig from an XML fragment.
boolean	removeAnalysisPipelineByName(java.lang.String _lookup) Removes the AnalysisPipeline for which the name matches _lookup
void	setLinguistic(boolean linguistic) Deprecated.
void	setName(java.lang.String name) Name of the analysis module. Must be unique.
java.lang.String	toString() String representation of this AnalysisConfig.
AnalysisConfig	withAnalysisPipeline(AnalysisPipeline... __values)
AnalysisConfig	withAnalysisPipeline(java.util.Collection<AnalysisPipeline> __values)
AnalysisConfig	withLinguistic(boolean linguistic) Deprecated.
AnalysisConfig	withLinguistic(java.lang.Boolean linguistic) Deprecated.
AnalysisConfig	withName(java.lang.String name)
void	writeTo(java.io.OutputStream os) Write this AnalysisConfig as an XML fragment

Methods inherited from class java.lang.Object

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

Field Detail

analysisPipeline

public java.util.List<AnalysisPipeline> analysisPipeline

name

public java.lang.String name

linguistic

@Deprecated
public boolean linguistic

Deprecated.

DEFAULT_LINGUISTIC

public static final boolean DEFAULT_LINGUISTIC

See Also:

Constant Field Values

Constructor Detail

AnalysisConfig

public AnalysisConfig()

AnalysisConfig

public AnalysisConfig(AnalysisConfig o)

Copy constructor

Method Detail

getAnalysisPipeline

public java.util.List<AnalysisPipeline> getAnalysisPipeline()

getAnalysisPipelineByName

public AnalysisPipeline getAnalysisPipelineByName(java.lang.String _lookup)

Get the AnalysisPipeline for which the name matches _lookup

Returns:

null if no matching AnalysisPipeline is found

getAnalysisPipelineAsMap

public java.util.Map<java.lang.String,AnalysisPipeline> getAnalysisPipelineAsMap()

Get the map of AnalysisPipeline, indexed by name

removeAnalysisPipelineByName

public boolean removeAnalysisPipelineByName(java.lang.String _lookup)

Removes the AnalysisPipeline for which the name matches _lookup

Returns:

false if no matching AnalysisPipeline is found, true if one was found

withAnalysisPipeline

public AnalysisConfig withAnalysisPipeline(AnalysisPipeline... __values)

withAnalysisPipeline

public AnalysisConfig withAnalysisPipeline(java.util.Collection<AnalysisPipeline> __values)

setName

public void setName(java.lang.String name)

Name of the analysis module.
Must be unique.

getName

public java.lang.String getName()

Name of the analysis module.
Must be unique.

withName

public AnalysisConfig withName(java.lang.String name)

setLinguistic

@Deprecated
public void setLinguistic(boolean linguistic)

Deprecated.

Extracts linguistic data for the dictionary, such as word counts.
This impacts the ability to compute related terms and use word counts for ranking.

isLinguistic

@Deprecated
public boolean isLinguistic()

Deprecated.

Extracts linguistic data for the dictionary, such as word counts.
This impacts the ability to compute related terms and use word counts for ranking.

withLinguistic

@Deprecated
public AnalysisConfig withLinguistic(boolean linguistic)

Deprecated.

withLinguistic

@Deprecated
public AnalysisConfig withLinguistic(java.lang.Boolean linguistic)

Deprecated.

makeCopy

public AnalysisConfig makeCopy()

Creates and returns a deep copy of this AnalysisConfig.

readFrom

public static AnalysisConfig readFrom(java.io.InputStream is)
                               throws javax.xml.bind.JAXBException

Read this AnalysisConfig from an XML fragment.

Throws:

javax.xml.bind.JAXBException

writeTo

public void writeTo(java.io.OutputStream os)
             throws javax.xml.bind.JAXBException,
                    java.io.IOException

Write this AnalysisConfig as an XML fragment

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

public static AnalysisConfig fromString(java.lang.String s)
                                 throws javax.xml.bind.JAXBException,
                                        java.io.UnsupportedEncodingException

String representation of this AnalysisConfig.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this AnalysisConfig.

Overrides:

toString in class java.lang.Object

check

public void check(boolean deep,
                  java.lang.String errorContext)
           throws com.exalead.util.TypedException

Checks this AnalysisConfig.

Specified by:

check in interface com.exalead.util.Checkable

Throws:

com.exalead.util.TypedException