com.exalead.mercury.mami.search.v20

Class SitePrefixHandler

java.lang.Object

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

com.exalead.mercury.mami.search.v20.IndexFieldPrefixHandler

com.exalead.mercury.mami.search.v20.SitePrefixHandler

All Implemented Interfaces:

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

public class SitePrefixHandler
extends IndexFieldPrefixHandler
implements com.exalead.util.Checkable, java.io.Serializable

Searches for parts of URLs.

See Also:

Serialized Form

Nested Class Summary

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

IndexFieldPrefixHandler.Transformer<T>, IndexFieldPrefixHandler.Visitor

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

QueryPrefixHandler.FromDataModel

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	additionalIndexField
static java.lang.String	DEFAULT_GROUPS_BY_TO_REMOVE
java.lang.String	groupsByToRemove

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

indexField

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

aliases, dataModelClass, dataModelProperty, dataModelState, DEFAULT_PREFIX_MATCH, fromDataModel, name, prefixMatch, queryExpansionConfig

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
<T> T	accept(IndexFieldPrefixHandler.Transformer<T> transformer, T[] t)
void	accept(IndexFieldPrefixHandler.Visitor visitor)
<T> T	accept(QueryPrefixHandler.Transformer<T> transformer, T[] t)
void	accept(QueryPrefixHandler.Visitor visitor)
void	check(boolean deep, java.lang.String errorContext) Checks this SitePrefixHandler.
static SitePrefixHandler	fromString(java.lang.String s) String representation of this SitePrefixHandler.
java.lang.String	getAdditionalIndexField()
java.lang.String	getGroupsByToRemove() Names of the GroupBy nodes to remove (comma-separated).
SitePrefixHandler	makeCopy() Creates and returns a deep copy of this SitePrefixHandler.
static SitePrefixHandler	readFrom(java.io.InputStream is) Read this SitePrefixHandler from an XML fragment.
void	setAdditionalIndexField(java.lang.String additionalIndexField)
void	setGroupsByToRemove(java.lang.String groupsByToRemove) Names of the GroupBy nodes to remove (comma-separated).
java.lang.String	toString() String representation of this SitePrefixHandler.
SitePrefixHandler	withAdditionalIndexField(java.lang.String additionalIndexField)
SitePrefixHandler	withAliases(java.lang.String aliases)
SitePrefixHandler	withDataModelClass(java.lang.String dataModelClass)
SitePrefixHandler	withDataModelProperty(java.lang.String dataModelProperty)
SitePrefixHandler	withDataModelState(java.lang.String dataModelState)
SitePrefixHandler	withFromDataModel(QueryPrefixHandler fromDataModel)
SitePrefixHandler	withGroupsByToRemove(java.lang.String groupsByToRemove)
SitePrefixHandler	withIndexField(java.lang.String indexField)
SitePrefixHandler	withName(java.lang.String name)
SitePrefixHandler	withPrefixMatch(boolean prefixMatch)
SitePrefixHandler	withPrefixMatch(java.lang.Boolean prefixMatch)
SitePrefixHandler	withQueryExpansionConfig(java.lang.String queryExpansionConfig)
void	writeTo(java.io.OutputStream os) Write this SitePrefixHandler as an XML fragment

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

getIndexField, setIndexField

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

getAliases, getDataModelClass, getDataModelProperty, getDataModelState, getFromDataModel, getName, getQueryExpansionConfig, isPrefixMatch, setAliases, setDataModelClass, setDataModelProperty, setDataModelState, setFromDataModel, setName, setPrefixMatch, setQueryExpansionConfig

Methods inherited from class java.lang.Object

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

Field Detail

additionalIndexField

public java.lang.String additionalIndexField

groupsByToRemove

public java.lang.String groupsByToRemove

DEFAULT_GROUPS_BY_TO_REMOVE

public static final java.lang.String DEFAULT_GROUPS_BY_TO_REMOVE

See Also:

Constant Field Values

Constructor Detail

SitePrefixHandler

public SitePrefixHandler()

SitePrefixHandler

public SitePrefixHandler(SitePrefixHandler o)

Copy constructor

Method Detail

withIndexField

public SitePrefixHandler withIndexField(java.lang.String indexField)

Overrides:

withIndexField in class IndexFieldPrefixHandler

withName

public SitePrefixHandler withName(java.lang.String name)

Overrides:

withName in class IndexFieldPrefixHandler

withAliases

public SitePrefixHandler withAliases(java.lang.String aliases)

Overrides:

withAliases in class IndexFieldPrefixHandler

withQueryExpansionConfig

public SitePrefixHandler withQueryExpansionConfig(java.lang.String queryExpansionConfig)

Overrides:

withQueryExpansionConfig in class IndexFieldPrefixHandler

withDataModelState

public SitePrefixHandler withDataModelState(java.lang.String dataModelState)

Overrides:

withDataModelState in class IndexFieldPrefixHandler

withFromDataModel

public SitePrefixHandler withFromDataModel(QueryPrefixHandler fromDataModel)

Overrides:

withFromDataModel in class IndexFieldPrefixHandler

withDataModelClass

public SitePrefixHandler withDataModelClass(java.lang.String dataModelClass)

Overrides:

withDataModelClass in class IndexFieldPrefixHandler

withDataModelProperty

public SitePrefixHandler withDataModelProperty(java.lang.String dataModelProperty)

Overrides:

withDataModelProperty in class IndexFieldPrefixHandler

withPrefixMatch

public SitePrefixHandler withPrefixMatch(boolean prefixMatch)

Overrides:

withPrefixMatch in class IndexFieldPrefixHandler

withPrefixMatch

public SitePrefixHandler withPrefixMatch(java.lang.Boolean prefixMatch)

Overrides:

withPrefixMatch in class IndexFieldPrefixHandler

setAdditionalIndexField

public void setAdditionalIndexField(java.lang.String additionalIndexField)

getAdditionalIndexField

public java.lang.String getAdditionalIndexField()

withAdditionalIndexField

public SitePrefixHandler withAdditionalIndexField(java.lang.String additionalIndexField)

setGroupsByToRemove

public void setGroupsByToRemove(java.lang.String groupsByToRemove)

Names of the GroupBy nodes to remove (comma-separated).

getGroupsByToRemove

public java.lang.String getGroupsByToRemove()

Names of the GroupBy nodes to remove (comma-separated).

withGroupsByToRemove

public SitePrefixHandler withGroupsByToRemove(java.lang.String groupsByToRemove)

makeCopy

public SitePrefixHandler makeCopy()

Creates and returns a deep copy of this SitePrefixHandler.

Overrides:

makeCopy in class IndexFieldPrefixHandler

readFrom

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

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

Overrides:

writeTo in class IndexFieldPrefixHandler

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this SitePrefixHandler.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this SitePrefixHandler.

Overrides:

toString in class IndexFieldPrefixHandler

check

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

Checks this SitePrefixHandler.

Specified by:

check in interface com.exalead.util.Checkable

Overrides:

check in class IndexFieldPrefixHandler

Throws:

com.exalead.util.TypedException

accept

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

Specified by:

accept in class IndexFieldPrefixHandler

Throws:

com.exalead.util.TypedException

accept

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

Specified by:

accept in class QueryPrefixHandler

Throws:

com.exalead.util.TypedException

accept

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

Specified by:

accept in class IndexFieldPrefixHandler

Throws:

com.exalead.util.TypedException

accept

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

Specified by:

accept in class QueryPrefixHandler

Throws:

com.exalead.util.TypedException