org.apache.oodt.cas.filemgr.catalog.solr

Class SolrClient

java.lang.Object

org.apache.oodt.cas.filemgr.catalog.solr.SolrClient

public class SolrClient
extends Object

Class containing client-side functionality for interacting with a Solr server. This class uses an HttpClient for all HTTP communication.

Author:

Luca Cinquini

Constructor Summary

Constructors

Constructor and Description
SolrClient(String url) Constructor initializes the Solr URL

Method Summary

Modifier and Type	Method and Description
void	commit() Method to commit the current changes to the Solr index.
String	delete(String id, boolean commit) Method to send a message containing a 'delete' instruction to Solr.
String	index(List<String> docs, boolean commit, String mimeType) Method to send one or more documents to be indexed to Solr.
String	query(Map<String,String[]> parameters, String mimeType) Method to send a generic query to the Solr server.
String	queryProductById(String id, String mimeType) Method to query the Solr index for a product with the specified id.
String	queryProductByName(String name, String mimeType) Method to query the Solr index for a product with the specified name.
String	queryProductsByDate(int n, String mimeType) Method to query Solr for the most recent 'n' products.
String	queryProductsByDateAndType(int n, ProductType type, String mimeType) Method to query Solr for the most recent 'n' products of a specified type.

Methods inherited from class java.lang.Object

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

Constructor Detail

SolrClient

public SolrClient(String url)

Constructor initializes the Solr URL

Parameters:

url -

Method Detail

index

public String index(List<String> docs,
                    boolean commit,
                    String mimeType)
             throws CatalogException

Method to send one or more documents to be indexed to Solr.

Parameters:

docs -

commit -

mimeType - : the mime-type format of the documents

Returns:

Throws:

CatalogException

delete

public String delete(String id,
                     boolean commit)
              throws CatalogException

Method to send a message containing a 'delete' instruction to Solr.

Parameters:

id -

commit -

Returns:

Throws:

CatalogException

queryProductById

public String queryProductById(String id,
                               String mimeType)
                        throws CatalogException

Method to query the Solr index for a product with the specified id.

Parameters:

id -

Returns:

Throws:

CatalogException

queryProductByName

public String queryProductByName(String name,
                                 String mimeType)
                          throws CatalogException

Method to query the Solr index for a product with the specified name.

Parameters:

name -

mimeType -

Returns:

Throws:

CatalogException

queryProductsByDate

public String queryProductsByDate(int n,
                                  String mimeType)
                           throws CatalogException

Method to query Solr for the most recent 'n' products.

Parameters:

n -

Returns:

Throws:

CatalogException

queryProductsByDateAndType

public String queryProductsByDateAndType(int n,
                                         ProductType type,
                                         String mimeType)
                                  throws CatalogException

Method to query Solr for the most recent 'n' products of a specified type.

Parameters:

n -

Returns:

Throws:

CatalogException

commit

public void commit()
            throws IOException,
                   CatalogException

Method to commit the current changes to the Solr index.

Throws:

Exception

IOException

CatalogException

query

public String query(Map<String,String[]> parameters,
                    String mimeType)
             throws CatalogException

Method to send a generic query to the Solr server.

Parameters:

parameters -

mimeType - : the desired mime type for the results (XML, JSON, ...)

Returns:

Throws:

CatalogException