com.exalead.mercury.mami.search.v20

Class QueryPrefixHandlerList

java.lang.Object

com.exalead.mercury.mami.search.v20.QueryPrefixHandlerList

All Implemented Interfaces:

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

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

Class returned by the search-api introspection method "/prefixes"

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	logic
java.util.List<QueryPrefixHandler>	queryPrefixHandler

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	check(boolean deep, java.lang.String errorContext) Checks this QueryPrefixHandlerList.
static QueryPrefixHandlerList	fromString(java.lang.String s) String representation of this QueryPrefixHandlerList.
java.lang.String	getLogic() Search logic for which this list is valid.
java.util.List<QueryPrefixHandler>	getQueryPrefixHandler() The list of valid prefix handlers in this introspection query.
java.util.Map<java.lang.String,QueryPrefixHandler>	getQueryPrefixHandlerAsMap() Get the map of QueryPrefixHandler, indexed by name
QueryPrefixHandler	getQueryPrefixHandlerByName(java.lang.String _lookup) Get the QueryPrefixHandler for which the name matches _lookup
QueryPrefixHandlerList	makeCopy() Creates and returns a deep copy of this QueryPrefixHandlerList.
static QueryPrefixHandlerList	readFrom(java.io.InputStream is) Read this QueryPrefixHandlerList from an XML fragment.
boolean	removeQueryPrefixHandlerByName(java.lang.String _lookup) Removes the QueryPrefixHandler for which the name matches _lookup
void	setLogic(java.lang.String logic) Search logic for which this list is valid.
java.lang.String	toString() String representation of this QueryPrefixHandlerList.
QueryPrefixHandlerList	withLogic(java.lang.String logic)
QueryPrefixHandlerList	withQueryPrefixHandler(java.util.Collection<QueryPrefixHandler> __values)
QueryPrefixHandlerList	withQueryPrefixHandler(QueryPrefixHandler... __values) The list of valid prefix handlers in this introspection query.
void	writeTo(java.io.OutputStream os) Write this QueryPrefixHandlerList as an XML fragment

Methods inherited from class java.lang.Object

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

Field Detail

logic

public java.lang.String logic

queryPrefixHandler

public java.util.List<QueryPrefixHandler> queryPrefixHandler

Constructor Detail

QueryPrefixHandlerList

public QueryPrefixHandlerList()

QueryPrefixHandlerList

public QueryPrefixHandlerList(QueryPrefixHandlerList o)

Copy constructor

Method Detail

setLogic

public void setLogic(java.lang.String logic)

Search logic for which this list is valid.

getLogic

public java.lang.String getLogic()

Search logic for which this list is valid.

withLogic

public QueryPrefixHandlerList withLogic(java.lang.String logic)

getQueryPrefixHandler

public java.util.List<QueryPrefixHandler> getQueryPrefixHandler()

The list of valid prefix handlers in this introspection query.

getQueryPrefixHandlerByName

public QueryPrefixHandler getQueryPrefixHandlerByName(java.lang.String _lookup)

Get the QueryPrefixHandler for which the name matches _lookup

Returns:

null if no matching QueryPrefixHandler is found

getQueryPrefixHandlerAsMap

public java.util.Map<java.lang.String,QueryPrefixHandler> getQueryPrefixHandlerAsMap()

Get the map of QueryPrefixHandler, indexed by name

removeQueryPrefixHandlerByName

public boolean removeQueryPrefixHandlerByName(java.lang.String _lookup)

Removes the QueryPrefixHandler for which the name matches _lookup

Returns:

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

withQueryPrefixHandler

public QueryPrefixHandlerList withQueryPrefixHandler(QueryPrefixHandler... __values)

The list of valid prefix handlers in this introspection query.

withQueryPrefixHandler

public QueryPrefixHandlerList withQueryPrefixHandler(java.util.Collection<QueryPrefixHandler> __values)

makeCopy

public QueryPrefixHandlerList makeCopy()

Creates and returns a deep copy of this QueryPrefixHandlerList.

readFrom

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

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

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

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

String representation of this QueryPrefixHandlerList.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this QueryPrefixHandlerList.

Overrides:

toString in class java.lang.Object

check

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

Checks this QueryPrefixHandlerList.

Specified by:

check in interface com.exalead.util.Checkable

Throws:

com.exalead.util.TypedException