com.exalead.mercury.mami.search.v20

Class CustomQueryExpansionModule

java.lang.Object

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

com.exalead.mercury.mami.search.v20.CustomQueryExpansionModule

All Implemented Interfaces:

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

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

Serve as a function for query expansion config in query prefix handlers.

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	classId
java.util.List<KeyValue>	keyValue

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

name

Constructor Summary

Constructors

Constructor and Description
CustomQueryExpansionModule()
CustomQueryExpansionModule(CustomQueryExpansionModule 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 CustomQueryExpansionModule.
static CustomQueryExpansionModule	fromString(java.lang.String s) String representation of this CustomQueryExpansionModule.
java.lang.String	getClassId() Full name of the Java class implementing the custom module.
java.util.List<KeyValue>	getKeyValue()
CustomQueryExpansionModule	makeCopy() Creates and returns a deep copy of this CustomQueryExpansionModule.
static CustomQueryExpansionModule	readFrom(java.io.InputStream is) Read this CustomQueryExpansionModule from an XML fragment.
void	setClassId(java.lang.String classId) Full name of the Java class implementing the custom module.
java.lang.String	toString() String representation of this CustomQueryExpansionModule.
CustomQueryExpansionModule	withClassId(java.lang.String classId)
CustomQueryExpansionModule	withKeyValue(java.util.Collection<KeyValue> __values)
CustomQueryExpansionModule	withKeyValue(KeyValue... __values)
CustomQueryExpansionModule	withName(java.lang.String name)
void	writeTo(java.io.OutputStream os) Write this CustomQueryExpansionModule 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

keyValue

public java.util.List<KeyValue> keyValue

classId

public java.lang.String classId

Constructor Detail

CustomQueryExpansionModule

public CustomQueryExpansionModule()

CustomQueryExpansionModule

public CustomQueryExpansionModule(CustomQueryExpansionModule o)

Copy constructor

Method Detail

withName

public CustomQueryExpansionModule withName(java.lang.String name)

Overrides:

withName in class QueryExpansionModule

getKeyValue

public java.util.List<KeyValue> getKeyValue()

withKeyValue

public CustomQueryExpansionModule withKeyValue(KeyValue... __values)

withKeyValue

public CustomQueryExpansionModule withKeyValue(java.util.Collection<KeyValue> __values)

setClassId

public void setClassId(java.lang.String classId)

Full name of the Java class implementing the custom module.

getClassId

public java.lang.String getClassId()

Full name of the Java class implementing the custom module.

withClassId

public CustomQueryExpansionModule withClassId(java.lang.String classId)

makeCopy

public CustomQueryExpansionModule makeCopy()

Creates and returns a deep copy of this CustomQueryExpansionModule.

Overrides:

makeCopy in class QueryExpansionModule

readFrom

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

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

Overrides:

writeTo in class QueryExpansionModule

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this CustomQueryExpansionModule.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this CustomQueryExpansionModule.

Overrides:

toString in class QueryExpansionModule

check

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

Checks this CustomQueryExpansionModule.

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