src/main/java/com/indexdata/mkjsf/pazpar2/data/Pazpar2ResponseParser.java

   1 package com.indexdata.mkjsf.pazpar2.data;\r
   2 \r
   3 import java.io.ByteArrayInputStream;\r
   4 import java.io.IOException;\r
   5 import java.io.UnsupportedEncodingException;\r
   6 import java.util.Arrays;\r
   7 import java.util.List;\r
   8 import java.util.Stack;\r
   9 \r
  10 import javax.xml.parsers.ParserConfigurationException;\r
  11 import javax.xml.parsers.SAXParser;\r
  12 import javax.xml.parsers.SAXParserFactory;\r
  13 \r
  14 import org.xml.sax.Attributes;\r
  15 import org.xml.sax.InputSource;\r
  16 import org.xml.sax.SAXException;\r
  17 import org.xml.sax.XMLReader;\r
  18 import org.xml.sax.helpers.DefaultHandler;\r
  19 \r
  20 import com.indexdata.mkjsf.pazpar2.data.ByTarget;\r
  21 import com.indexdata.mkjsf.pazpar2.data.Hit;\r
  22 import com.indexdata.mkjsf.pazpar2.data.Location;\r
  23 import com.indexdata.mkjsf.pazpar2.data.Pazpar2ResponseData;\r
  24 import com.indexdata.mkjsf.pazpar2.data.RecordResponse;\r
  25 import com.indexdata.mkjsf.pazpar2.data.ShowResponse;\r
  26 import com.indexdata.mkjsf.pazpar2.data.StatResponse;\r
  27 import com.indexdata.mkjsf.pazpar2.data.Target;\r
  28 import com.indexdata.mkjsf.pazpar2.data.TermListResponse;\r
  29 import com.indexdata.mkjsf.pazpar2.data.TermListsResponse;\r
  30 import com.indexdata.mkjsf.pazpar2.data.TermResponse;\r
  31 import com.indexdata.mkjsf.pazpar2.data.TermXTargetResponse;\r
  32 \r
  33 public class Pazpar2ResponseParser extends DefaultHandler {\r
  34 \r
  35   private XMLReader xmlReader = null;\r
  36   private Pazpar2ResponseData currentElement = null;\r
  37   private Stack<Pazpar2ResponseData> dataElements = new Stack<Pazpar2ResponseData>();\r
  38   private Pazpar2ResponseData result = null;\r
  39   private String xml = null;\r
  40 \r
  41   private static final List<String> docTypes = \r
  42       Arrays.asList("bytarget","termlist","show","stat","record","search");\r
  43   \r
  44   public Pazpar2ResponseParser() {    \r
  45     try {\r
  46       initSax();\r
  47     } catch (ParserConfigurationException e) {\r
  48       // TODO Auto-generated catch block\r
  49       e.printStackTrace();\r
  50     } catch (SAXException e) {\r
  51       // TODO Auto-generated catch block\r
  52       e.printStackTrace();\r
  53     }\r
  54   }\r
  55   \r
  56   public static Pazpar2ResponseParser getParser() {\r
  57     return new Pazpar2ResponseParser();\r
  58   }\r
  59   \r
  60   private void initSax() throws ParserConfigurationException, SAXException {\r
  61     SAXParserFactory spf = SAXParserFactory.newInstance();\r
  62     spf.setNamespaceAware(true);\r
  63     SAXParser saxParser = spf.newSAXParser();\r
  64     xmlReader = saxParser.getXMLReader();\r
  65     xmlReader.setContentHandler(this);         \r
  66   }\r
  67   \r
  68   /**\r
  69    * Parses a Pazpar2 XML response -- or an error response as XML -- and produces a \r
  70    * Pazpar2ResponseData object, i.e. a 'show' object\r
  71    * \r
  72    * @param response XML response string from Pazpar2\r
  73    * @return Response data object\r
  74    */\r
  75   public Pazpar2ResponseData getDataObject (String response) {\r
  76     this.xml = response;\r
  77     try {      \r
  78       xmlReader.parse(new InputSource(new ByteArrayInputStream(response.getBytes("UTF-8"))));\r
  79     } catch (UnsupportedEncodingException e) {\r
  80       // TODO Auto-generated catch block\r
  81       e.printStackTrace();      \r
  82     } catch (IOException e) {\r
  83       // TODO Auto-generated catch block\r
  84       e.printStackTrace();\r
  85     } catch (SAXException e) {\r
  86       // TODO Auto-generated catch block\r
  87       e.printStackTrace();      \r
  88     }\r
  89     return result;\r
  90   }\r
  91 \r
  92   /** \r
  93    * Receive notification at the start of element \r
  94    * \r
  95    */\r
  96   @Override\r
  97   public void startElement(String namespaceURI, String localName, String qName, Attributes atts) throws SAXException {\r
  98     if (localName.equals("show")) {\r
  99       currentElement = new ShowResponse();      \r
 100     } else if (localName.equals("hit")) {\r
 101       currentElement = new Hit();\r
 102     } else if (localName.equals("location")) {\r
 103       currentElement = new Location();\r
 104     } else if (localName.equals("bytarget")) {\r
 105       currentElement = new ByTarget();      \r
 106     } else if (localName.equals("target")) {\r
 107       currentElement = new Target();\r
 108     } else if (localName.equals("stat")) {\r
 109       currentElement = new StatResponse();      \r
 110     } else if (localName.equals("termlist")) {\r
 111       currentElement = new TermListsResponse();      \r
 112     } else if (localName.equals("list")) {\r
 113       currentElement = new TermListResponse();\r
 114       ((TermListResponse)currentElement).setName(atts.getValue("name"));\r
 115       ((TermListsResponse)dataElements.peek()).addTermList((TermListResponse)currentElement);\r
 116     } else if (localName.equals("term")) {\r
 117       if (dataElements.peek().getAttribute("name").equals("xtargets")) {\r
 118         currentElement = new TermXTargetResponse();        \r
 119       } else {\r
 120         currentElement = new TermResponse();\r
 121       }\r
 122       ((TermListResponse)dataElements.peek()).addTerm((TermResponse)currentElement);\r
 123     } else if (localName.equals("record")) {\r
 124       currentElement = new RecordResponse();      \r
 125     } else if (localName.equals("search")) {\r
 126       currentElement = new SearchResponse();\r
 127     } else if (localName.equals("applicationerror")) {\r
 128       currentElement = new CommandError();\r
 129     } else if (localName.equals("error") && dataElements.peek().getType().equals("applicationerror")) {\r
 130       currentElement = new Pazpar2Error();     \r
 131     } else {\r
 132       currentElement = new Pazpar2ResponseData();\r
 133     }\r
 134     currentElement.setType(localName);\r
 135     for (int i=0; i< atts.getLength(); i++) {\r
 136        currentElement.setAttribute(atts.getLocalName(i), atts.getValue(i));\r
 137     }\r
 138     if (!docTypes.contains(localName)) {\r
 139       dataElements.peek().addElement(localName, currentElement);\r
 140     }\r
 141     if (this.xml != null) { // Store XML for doc level elements\r
 142       currentElement.setXml(xml);\r
 143       xml = null;\r
 144     }\r
 145     dataElements.push(currentElement);    \r
 146   }\r
 147  \r
 148   @Override\r
 149   public void characters(char[] ch, int start, int length) throws SAXException {\r
 150     String data = new String(ch, start, length);        \r
 151     dataElements.peek().appendContent(data);    \r
 152   }\r
 153   \r
 154   @Override\r
 155   public void endElement(String namespaceURI, String localName, String qName) throws SAXException {\r
 156     if (dataElements.size()==1) {\r
 157       result = dataElements.pop();\r
 158     } else {\r
 159       dataElements.pop();\r
 160     }\r
 161   }\r
 162 }\r