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 List<String> docTypes = Arrays.asList(  "bytarget","termlist","show","stat","record","search","init",\r
  31                                         /* SP extras */ "response" );                                        \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       e.printStackTrace(); \r
  70     } catch (IOException e) {\r
  71       e.printStackTrace();\r
  72     } catch (SAXException e) {\r
  73       e.printStackTrace();      \r
  74     }\r
  75     return result;\r
  76   }\r
  77 \r
  78   /** \r
  79    * Receive notification at the start of element \r
  80    * \r
  81    */\r
  82   @Override\r
  83   public void startElement(String namespaceURI, String localName, String qName, Attributes atts) throws SAXException {\r
  84     if (localName.equals("init")) {\r
  85       currentElement = new InitResponse();\r
  86     } else if (localName.equals("search")) {\r
  87       currentElement = new SearchResponse();\r
  88     } else if (localName.equals("show")) {\r
  89       currentElement = new ShowResponse();      \r
  90     } else if (localName.equals("hit")) {\r
  91       currentElement = new Hit();\r
  92     } else if (localName.equals("location")) {\r
  93       currentElement = new Location();\r
  94     } else if (localName.equals("record")) {\r
  95       currentElement = new RecordResponse();            \r
  96     } else if (localName.equals("bytarget")) {\r
  97       currentElement = new ByTarget();      \r
  98     } else if (localName.equals("target")) {\r
  99       currentElement = new Target();\r
 100     } else if (localName.equals("stat")) {\r
 101       currentElement = new StatResponse();      \r
 102     } else if (localName.equals("termlist")) {\r
 103       currentElement = new TermListsResponse();      \r
 104     } else if (localName.equals("list")) {\r
 105       currentElement = new TermListResponse();\r
 106       ((TermListResponse)currentElement).setName(atts.getValue("name"));\r
 107       ((TermListsResponse)dataElements.peek()).addTermList((TermListResponse)currentElement);\r
 108     } else if (localName.equals("term")) {\r
 109       if (dataElements.peek().getAttribute("name").equals("xtargets")) {\r
 110         currentElement = new TermXTargetResponse();        \r
 111       } else {\r
 112         currentElement = new TermResponse();\r
 113       }\r
 114       ((TermListResponse)dataElements.peek()).addTerm((TermResponse)currentElement);\r
 115     } else if (localName.equals("applicationerror")) {\r
 116       currentElement = new CommandError();\r
 117     } else if (localName.equals("error") && dataElements.peek().getType().equals("applicationerror")) {\r
 118       currentElement = new Pazpar2Error(); \r
 119     } else if (localName.equals("response")) {  // Note, document element not named 'auth'\r
 120       currentElement = new AuthResponse();\r
 121     } else {\r
 122       currentElement = new ResponseDataObject();\r
 123     }\r
 124     currentElement.setType(localName);\r
 125     for (int i=0; i< atts.getLength(); i++) {\r
 126        currentElement.setAttribute(atts.getLocalName(i), atts.getValue(i));\r
 127     }    \r
 128     if (!docTypes.contains(localName)) {\r
 129       if (dataElements.size() == 0) {\r
 130         logger.info("Encountered unknown top level element [" + localName + "]. Creating generic data object.");\r
 131         currentElement.setType(localName);\r
 132       } else {\r
 133         dataElements.peek().addElement(localName, currentElement);\r
 134       }\r
 135     }\r
 136     if (this.xml != null) { // Store XML for doc level elements\r
 137       currentElement.setXml(xml);\r
 138       xml = null;\r
 139     }\r
 140     dataElements.push(currentElement);    \r
 141   }\r
 142  \r
 143   @Override\r
 144   public void characters(char[] ch, int start, int length) throws SAXException {\r
 145     String data = new String(ch, start, length);        \r
 146     dataElements.peek().appendContent(data);    \r
 147   }\r
 148   \r
 149   @Override\r
 150   public void endElement(String namespaceURI, String localName, String qName) throws SAXException {\r
 151     if (dataElements.size()==1) {\r
 152       result = dataElements.pop();\r
 153     } else {\r
 154       dataElements.pop();\r
 155     }\r
 156   }\r
 157 }\r