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