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                 [XmlElement ("NumMatches")]
  43                 public int NumMatches;
  44
  45                 public HitsAddedResponse () { }
  46
  47                 public HitsAddedResponse (ICollection hits, int total)
  48                 {
  49                         this.Hits = new ArrayList (hits);
  50                         this.NumMatches = total;
  51                 }
  52         }
  53
  54         public class HitsSubtractedResponse : ResponseMessage {
  55                 private ICollection uris;
  56
  57                 public HitsSubtractedResponse () { }
  58
  59                 public HitsSubtractedResponse (ICollection uris)
  60                 {
  61                         this.uris = uris;
  62                 }
  63
  64                 [XmlIgnore]
  65                 public ICollection Uris {
  66                         get { return this.uris; }
  67                 }
  68
  69                 [XmlArray (ElementName="Uris")]
  70                 [XmlArrayItem (ElementName="Uri")]
  71                 public string[] UrisAsStrings {
  72                         get {
  73                                 string[] uris = new string [this.uris.Count];
  74
  75                                 int i = 0;
  76                                 foreach (Uri uri in this.uris) {
  77                                         uris [i] = UriFu.UriToEscapedString (uri);
  78                                         i++;
  79                                 }
  80
  81                                 return uris;
  82                         }
  83
  84                         set {
  85                                 int N = value.Length;
  86                                 Uri[] uris = new Uri [N];
  87
  88                                 for (int i = 0; i < N; i++)
  89                                         uris [i] = UriFu.EscapedStringToUri (value [i]);
  90
  91                                 this.uris = uris;
  92                         }
  93                 }
  94         }
  95
  96         public class FinishedResponse : ResponseMessage { }
  97
  98         public class SearchTermResponse : ResponseMessage {
  99
 100                 [XmlArray (ElementName="Exact")]
 101                 [XmlArrayItem (ElementName="Text", Type=typeof (string))]
 102                 public ArrayList ExactText;
 103
 104                 [XmlArray (ElementName="Stemmed")]
 105                 [XmlArrayItem (ElementName="Text", Type=typeof (string))]
 106                 public ArrayList StemmedText;
 107
 108
 109                 public SearchTermResponse ()
 110                 {
 111                         ExactText = new ArrayList ();
 112                         StemmedText = new ArrayList ();
 113                 }
 114         }
 115 }