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

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