OleSRUDataServiceImpl

package org.kuali.ole.serviceimpl;


import org.apache.commons.lang.StringEscapeUtils;
import org.kuali.ole.OleSRUConstants;
import org.kuali.ole.PropertyUtil;
import org.kuali.ole.bo.serachRetrieve.*;
import org.kuali.ole.docstore.discovery.service.SRUCQLQueryService;
import org.kuali.ole.docstore.discovery.service.SRUCQLQueryServiceImpl;
import org.kuali.ole.docstore.model.bo.OleDocument;
import org.kuali.ole.docstore.model.bo.WorkBibDocument;
import org.kuali.ole.handler.OleSRUOpacXMLResponseHandler;
import org.kuali.ole.repository.CheckoutManager;
import org.kuali.ole.service.OleDiagnosticsService;
import org.kuali.ole.service.OleSRUDataService;

import java.util.ArrayList;
import java.util.List;
import java.util.Map;


/**
 * Created with IntelliJ IDEA.
 * User: ?
 * Date: 7/9/12
 * Time: 7:41 PM
 * To change this template use File | Settings | File Templates.
 */
public class OleSRUDataServiceImpl implements OleSRUDataService {

    public SRUCQLQueryService srucqlQueryService;
    public OleDiagnosticsService oleDiagnosticsService;

    public OleSRUDataServiceImpl()
    {
        srucqlQueryService = SRUCQLQueryServiceImpl.getInstance();
        oleDiagnosticsService=new OleDiagnosticsServiceImpl();
    }

    /**
     * this method will fetch the bib id list from the docstore
     * @param reqParamMap
     * @param solrQuery
     * @return list of bib id
     */
    public List getBibRecordsIdList(Map reqParamMap,String solrQuery){

        List oleBibIDList=null;
        List<OleDocument> oleDocumentsList=null;
        try{
            oleDocumentsList = (ArrayList<OleDocument>)srucqlQueryService.queryForBibDocs(reqParamMap,solrQuery);
            oleBibIDList=new ArrayList();
            if(oleDocumentsList.size()>0)  {
              oleBibIDList= generateBibIDList(oleDocumentsList);
            }
        }
        catch (Exception e){
            System.out.println(e);
        }
      return oleBibIDList;
    }

    /**
     * this method will fetch the bib details , holding details from the docstore data base , creates an object for bib and holdings , and generates OPAC xml
     * @param oleBibIDList
     * @param    reqParamMap
     * @return  opac xml or diagnostics or oleSRUResponseDocuments as a string depends upon the record packing
     */
    public String getOPACXMLSearchRetrieveResponse(List oleBibIDList,Map reqParamMap){

        if(oleBibIDList!=null &&  oleBibIDList.size()>0){
            OleSRUOpacXMLResponseHandler oleSRUOpacXMLResponseHandler =new OleSRUOpacXMLResponseHandler();
            OleSRUResponseDocuments oleSRUResponseDocuments=new OleSRUResponseDocuments();
            List<OleSRUResponseDocument> oleSRUResponseDocumentList=new ArrayList<OleSRUResponseDocument>();
            String bibRecordInfo=null;
            for(int i=0;i<oleBibIDList.size();i++)
             {
                 List<OleSRUInstanceDocument> oleSRUInstanceDocumentList = getOleSRUInstanceDocument();
                 OleSRUResponseDocument oleSRUResponseDocument=new OleSRUResponseDocument();
                 bibRecordInfo=getBibliographicRecordInfo((String) oleBibIDList.get(i));
                 oleSRUResponseDocument.setBibliographicRecord(bibRecordInfo);
                 oleSRUResponseDocument.setHoldings(oleSRUInstanceDocumentList);
                 if(reqParamMap.containsKey(OleSRUConstants.EXTRA_REQ_DATA_KEY))
                    oleSRUResponseDocument.setExtraRequestData(getExtraReqDataInfo(reqParamMap));
                 oleSRUResponseDocumentList.add(oleSRUResponseDocument);
             }
            oleSRUResponseDocuments.setOpacRecords(oleSRUResponseDocumentList);
            if(OleSRUConstants.RECORD_PACK_XML.equalsIgnoreCase((String)reqParamMap.get(OleSRUConstants.RECORD_PACKING))) {
                String opacXML= oleSRUOpacXMLResponseHandler.toXML(oleSRUResponseDocuments);
                if (null != opacXML)
                    opacXML = replaceStringWithSymbols(opacXML);

                return opacXML;
            }
            else if(OleSRUConstants.RECORD_PACK_STRING.equalsIgnoreCase((String)reqParamMap.get(OleSRUConstants.RECORD_PACKING))){
               return oleSRUResponseDocuments.toString();
            }
        }
        return oleDiagnosticsService.getDiagnosticResponse(PropertyUtil.getPropertyUtil().getProperty(OleSRUConstants.NORECORDS_DIAGNOSTIC_MSG));
    }

    /**
     * this will generate the list of document from docstore
     * @param oleDocumentsList (list of OleDocument)
     * @return bib id list
     */
    public List generateBibIDList( List<OleDocument> oleDocumentsList){

        List oleBibIDList=new ArrayList();
        WorkBibDocument workBibDocument=null;
        for(int i=0;i<oleDocumentsList.size();i++){
             workBibDocument=(WorkBibDocument)oleDocumentsList.get(i);
            oleBibIDList.add(workBibDocument.getId());
        }
        return oleBibIDList;
    }

    /**
     * this method will do checkout operation of docstore which gives the bib info details
     * @param uuid
     * @return bib info xml as a string
     */
    public String getBibliographicRecordInfo(String uuid){

        String bibRecordInfo=null;
        CheckoutManager checkoutManager=new CheckoutManager();
        try{
            bibRecordInfo=checkoutManager.checkOut(uuid,"defaultUser","checkOut");
            if(bibRecordInfo!=null)
                bibRecordInfo=bibRecordInfo.replace("<?xml version=\"1.0\" encoding=\"UTF-8\"?>","");
        }
        catch(Exception e){}
        return bibRecordInfo;
    }

    /**
     *  to replace the encoded value from the string to original special character to display as an xml
     * @param opacXML
     * @return opac xml response
     */
    private String replaceStringWithSymbols(String opacXML){
        opacXML = opacXML.replaceAll("&lt;","<");
        opacXML = opacXML.replaceAll("&gt;",">");
        opacXML = opacXML.replaceAll("&quot;","\"");
        opacXML = opacXML.replaceAll("&apos;", "\'");
        //opacXML = opacXML.replaceAll("&","&amp;");
        //opacXML = StringEscapeUtils.unescapeHtml(opacXML).replaceAll("[^\\x20-\\x7e]", "");

        return opacXML;
    }

    public List<OleSRUInstanceDocument> getOleSRUInstanceDocument(){
        OleSRUInstanceDocument oleSRUInstanceDocument = new OleSRUInstanceDocument();
        List<OleSRUInstanceDocument> oleSRUInstanceDocumentList = new ArrayList<OleSRUInstanceDocument>();
        List<OleSRUCirculationDocument> oleSRUCirculationDocumentList = getOleSRUCirculationDocument();
        List<OleSRUInstanceVolume> oleSRUInstanceVolumeList = getOleSRUInstanceVolumes();
        oleSRUInstanceDocument.setCallNumber("mockCallNumber");
        oleSRUInstanceDocument.setCompleteness("mockCompleteness");
        oleSRUInstanceDocument.setCopyNumber("mockCopyNumber");
        oleSRUInstanceDocument.setDateOfReport("mockDateOfReport");
        oleSRUInstanceDocument.setEncodingLevel("mockEncodingLevel");
        oleSRUInstanceDocument.setEnumAndChron("mockEnumAndChorn");
        oleSRUInstanceDocument.setFormat("mockFormat");
        oleSRUInstanceDocument.setGeneralRetention("mockGeneralRentention");
        oleSRUInstanceDocument.setLocalLocation("mockLocalLocation");
        oleSRUInstanceDocument.setTypeOfRecord("mockTypeOfRecord");
        oleSRUInstanceDocument.setShelvingLocation("mockShelvingLocation");
        oleSRUInstanceDocument.setShelvingData("mockShelvingData");
        oleSRUInstanceDocument.setReproductionNote("mockReproductionNote");
        oleSRUInstanceDocument.setReceiptAcqStatus("mockReceiptAcqStatus");
        oleSRUInstanceDocument.setNucCode("mockNucCode");
        oleSRUInstanceDocument.setPublicNote("mockPublicNote");
        oleSRUInstanceDocument.setCirculations(oleSRUCirculationDocumentList);
        oleSRUInstanceDocument.setVolumes(oleSRUInstanceVolumeList);
        oleSRUInstanceDocumentList.add(oleSRUInstanceDocument);
        return oleSRUInstanceDocumentList;
    }

    public List<OleSRUCirculationDocument> getOleSRUCirculationDocument(){

        OleSRUCirculationDocument oleSRUCirculationDocument = new OleSRUCirculationDocument();
        List<OleSRUCirculationDocument> oleSRUCirculationDocumentList = new ArrayList<OleSRUCirculationDocument>();
        oleSRUCirculationDocument.setAvailabilityDate("mockAvailabilityDate");
        oleSRUCirculationDocument.setAvailableNow("mockAvailableNow");
        oleSRUCirculationDocument.setAvailableThru("mockAvailableThru");
        oleSRUCirculationDocument.setEnumAndChron("mockEnumAndChron");
        oleSRUCirculationDocument.setItemId("mockItemId");
        oleSRUCirculationDocument.setMidspine("mockMidspine");
        oleSRUCirculationDocument.setOnHold("mockOnHold");
        oleSRUCirculationDocument.setRenewable("mockRenewable");
        oleSRUCirculationDocument.setRestrictions("mockRestrictions");
        oleSRUCirculationDocument.setTemporaryLocation("mockTemporaryLocation");
        oleSRUCirculationDocumentList.add(oleSRUCirculationDocument);
        return oleSRUCirculationDocumentList;
    }

    public List<OleSRUInstanceVolume> getOleSRUInstanceVolumes(){
        OleSRUInstanceVolume oleSRUInstanceVolume = new OleSRUInstanceVolume();
        List<OleSRUInstanceVolume> oleSRUInstanceVolumeList = new ArrayList<OleSRUInstanceVolume>();
        oleSRUInstanceVolume.setChronology("mockChronology");
        oleSRUInstanceVolume.setEnumAndChron("mockEnumAndChron");
        oleSRUInstanceVolume.setEnumeration("mockEnumeration");
        oleSRUInstanceVolumeList.add(oleSRUInstanceVolume);
        return oleSRUInstanceVolumeList;
    }
    public String getExtraReqDataInfo(Map reqParamMap){

        return "<theo:"+reqParamMap.get(OleSRUConstants.EXTRA_REQ_DATA_KEY) +" xmlns:theo=\""+PropertyUtil.getPropertyUtil().getProperty(OleSRUConstants.EXTRA_REQ_DATA_XML_NAMESPACE)+"\">\n" +
                reqParamMap.get(OleSRUConstants.EXTRA_REQ_DATA_VALUE)+"\n" +
                "</theo:"+reqParamMap.get(OleSRUConstants.EXTRA_REQ_DATA_KEY)+">";
    }
}