com.uc4.communication.requests

Class SearchIndex

java.lang.Object

com.uc4.communication.requests.XMLRequest

com.uc4.communication.requests.SearchIndex

All Implemented Interfaces:

java.lang.Iterable<SearchIndex.Result>

public class SearchIndex
extends XMLRequest
implements java.lang.Iterable<SearchIndex.Result>

This class can be used to find objects based on name or title. It requires a running Java Work Process. Apache lucene is used to find objects. The iterator() method in this class can be used to get the results after the request has been sent.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SearchIndex.Result This class represents one result of a index based search.

Constructor Summary

Constructors

Constructor and Description
SearchIndex(java.lang.String luceneQueryString) Creates a new SearchIndex request.

Method Summary

Methods

Modifier and Type	Method and Description
int	getTotalHits() Returns the total number of hits.
void	handleContent(com.uc4.util.XMLDocument doc, ConnectionAttributes session)
java.util.Iterator<SearchIndex.Result>	iterator()
void	setMaxResults(int maxResults) Sets count of max results.
int	size() Returns the number of results that are returned using the iterator() method.

Methods inherited from class com.uc4.communication.requests.XMLRequest

getAllMessageBoxes, getMessageBox, getRequestID, handleResponse, send

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SearchIndex

public SearchIndex(java.lang.String luceneQueryString)

Creates a new SearchIndex request. The parameter luceneQueryString is an Apache Lucene Query string. The syntax is described here: http://lucene.apache.org/core/2_9_4/queryparsersyntax.html Available fields are:

• name ... Name of the Automic object
• type ... Short form of the object type, for example JOBS
• title ... Title of the object
• archiveKey1 ... First archive key of the object
• archiveKey2 ... Second archive key of the object
• all ... Contains the tokenized name and title, this is also the default field

Parameters:

luceneQueryString - the search is of type String

Method Detail

setMaxResults

public void setMaxResults(int maxResults)

Sets count of max results. If not set or value is below 1, value of client settings is used instead. See UC_CLIENT_SETTINGS:MAX_SEARCH_RESULTS.

Parameters:

maxResults - Maximum number of returned results

handleContent

public void handleContent(com.uc4.util.XMLDocument doc,
                 ConnectionAttributes session)

iterator

public java.util.Iterator<SearchIndex.Result> iterator()

Specified by:

iterator in interface java.lang.Iterable<SearchIndex.Result>

getTotalHits

public int getTotalHits()

Returns the total number of hits.

Returns:

Total hits

size

public int size()

Returns the number of results that are returned using the iterator() method. If the request has not been sent the return value is 0.

Returns:

the size of our list.