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