BeagleClient/QueryResponses.cs

   1 //
   2 // QueryResponses.cs
   3 //
   4 // Copyright (C) 2005 Novell, Inc.
   5 //
   6
   7 //
   8 // Permission is hereby granted, free of charge, to any person obtaining a
   9 // copy of this software and associated documentation files (the "Software"),
  10 // to deal in the Software without restriction, including without limitation
  11 // the rights to use, copy, modify, merge, publish, distribute, sublicense,
  12 // and/or sell copies of the Software, and to permit persons to whom the
  13 // Software is furnished to do so, subject to the following conditions:
  14 //
  15 // The above copyright notice and this permission notice shall be included in
  16 // all copies or substantial portions of the Software.
  17 //
  18 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  19 // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  20 // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  21 // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  22 // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  23 // FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  24 // DEALINGS IN THE SOFTWARE.
  25 //
  26
  27 using System;
  28 using System.Collections;
  29 using System.Xml.Serialization;
  30
  31 using Beagle.Util;
  32
  33 namespace Beagle {
  34
  35         // The various async responses from a Query request
  36
  37         public class HitsAddedResponse : ResponseMessage {
  38                 [XmlArray (ElementName="Hits")]
  39                 [XmlArrayItem (ElementName="Hit", Type=typeof (Hit))]
  40                 public ArrayList Hits;
  41
  42                 public HitsAddedResponse () { }
  43
  44                 public HitsAddedResponse (ICollection hits)
  45                 {
  46                         this.Hits = new ArrayList (hits);
  47                 }
  48         }
  49
  50         public class HitsSubtractedResponse : ResponseMessage {
  51                 private ICollection uris;
  52
  53                 public HitsSubtractedResponse () { }
  54
  55                 public HitsSubtractedResponse (ICollection uris)
  56                 {
  57                         this.uris = uris;
  58                 }
  59
  60                 [XmlIgnore]
  61                 public ICollection Uris {
  62                         get { return this.uris; }
  63                 }
  64
  65                 [XmlArray (ElementName="Uris")]
  66                 [XmlArrayItem (ElementName="Uri")]
  67                 public string[] UrisAsStrings {
  68                         get {
  69                                 string[] uris = new string [this.uris.Count];
  70
  71                                 int i = 0;
  72                                 foreach (Uri uri in this.uris) {
  73                                         uris [i] = UriFu.UriToEscapedString (uri);
  74                                         i++;
  75                                 }
  76
  77                                 return uris;
  78                         }
  79
  80                         set {
  81                                 int N = value.Length;
  82                                 Uri[] uris = new Uri [N];
  83
  84                                 for (int i = 0; i < N; i++)
  85                                         uris [i] = UriFu.EscapedStringToUri (value [i]);
  86
  87                                 this.uris = uris;
  88                         }
  89                 }
  90         }
  91
  92         public class FinishedResponse : ResponseMessage { }
  93
  94         public class SearchTermResponse : ResponseMessage {
  95
  96                 [XmlArray (ElementName="Exact")]
  97                 [XmlArrayItem (ElementName="Text", Type=typeof (string))]
  98                 public ArrayList ExactText;
  99
 100                 [XmlArray (ElementName="Stemmed")]
 101                 [XmlArrayItem (ElementName="Text", Type=typeof (string))]
 102                 public ArrayList StemmedText;
 103
 104
 105                 public SearchTermResponse ()
 106                 {
 107                         ExactText = new ArrayList ();
 108                         StemmedText = new ArrayList ();
 109                 }
 110         }
 111 }