com.exalead.mercury.mami.search.v20

Class QueryPrefixHandler

java.lang.Object

com.exalead.mercury.mami.search.v20.QueryPrefixHandler

All Implemented Interfaces:

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

Direct Known Subclasses:

CustomPrefixHandler, EnumFacetPrefixHandler, IndexFieldPrefixHandler, KeywordPrefixHandler, LinguisticOptionsPrefixHandler, MultiQueryPrefixHandler, SimilarDocumentPrefixHandler, SplitPrefixHandler, TemplatePrefixHandler, TextPrefixHandler, UnitsOfMeasurementPrefixHandler

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

No documentation for this element.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	QueryPrefixHandler.FromDataModel
static interface	QueryPrefixHandler.Transformer<T>
static interface	QueryPrefixHandler.Visitor

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	aliases
java.lang.String	dataModelClass
java.lang.String	dataModelProperty
java.lang.String	dataModelState
static boolean	DEFAULT_PREFIX_MATCH
protected QueryPrefixHandler.FromDataModel	fromDataModel
java.lang.String	name
boolean	prefixMatch
java.lang.String	queryExpansionConfig

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
abstract <T> T	accept(QueryPrefixHandler.Transformer<T> transformer, T[] t)
abstract void	accept(QueryPrefixHandler.Visitor visitor)
void	check(boolean deep, java.lang.String errorContext) Checks this QueryPrefixHandler.
static QueryPrefixHandler	fromString(java.lang.String s) String representation of this QueryPrefixHandler.
java.lang.String	getAliases() Comma-separated list of aliases for this prefix handler. Any of these aliases can be used in the query for this prefix handler.
java.lang.String	getDataModelClass() If dataModelState is "auto" or "customized", you will find here the name of the DataModelClass that generated this QueryPrefixHandler.
java.lang.String	getDataModelProperty() If dataModelState is "auto" or "customized", you will find here the name of the DataModelProperty that generated this QueryPrefixHandler.
java.lang.String	getDataModelState() Is this query prefix handler managed by a data model?
QueryPrefixHandler.FromDataModel	getFromDataModel()
java.lang.String	getName() Name of the prefix handler that should be handled.
java.lang.String	getQueryExpansionConfig() Specifies how to expand the text content of this prefix handler. Note that this is sometimes meaningless, if the content is not a semantic chunk of data.
boolean	isPrefixMatch() The prefix handler matches all strings beginning with "name". For example, a prefix handler with name="prop" prefixMatch="true" will match "props:value" and "property:value".
QueryPrefixHandler	makeCopy()
static QueryPrefixHandler	readFrom(java.io.InputStream is) Read this QueryPrefixHandler from an XML fragment.
void	setAliases(java.lang.String aliases) Comma-separated list of aliases for this prefix handler. Any of these aliases can be used in the query for this prefix handler.
void	setDataModelClass(java.lang.String dataModelClass) If dataModelState is "auto" or "customized", you will find here the name of the DataModelClass that generated this QueryPrefixHandler.
void	setDataModelProperty(java.lang.String dataModelProperty) If dataModelState is "auto" or "customized", you will find here the name of the DataModelProperty that generated this QueryPrefixHandler.
void	setDataModelState(java.lang.String dataModelState) Is this query prefix handler managed by a data model?
void	setFromDataModel(QueryPrefixHandler.FromDataModel __value)
void	setName(java.lang.String name) Name of the prefix handler that should be handled.
void	setPrefixMatch(boolean prefixMatch) The prefix handler matches all strings beginning with "name". For example, a prefix handler with name="prop" prefixMatch="true" will match "props:value" and "property:value".
void	setQueryExpansionConfig(java.lang.String queryExpansionConfig) Specifies how to expand the text content of this prefix handler. Note that this is sometimes meaningless, if the content is not a semantic chunk of data.
java.lang.String	toString() String representation of this QueryPrefixHandler.
QueryPrefixHandler	withAliases(java.lang.String aliases)
QueryPrefixHandler	withDataModelClass(java.lang.String dataModelClass)
QueryPrefixHandler	withDataModelProperty(java.lang.String dataModelProperty)
QueryPrefixHandler	withDataModelState(java.lang.String dataModelState)
QueryPrefixHandler	withName(java.lang.String name)
QueryPrefixHandler	withPrefixMatch(boolean prefixMatch)
QueryPrefixHandler	withPrefixMatch(java.lang.Boolean prefixMatch)
QueryPrefixHandler	withQueryExpansionConfig(java.lang.String queryExpansionConfig)
void	writeTo(java.io.OutputStream os)

Methods inherited from class java.lang.Object

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

Field Detail

name

public java.lang.String name

aliases

public java.lang.String aliases

queryExpansionConfig

public java.lang.String queryExpansionConfig

dataModelState

public java.lang.String dataModelState

fromDataModel

protected QueryPrefixHandler.FromDataModel fromDataModel

dataModelClass

public java.lang.String dataModelClass

dataModelProperty

public java.lang.String dataModelProperty

prefixMatch

public boolean prefixMatch

DEFAULT_PREFIX_MATCH

public static final boolean DEFAULT_PREFIX_MATCH

See Also:

Constant Field Values

Constructor Detail

QueryPrefixHandler

public QueryPrefixHandler()

QueryPrefixHandler

public QueryPrefixHandler(QueryPrefixHandler o)

Copy constructor

Method Detail

setName

public void setName(java.lang.String name)

Name of the prefix handler that should be handled.
This is the prefix name that can be used in user queries.
For example, the query prefix handler named 'soundslike' allows you to write this query: 'soundslike:fowbar'

getName

public java.lang.String getName()

Name of the prefix handler that should be handled.
This is the prefix name that can be used in user queries.
For example, the query prefix handler named 'soundslike' allows you to write this query: 'soundslike:fowbar'

withName

public QueryPrefixHandler withName(java.lang.String name)

setAliases

public void setAliases(java.lang.String aliases)

Comma-separated list of aliases for this prefix handler.
Any of these aliases can be used in the query for this prefix handler.

getAliases

public java.lang.String getAliases()

Comma-separated list of aliases for this prefix handler.
Any of these aliases can be used in the query for this prefix handler.

withAliases

public QueryPrefixHandler withAliases(java.lang.String aliases)

setQueryExpansionConfig

public void setQueryExpansionConfig(java.lang.String queryExpansionConfig)

Specifies how to expand the text content of this prefix handler.
Note that this is sometimes meaningless, if the content is not a semantic chunk of data.

getQueryExpansionConfig

public java.lang.String getQueryExpansionConfig()

Specifies how to expand the text content of this prefix handler.
Note that this is sometimes meaningless, if the content is not a semantic chunk of data.

withQueryExpansionConfig

public QueryPrefixHandler withQueryExpansionConfig(java.lang.String queryExpansionConfig)

setDataModelState

public void setDataModelState(java.lang.String dataModelState)

Is this query prefix handler managed by a data model?

getDataModelState

public java.lang.String getDataModelState()

Is this query prefix handler managed by a data model?

withDataModelState

public QueryPrefixHandler withDataModelState(java.lang.String dataModelState)

getFromDataModel

public QueryPrefixHandler.FromDataModel getFromDataModel()

setFromDataModel

public void setFromDataModel(QueryPrefixHandler.FromDataModel __value)

setDataModelClass

public void setDataModelClass(java.lang.String dataModelClass)

If dataModelState is "auto" or "customized", you will find here the
name of the DataModelClass that generated this QueryPrefixHandler.

getDataModelClass

public java.lang.String getDataModelClass()

If dataModelState is "auto" or "customized", you will find here the
name of the DataModelClass that generated this QueryPrefixHandler.

withDataModelClass

public QueryPrefixHandler withDataModelClass(java.lang.String dataModelClass)

setDataModelProperty

public void setDataModelProperty(java.lang.String dataModelProperty)

If dataModelState is "auto" or "customized", you will find here the
name of the DataModelProperty that generated this QueryPrefixHandler.

getDataModelProperty

public java.lang.String getDataModelProperty()

If dataModelState is "auto" or "customized", you will find here the
name of the DataModelProperty that generated this QueryPrefixHandler.

withDataModelProperty

public QueryPrefixHandler withDataModelProperty(java.lang.String dataModelProperty)

setPrefixMatch

public void setPrefixMatch(boolean prefixMatch)

The prefix handler matches all strings beginning with "name".
For example, a prefix handler with name="prop" prefixMatch="true" will match "props:value" and "property:value".

isPrefixMatch

public boolean isPrefixMatch()

The prefix handler matches all strings beginning with "name".
For example, a prefix handler with name="prop" prefixMatch="true" will match "props:value" and "property:value".

withPrefixMatch

public QueryPrefixHandler withPrefixMatch(boolean prefixMatch)

withPrefixMatch

public QueryPrefixHandler withPrefixMatch(java.lang.Boolean prefixMatch)

makeCopy

public QueryPrefixHandler makeCopy()

readFrom

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

Read this QueryPrefixHandler 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

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this QueryPrefixHandler.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this QueryPrefixHandler.

Overrides:

toString in class java.lang.Object

check

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

Checks this QueryPrefixHandler.

Specified by:

check in interface com.exalead.util.Checkable

Throws:

com.exalead.util.TypedException

accept

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

Throws:

com.exalead.util.TypedException

accept

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

Throws:

com.exalead.util.TypedException