org.apache.oodt.cas.filemgr.tools

Class SolrIndexer

java.lang.Object

org.apache.oodt.cas.filemgr.tools.SolrIndexer

public class SolrIndexer
extends Object

Indexes products from the File Manager catalog to a Solr instance. Uses an associated config file, indexer.properties to specify how to perform the indexing. See indexer.properties in the src/main/resources directory for specific documentation.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	SolrIndexer.IndexerConfig This class manages the Indexer configuration.

Constructor Summary

Constructors

Constructor and Description
SolrIndexer(String solrUrl, String fmUrl) Constructor reads in the configuration and initiates the connection to the Solr instance.

Method Summary

Modifier and Type	Method and Description
static org.apache.commons.cli.Options	buildCommandLine() This method builds the command-line options.
void	commit() This method commits all of the modifications to the Solr index.
void	delete() This method deletes all entries from the Solr index.
void	deleteProduct(String productId) This method deletes a single product identified by a productID from the Solr index
void	deleteProductByName(String productName) This method deletes a product(s) from the Solr index identified by a given name
void	indexAll(boolean delete) This method indexes all products retrieved from the File Manager to the Solr index.
void	indexMetFile(File file, boolean delete) This method adds a single product extracted from a metadata file to the Solr index.
void	indexProduct(String productId) This method adds a single product retrieved from the File Manager by its product identifier to the Solr index.
void	indexProductByName(String productName, boolean delete) This method adds a single product retrieved from the File Manager by its product name to the Solr index.
void	indexProductTypes(boolean delete) This method indexes all product types retrieved from the File Manager to the Solr index.
static void	main(String[] args) The main method.
void	optimize() This method optimizes the Solr index.

Methods inherited from class java.lang.Object

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

Constructor Detail

SolrIndexer

public SolrIndexer(String solrUrl,
                   String fmUrl)
            throws InstantiationException

Constructor reads in the configuration and initiates the connection to the Solr instance.

Parameters:

solrUrl - URL for the Solr instance.

fmUrl - URL for the File Manager instance.

Throws:

InstantiationException

Method Detail

delete

public void delete()
            throws org.apache.solr.client.solrj.SolrServerException,
                   IOException

This method deletes all entries from the Solr index.

Throws:

org.apache.solr.client.solrj.SolrServerException

IOException

commit

public void commit()
            throws org.apache.solr.client.solrj.SolrServerException,
                   IOException

This method commits all of the modifications to the Solr index.

Throws:

org.apache.solr.client.solrj.SolrServerException

IOException

optimize

public void optimize()
              throws org.apache.solr.client.solrj.SolrServerException,
                     IOException

This method optimizes the Solr index.

Throws:

org.apache.solr.client.solrj.SolrServerException

IOException

indexMetFile

public void indexMetFile(File file,
                         boolean delete)
                  throws org.apache.solr.client.solrj.SolrServerException

This method adds a single product extracted from a metadata file to the Solr index.

Parameters:

file - The file containing product metadata.

delete - Flag indicating whether the entry should be deleted from the index.

Throws:

org.apache.solr.client.solrj.SolrServerException - When an error occurs communicating with the Solr server instance.

indexProductTypes

public void indexProductTypes(boolean delete)

This method indexes all product types retrieved from the File Manager to the Solr index.

Parameters:

delete - Flag indicating whether each product type retrieved from the File Manager should be deleted from the index.

Throws:

org.apache.solr.client.solrj.SolrServerException - When an error occurs communicating with the Solr server instance.

indexAll

public void indexAll(boolean delete)

This method indexes all products retrieved from the File Manager to the Solr index. Metadata from the product's associated ProductType is also included.

Parameters:

delete - Flag indicating whether each product retrieved from the File Manager should be deleted from the index.

Throws:

org.apache.solr.client.solrj.SolrServerException - When an error occurs communicating with the Solr server instance.

indexProduct

public void indexProduct(String productId)
                  throws org.apache.solr.client.solrj.SolrServerException

This method adds a single product retrieved from the File Manager by its product identifier to the Solr index. Metadata from the ProductType is also included.

Parameters:

productId - The identifier of the product (CAS.ProductId).

Throws:

org.apache.solr.client.solrj.SolrServerException - When an error occurs communicating with the Solr server instance.

indexProductByName

public void indexProductByName(String productName,
                               boolean delete)
                        throws org.apache.solr.client.solrj.SolrServerException

This method adds a single product retrieved from the File Manager by its product name to the Solr index. Metadata from the ProductType is also included.

Parameters:

productName - The identifier of the product (CAS.ProductId).

delete - Flag indicating whether the entry should be deleted from the index.

Throws:

org.apache.solr.client.solrj.SolrServerException - When an error occurs communicating with the Solr server instance.

deleteProduct

public void deleteProduct(String productId)
                   throws IOException,
                          org.apache.solr.client.solrj.SolrServerException

This method deletes a single product identified by a productID from the Solr index

Parameters:

productId -

Throws:

IOException

org.apache.solr.client.solrj.SolrServerException

deleteProductByName

public void deleteProductByName(String productName)

This method deletes a product(s) from the Solr index identified by a given name

Parameters:

productName -

Throws:

IOException

org.apache.solr.client.solrj.SolrServerException

buildCommandLine

public static org.apache.commons.cli.Options buildCommandLine()

This method builds the command-line options.

Returns:

Returns the supported Options.

main

public static void main(String[] args)

The main method. Execution without argument displays help message.

Parameters:

args - Command-line arguments.