org.kuali.ole.docstore.indexer.solr

Class AbstractDocumentIndexer

java.lang.Object

org.kuali.ole.docstore.indexer.solr.AbstractDocumentIndexer

All Implemented Interfaces:

IndexerService

Direct Known Subclasses:

WorkBibDocumentIndexer, WorkBibMarcDocumentIndexer, WorkEInstanceDocumentIndexer, WorkHoldingsDocumentIndexer, WorkInstanceDocumentIndexer, WorkItemDocumentIndexer, WorkLicenseDocumentIndexer

public abstract class AbstractDocumentIndexer
extends Object
implements IndexerService

Created with IntelliJ IDEA. User: mjagan Date: 7/2/13 Time: 4:18 PM To change this template use File | Settings | File Templates.

Field Summary

Fields

Modifier and Type	Field and Description
long	commitRecCount
WorkBibMarcDocBuilder	workBibMarcDocBuilder1

Fields inherited from interface org.kuali.ole.docstore.indexer.solr.IndexerService

BATCH_SIZE, BIBLIOGRAPHIC, DOC_FORMAT, DOC_TYPE, FAILURE, HOLDINGS_IDENTIFIER, ID_FIELD_PREFIX, INSTANCE, ITEM_IDENTIFIER, SUCCESS, UUID_FILE_NAME_SUFFIX

Constructor Summary

Constructors

Constructor and Description
AbstractDocumentIndexer()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	assignUUIDs(List<org.apache.solr.common.SolrInputDocument> solrDocs, List<String> ids) Assigns UUIDs for each document (that does not have an "id" field) in the given list.
String	bind(List<RequestDocument> requestDocuments)
String	bind(RequestDocument requestDocument)
protected String	buildDeleteQuery(String uuid, String category, boolean commit) Deprecated.
protected String	buildDeleteQueryParamsForDeleteUrl(List<String> uuidList, boolean commit) Deprecated.
protected String	buildFailureMsg()
protected String	buildFailureMsg(String id, String msg)
String	buildUuid() Builds a UUID value with an identifiable prefix.
String	bulkIndexDocuments(List<RequestDocument> requestDocuments, boolean isCommit) Method to bulk Index Documents
void	cleanupDiscoveryData()
void	commit()
protected List<org.apache.solr.common.SolrInputDocument>	convertToSolrDocs(String docCategory, String docType, String docFormat, String docContent)
String	delete(List<RequestDocument> requestDocuments)
String	delete(RequestDocument requestDocument)
String	deleteDocument(String docCategory, String uuid) Deletes the document (if existing) with the given uuid.
protected String	deleteDocumentByUUID(String uuid, String category)
protected String	deleteDocumentByUUID(String uuid, String category, boolean commit)
String	deleteDocuments(String docCategory, List<String> uuidList) Deletes the documents (if existing) with the Ids specified in the given uuidList.
protected String	deleteDocumentsByUUIDList(List<String> uuidsList, String category)
protected String	deleteDocumentsByUUIDList(List<String> uuidList, String category, boolean commit)
protected String	getErrorID()
List<org.apache.solr.common.SolrDocument>	getSolrDocument(String fieldName, String fieldValue)
List<org.apache.solr.common.SolrDocument>	getSolrDocumentBySolrId(String uniqueId)
String	indexDocument(RequestDocument requestDocument)
String	indexDocument(RequestDocument requestDocument, boolean commit)
String	indexDocuments(List<RequestDocument> requestDocuments)
String	indexDocumentsFromDirBySolrDoc(String docCategory, String docType, String docFormat, String dataDir) Indexes the documents from the xml files in the given fileDir.
String	indexDocumentsFromFileBySolrDoc(String docCategory, String docType, String docFormat, String filePath)
String	indexDocumentsFromFiles(String docCategory, String docType, String docFormat, List<File> fileList) Indexes the records (of the given docCategory, docType and docFormat) from the files in the given data directory.
String	indexDocumentsFromStringBySolrDoc(String docCategory, String docType, String docFormat, String data)
String	indexSolrDocuments(List<org.apache.solr.common.SolrInputDocument> solrDocs)
String	indexSolrDocuments(List<org.apache.solr.common.SolrInputDocument> solrDocs, boolean commit)
protected String	indexSolrDocuments(List<org.apache.solr.common.SolrInputDocument> solrDocs, boolean commit, boolean optimize)
protected String	indexSolrDocuments(List<org.apache.solr.common.SolrInputDocument> solrDocs, boolean isCommit, boolean optimize, boolean waitFlush, boolean waitSearcher)
protected void	init()
protected void	openConnection(URL inputURL) Deprecated.
void	rollback()
org.apache.solr.client.solrj.response.QueryResponse	searchBibRecord(String docCat, String docType, String docFormat, String fieldName, String fieldValue, String fieldList)
void	transferInstances(List<RequestDocument> requestDocuments)
void	transferItems(List<RequestDocument> requestDocuments)
String	unbind(List<RequestDocument> requestDocuments)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.kuali.ole.docstore.indexer.solr.IndexerService

indexDocuments

Field Detail

workBibMarcDocBuilder1

public WorkBibMarcDocBuilder workBibMarcDocBuilder1

commitRecCount

public long commitRecCount

Constructor Detail

AbstractDocumentIndexer

public AbstractDocumentIndexer()

Method Detail

init

protected void init()

deleteDocuments

public String deleteDocuments(String docCategory,
                     List<String> uuidList)
                       throws MalformedURLException,
                              org.apache.solr.client.solrj.SolrServerException

Description copied from interface: IndexerService

Deletes the documents (if existing) with the Ids specified in the given uuidList.

Specified by:

deleteDocuments in interface IndexerService

Returns:

SUCCESS or FAILURE (with error id if any)

Throws:

MalformedURLException

org.apache.solr.client.solrj.SolrServerException

deleteDocument

public String deleteDocument(String docCategory,
                    String uuid)

Description copied from interface: IndexerService

Deletes the document (if existing) with the given uuid.

Specified by:

deleteDocument in interface IndexerService

Returns:

SUCCESS or FAILURE (with error id if any)

indexSolrDocuments

public String indexSolrDocuments(List<org.apache.solr.common.SolrInputDocument> solrDocs)

Specified by:

indexSolrDocuments in interface IndexerService

indexSolrDocuments

public String indexSolrDocuments(List<org.apache.solr.common.SolrInputDocument> solrDocs,
                        boolean commit)

indexDocumentsFromDirBySolrDoc

public String indexDocumentsFromDirBySolrDoc(String docCategory,
                                    String docType,
                                    String docFormat,
                                    String dataDir)

Description copied from interface: IndexerService

Indexes the documents from the xml files in the given fileDir. Uses solrj API (SolrInputDocuments) instead of DIH (DataImportHandler). The name of xml files should be of the form "{uuid}_UUID_.xml", where {uuid} is the "id" field value for the document in the xml file. Otherwise a random uuid will be assigned for the document.

Specified by:

indexDocumentsFromDirBySolrDoc in interface IndexerService

Returns:

SUCCESS ("success-N" where N is num of documents processed); FAILURE (with error id if any).

indexDocumentsFromStringBySolrDoc

public String indexDocumentsFromStringBySolrDoc(String docCategory,
                                       String docType,
                                       String docFormat,
                                       String data)
                                         throws IOException

Specified by:

indexDocumentsFromStringBySolrDoc in interface IndexerService

Throws:

IOException

indexDocumentsFromFileBySolrDoc

public String indexDocumentsFromFileBySolrDoc(String docCategory,
                                     String docType,
                                     String docFormat,
                                     String filePath)

Specified by:

indexDocumentsFromFileBySolrDoc in interface IndexerService

indexDocumentsFromFiles

public String indexDocumentsFromFiles(String docCategory,
                             String docType,
                             String docFormat,
                             List<File> fileList)

Indexes the records (of the given docCategory, docType and docFormat) from the files in the given data directory.

This is a utility method to use Discovery separately from DocStore.

Specified by:

indexDocumentsFromFiles in interface IndexerService

Parameters:

docCategory - category of the documents expected in the input files

docType - type of the documents expected in the input files

docFormat - format of the documents expected in the input files

fileList - list of files to be indexed

Returns:

SUCCESS or FAILURE

indexDocument

public String indexDocument(RequestDocument requestDocument)

Specified by:

indexDocument in interface IndexerService

indexDocument

public String indexDocument(RequestDocument requestDocument,
                   boolean commit)

Specified by:

indexDocument in interface IndexerService

indexDocuments

public String indexDocuments(List<RequestDocument> requestDocuments)

Specified by:

indexDocuments in interface IndexerService

bulkIndexDocuments

public String bulkIndexDocuments(List<RequestDocument> requestDocuments,
                        boolean isCommit)

Description copied from interface: IndexerService

Method to bulk Index Documents

Specified by:

bulkIndexDocuments in interface IndexerService

Returns:

getSolrDocumentBySolrId

public List<org.apache.solr.common.SolrDocument> getSolrDocumentBySolrId(String uniqueId)

Specified by:

getSolrDocumentBySolrId in interface IndexerService

getSolrDocument

public List<org.apache.solr.common.SolrDocument> getSolrDocument(String fieldName,
                                                        String fieldValue)

Specified by:

getSolrDocument in interface IndexerService

buildUuid

public String buildUuid()

Builds a UUID value with an identifiable prefix. Used when a document does not have a UUID assigned by docstore. Typical scenario is when discovery layer is used without docstore.

Specified by:

buildUuid in interface IndexerService

Returns:

assignUUIDs

protected void assignUUIDs(List<org.apache.solr.common.SolrInputDocument> solrDocs,
               List<String> ids)
                    throws Exception

Assigns UUIDs for each document (that does not have an "id" field) in the given list. Also makes sure "uniqueId" field is present. The UUIDs generated by this method start with ID_FIELD_PREFIX for easy identification. Optionally takes a list of UUIDs to be used to set/override the "id" field values of the documents.

Parameters:

solrDocs -

ids - List of id values (optional) to be used for the given documents.

Throws:

Exception

commit

public void commit()
            throws Exception

Specified by:

commit in interface IndexerService

Throws:

Exception

rollback

public void rollback()
              throws Exception

Specified by:

rollback in interface IndexerService

Throws:

Exception

indexSolrDocuments

protected String indexSolrDocuments(List<org.apache.solr.common.SolrInputDocument> solrDocs,
                        boolean isCommit,
                        boolean optimize,
                        boolean waitFlush,
                        boolean waitSearcher)
                             throws Exception

Throws:

Exception

indexSolrDocuments

protected String indexSolrDocuments(List<org.apache.solr.common.SolrInputDocument> solrDocs,
                        boolean commit,
                        boolean optimize)
                             throws Exception

Throws:

Exception

convertToSolrDocs

protected List<org.apache.solr.common.SolrInputDocument> convertToSolrDocs(String docCategory,
                                                               String docType,
                                                               String docFormat,
                                                               String docContent)
                                                                    throws Exception

Throws:

Exception

deleteDocumentByUUID

protected String deleteDocumentByUUID(String uuid,
                          String category,
                          boolean commit)

deleteDocumentByUUID

protected String deleteDocumentByUUID(String uuid,
                          String category)

deleteDocumentsByUUIDList

protected String deleteDocumentsByUUIDList(List<String> uuidList,
                               String category,
                               boolean commit)

deleteDocumentsByUUIDList

protected String deleteDocumentsByUUIDList(List<String> uuidsList,
                               String category)
                                    throws org.apache.solr.client.solrj.SolrServerException,
                                           MalformedURLException

Throws:

org.apache.solr.client.solrj.SolrServerException

MalformedURLException

buildDeleteQueryParamsForDeleteUrl

@Deprecated
protected String buildDeleteQueryParamsForDeleteUrl(List<String> uuidList,
                                                   boolean commit)

Deprecated.

buildDeleteQuery

@Deprecated
protected String buildDeleteQuery(String uuid,
                                 String category,
                                 boolean commit)

Deprecated.

openConnection

@Deprecated
protected void openConnection(URL inputURL)
                       throws Exception

Deprecated.

Parameters:

inputURL -

Throws:

Exception

getErrorID

protected String getErrorID()

buildFailureMsg

protected String buildFailureMsg(String id,
                     String msg)

buildFailureMsg

protected String buildFailureMsg()

searchBibRecord

public org.apache.solr.client.solrj.response.QueryResponse searchBibRecord(String docCat,
                                                                  String docType,
                                                                  String docFormat,
                                                                  String fieldName,
                                                                  String fieldValue,
                                                                  String fieldList)

Specified by:

searchBibRecord in interface IndexerService

cleanupDiscoveryData

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

Specified by:

cleanupDiscoveryData in interface IndexerService

Throws:

IOException

org.apache.solr.client.solrj.SolrServerException

bind

public String bind(List<RequestDocument> requestDocuments)
            throws Exception

Specified by:

bind in interface IndexerService

Throws:

Exception

bind

public String bind(RequestDocument requestDocument)
            throws Exception

Specified by:

bind in interface IndexerService

Throws:

Exception

unbind

public String unbind(List<RequestDocument> requestDocuments)
              throws Exception

Specified by:

unbind in interface IndexerService

Throws:

Exception

transferInstances

public void transferInstances(List<RequestDocument> requestDocuments)
                       throws Exception

Specified by:

transferInstances in interface IndexerService

Throws:

Exception

transferItems

public void transferItems(List<RequestDocument> requestDocuments)
                   throws Exception

Specified by:

transferItems in interface IndexerService

Throws:

Exception

delete

public String delete(List<RequestDocument> requestDocuments)
              throws Exception

Specified by:

delete in interface IndexerService

Throws:

Exception

delete

public String delete(RequestDocument requestDocument)
              throws Exception

Specified by:

delete in interface IndexerService

Throws:

Exception