Package nl.knaw.dans.lib.dataverse

Class SearchApi

java.lang.Object

nl.knaw.dans.lib.dataverse.SearchApi

public class SearchApi
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
protected final nl.knaw.dans.lib.dataverse.HttpClientWrapper	httpClientWrapper
protected static final String	MDKEY_PARAM_NAME_PREFIX

Method Summary

Modifier and Type	Method	Description
protected Path	buildPath(Path base, String... components)
DataverseHttpResponse<SearchResult>	find(String query)	A basic search action with default options.
DataverseHttpResponse<SearchResult>	find(String query, SearchOptions options)	A search action with specific SearchOptions.
protected Map<String,List<String>>	getQueryParamsFromMetadataKeys(Map<String,String> metadataKeys)
Iterator<ResultItem>	iterator(String query)	Returns an iterator to all the results for the specified query and default options.
Iterator<ResultItem>	iterator(String query, SearchOptions searchOptions)	Returns an iterator to all the results for the specified query and options.
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

MDKEY_PARAM_NAME_PREFIX

protected static final String MDKEY_PARAM_NAME_PREFIX

See Also:

• Constant Field Values

httpClientWrapper

protected final nl.knaw.dans.lib.dataverse.HttpClientWrapper httpClientWrapper

Method Details

find

public DataverseHttpResponse<SearchResult> find(String query)
                                         throws IOException,
DataverseException

A basic search action with default options.

Parameters:

query - search query

Returns:

a search result

Throws:

IOException - when I/O problems occur during the interaction with Dataverse

DataverseException - when Dataverse fails to perform the request

See Also:

• Dataverse documentation

find

public DataverseHttpResponse<SearchResult> find(String query,
 SearchOptions options)
                                         throws IOException,
DataverseException

A search action with specific SearchOptions.

Parameters:

query - search query

options - further options for futher filtering and rendering the results

Returns:

a search result

Throws:

IOException - when I/O problems occur during the interaction with Dataverse

DataverseException - when Dataverse fails to perform the request

See Also:

• Dataverse documentation

iterator

public Iterator<ResultItem> iterator(String query,
 SearchOptions searchOptions)

Returns an iterator to all the results for the specified query and options. The caller is responsible for calling the ResultItems to the appropriate subclass.

Parameters:

query - the query to execute

searchOptions - the options for the query

Returns:

an iterator over the results

iterator

public Iterator<ResultItem> iterator(String query)

Returns an iterator to all the results for the specified query and default options. The caller is responsible for calling the ResultItems to the appropriate subclass.

Parameters:

query - the query to execute

Returns:

an iterator over the results

toString

public String toString()

Overrides:

toString in class Object

buildPath

protected Path buildPath(Path base,
 String... components)

getQueryParamsFromMetadataKeys

protected Map<String,List<String>> getQueryParamsFromMetadataKeys(Map<String,String> metadataKeys)