src/jalview/ws/io/mime/JalviewMimeContentHandler.java

   1 package jalview.ws.io.mime;
   2
   3 import jalview.io.packed.DataProvider;
   4 import jalview.io.packed.JalviewDataset;
   5
   6 import java.io.IOException;
   7 import java.io.InputStream;
   8 import java.util.ArrayList;
   9 import java.util.List;
  10
  11 import org.apache.james.mime4j.MimeException;
  12 import org.apache.james.mime4j.descriptor.BodyDescriptor;
  13 import org.apache.james.mime4j.parser.ContentHandler;
  14 import org.apache.james.mime4j.parser.Field;
  15
  16 /**
  17  * ContentHandler for parsing mime encoded messages into Jalview objects.
  18  * TODO: complete implementation
  19  * TODO: test implementation
  20  * TODO: hook in to Jalview IO and service response parser.
  21  * @author JimP
  22  *
  23  */
  24 public class JalviewMimeContentHandler implements ContentHandler
  25 {
  26   /**
  27    * context for data parsed from multi-part mime document
  28    */
  29   JalviewDataset context;
  30
  31   /**
  32    * create a new handler to process a Jalview mime message.
  33    * @param ds
  34    */
  35   public JalviewMimeContentHandler(JalviewDataset ds)
  36   {
  37     context=ds;
  38   }
  39   /**
  40    * type of data pack being parsed currently
  41    */
  42   String currentType;
  43   /**
  44    * name of data pack being parsed currently
  45    */
  46   String currentName;
  47
  48   /**
  49    * sources for data to be parsed
  50    */
  51   List<DataProvider> dataItems = new ArrayList<DataProvider>();
  52
  53   @Override
  54   public void body(BodyDescriptor arg0, InputStream arg1)
  55           throws MimeException, IOException
  56   {
  57
  58     // TODO Auto-generated method stub
  59
  60   }
  61
  62   @Override
  63   public void endBodyPart() throws MimeException
  64   {
  65     // TODO Auto-generated method stub
  66
  67   }
  68
  69   @Override
  70   public void endHeader() throws MimeException
  71   {
  72     // TODO Auto-generated method stub
  73
  74   }
  75
  76   @Override
  77   public void endMessage() throws MimeException
  78   {
  79     // TODO Auto-generated method stub
  80
  81   }
  82
  83   @Override
  84   public void endMultipart() throws MimeException
  85   {
  86     // TODO Auto-generated method stub
  87
  88   }
  89
  90   @Override
  91   public void epilogue(InputStream arg0) throws MimeException, IOException
  92   {
  93     // TODO Auto-generated method stub
  94
  95   }
  96
  97   @Override
  98   public void field(Field arg0) throws MimeException
  99   {
 100     // TODO Auto-generated method stub
 101
 102   }
 103
 104   @Override
 105   public void preamble(InputStream arg0) throws MimeException, IOException
 106   {
 107     // TODO Auto-generated method stub
 108
 109   }
 110
 111   @Override
 112   public void raw(InputStream arg0) throws MimeException, IOException
 113   {
 114     // TODO Auto-generated method stub
 115
 116   }
 117
 118   @Override
 119   public void startBodyPart() throws MimeException
 120   {
 121     // TODO Auto-generated method stub
 122
 123   }
 124
 125   @Override
 126   public void startHeader() throws MimeException
 127   {
 128     // TODO Auto-generated method stub
 129
 130   }
 131
 132   @Override
 133   public void startMessage() throws MimeException
 134   {
 135     // TODO Auto-generated method stub
 136
 137   }
 138
 139   @Override
 140   public void startMultipart(BodyDescriptor arg0) throws MimeException
 141   {
 142     // TODO Auto-generated method stub
 143
 144   }
 145
 146   /**
 147    *
 148    * @return data providers to parse each data file extracted from the mime stream.
 149    */
 150   public Iterable<DataProvider> getJalviewDataProviders()
 151   {
 152     // TODO Auto-generated method stub
 153     return null;
 154   }
 155
 156 }