com.exalead.mercury.mami.search.v20

Class SemanticProcessorModule

java.lang.Object

com.exalead.mercury.mami.search.v20.QueryExpansionModule

com.exalead.mercury.mami.search.v20.SemanticProcessorModule

All Implemented Interfaces:

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

public class SemanticProcessorModule
extends QueryExpansionModule
implements com.exalead.util.Checkable, java.io.Serializable

Query expansion module embedding a semantic processing pipeline.
The resulting annotation can be used to expand the query.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.exalead.mercury.mami.search.v20.QueryExpansionModule

QueryExpansionModule.Transformer<T>, QueryExpansionModule.Visitor

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	annotation
static int	DEFAULT_INDEX_KIND
int	indexKind
java.util.List<SemanticProcessor>	semanticProcessor

Fields inherited from class com.exalead.mercury.mami.search.v20.QueryExpansionModule

name

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
<T> T	accept(QueryExpansionModule.Transformer<T> transformer, T[] t)
void	accept(QueryExpansionModule.Visitor visitor)
void	check(boolean deep, java.lang.String errorContext) Checks this SemanticProcessorModule.
static SemanticProcessorModule	fromString(java.lang.String s) String representation of this SemanticProcessorModule.
java.lang.String	getAnnotation() The annotation name to use for expansion.
int	getIndexKind() The targeted index kind (0: exact search, 1: lowercase search, 2: normalized search).
java.util.List<SemanticProcessor>	getSemanticProcessor() The underlying semantic processors plugged in the pipeline.
SemanticProcessorModule	makeCopy() Creates and returns a deep copy of this SemanticProcessorModule.
static SemanticProcessorModule	readFrom(java.io.InputStream is) Read this SemanticProcessorModule from an XML fragment.
void	setAnnotation(java.lang.String annotation) The annotation name to use for expansion.
void	setIndexKind(int indexKind) The targeted index kind (0: exact search, 1: lowercase search, 2: normalized search).
java.lang.String	toString() String representation of this SemanticProcessorModule.
SemanticProcessorModule	withAnnotation(java.lang.String annotation)
SemanticProcessorModule	withIndexKind(int indexKind)
SemanticProcessorModule	withIndexKind(java.lang.Integer indexKind)
SemanticProcessorModule	withName(java.lang.String name)
SemanticProcessorModule	withSemanticProcessor(java.util.Collection<SemanticProcessor> __values)
SemanticProcessorModule	withSemanticProcessor(SemanticProcessor... __values) The underlying semantic processors plugged in the pipeline.
void	writeTo(java.io.OutputStream os) Write this SemanticProcessorModule as an XML fragment

Methods inherited from class com.exalead.mercury.mami.search.v20.QueryExpansionModule

getName, setName

Methods inherited from class java.lang.Object

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

Field Detail

semanticProcessor

public java.util.List<SemanticProcessor> semanticProcessor

annotation

public java.lang.String annotation

indexKind

public int indexKind

DEFAULT_INDEX_KIND

public static final int DEFAULT_INDEX_KIND

See Also:

Constant Field Values

Constructor Detail

SemanticProcessorModule

public SemanticProcessorModule()

SemanticProcessorModule

public SemanticProcessorModule(SemanticProcessorModule o)

Copy constructor

Method Detail

withName

public SemanticProcessorModule withName(java.lang.String name)

Overrides:

withName in class QueryExpansionModule

getSemanticProcessor

public java.util.List<SemanticProcessor> getSemanticProcessor()

The underlying semantic processors plugged in the pipeline.

withSemanticProcessor

public SemanticProcessorModule withSemanticProcessor(SemanticProcessor... __values)

The underlying semantic processors plugged in the pipeline.

withSemanticProcessor

public SemanticProcessorModule withSemanticProcessor(java.util.Collection<SemanticProcessor> __values)

setAnnotation

public void setAnnotation(java.lang.String annotation)

The annotation name to use for expansion.

getAnnotation

public java.lang.String getAnnotation()

The annotation name to use for expansion.

withAnnotation

public SemanticProcessorModule withAnnotation(java.lang.String annotation)

setIndexKind

public void setIndexKind(int indexKind)

The targeted index kind (0: exact search, 1: lowercase search, 2: normalized search).

getIndexKind

public int getIndexKind()

The targeted index kind (0: exact search, 1: lowercase search, 2: normalized search).

withIndexKind

public SemanticProcessorModule withIndexKind(int indexKind)

withIndexKind

public SemanticProcessorModule withIndexKind(java.lang.Integer indexKind)

makeCopy

public SemanticProcessorModule makeCopy()

Creates and returns a deep copy of this SemanticProcessorModule.

Overrides:

makeCopy in class QueryExpansionModule

readFrom

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

Read this SemanticProcessorModule 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 SemanticProcessorModule as an XML fragment

Overrides:

writeTo in class QueryExpansionModule

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this SemanticProcessorModule.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this SemanticProcessorModule.

Overrides:

toString in class QueryExpansionModule

check

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

Checks this SemanticProcessorModule.

Specified by:

check in interface com.exalead.util.Checkable

Overrides:

check in class QueryExpansionModule

Throws:

com.exalead.util.TypedException

accept

public void accept(QueryExpansionModule.Visitor visitor)
            throws com.exalead.util.TypedException

Specified by:

accept in class QueryExpansionModule

Throws:

com.exalead.util.TypedException

accept

public <T> T accept(QueryExpansionModule.Transformer<T> transformer,
                    T[] t)
             throws com.exalead.util.TypedException

Specified by:

accept in class QueryExpansionModule

Throws:

com.exalead.util.TypedException