BeagleClient/QueryPart.cs

   1 //
   2 // QueryPart.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
  28 using System;
  29 using System.IO;
  30 using System.Collections;
  31 using System.Xml.Serialization;
  32
  33 using BU = Beagle.Util;
  34
  35 namespace Beagle {
  36
  37         public enum QueryPartLogic {
  38                 Required = 1,
  39                 Prohibited = 2
  40         }
  41
  42         [XmlInclude (typeof (QueryPart_Text)),
  43          XmlInclude (typeof (QueryPart_Property)),
  44          XmlInclude (typeof (QueryPart_DateRange)),
  45          XmlInclude (typeof (QueryPart_Human)),
  46          XmlInclude (typeof (QueryPart_Or))]
  47         abstract public class QueryPart {
  48
  49                 private QueryPartLogic logic = QueryPartLogic.Required;
  50
  51                 public QueryPart ()
  52                 { }
  53
  54                 public QueryPartLogic Logic {
  55                         get { return logic; }
  56                         set { logic = value; }
  57                 }
  58         }
  59
  60         public class QueryPart_Text : QueryPart {
  61
  62                 private string text;
  63                 private bool search_full_text = true;
  64                 private bool search_properties = true;
  65
  66                 public QueryPart_Text ()
  67                 { }
  68
  69                 public string Text {
  70                         get { return text; }
  71                         set { text = value; }
  72                 }
  73
  74                 public bool SearchFullText {
  75                         get { return search_full_text; }
  76                         set { search_full_text = value; }
  77                 }
  78
  79                 public bool SearchTextProperties {
  80                         get { return search_properties; }
  81                         set { search_properties = value; }
  82                 }
  83         }
  84
  85         // AllProperties queries are not allowed on keywords.
  86         public class QueryPart_Property : QueryPart {
  87
  88                 public const string AllProperties = "_all";
  89
  90                 private PropertyType type;
  91                 private string key;
  92                 private string value;
  93
  94                 public QueryPart_Property ()
  95                 { }
  96
  97                 public PropertyType Type {
  98                         get { return type; }
  99                         set { type = value; }
 100                 }
 101
 102                 public string Key {
 103                         get { return key; }
 104                         set { key = value; }
 105                 }
 106
 107                 public string Value {
 108                         get { return value; }
 109                         set { this.value = value; } // ugh
 110                 }
 111         }
 112
 113         public class QueryPart_DateRange : QueryPart {
 114
 115                 public const string AllPropertiesKey = "_all";
 116                 public const string TimestampKey = "Timestamp";
 117
 118                 private string key = AllPropertiesKey;
 119                 private DateTime start_date;
 120                 private DateTime end_date;
 121
 122                 public QueryPart_DateRange ()
 123                 { }
 124
 125                 public string Key {
 126                         get { return key; }
 127                         set { key = value; }
 128                 }
 129
 130                 public DateTime StartDate {
 131                         get { return start_date; }
 132                         set { start_date = value; }
 133                 }
 134
 135                 public DateTime EndDate {
 136                         get { return end_date; }
 137                         set { end_date = value; }
 138                 }
 139         }
 140
 141         public class QueryPart_Human : QueryPart {
 142
 143                 private string query_string;
 144
 145                 public QueryPart_Human ()
 146                 { }
 147
 148                 public string QueryString {
 149                         get { return query_string; }
 150                         set { query_string = value; }
 151                 }
 152         }
 153
 154         public class QueryPart_Or : QueryPart {
 155
 156                 private ArrayList sub_parts = new ArrayList ();
 157
 158                 public QueryPart_Or ()
 159                 { }
 160
 161                 [XmlArray ("SubParts")]
 162                 [XmlArrayItem (ElementName="Part", Type=typeof (QueryPart))]
 163                 public ArrayList SubParts_ShouldBePrivateSoPleaseDontUseThis {
 164                         get { return sub_parts; }
 165                 }
 166
 167                 [XmlIgnore]
 168                 public ICollection SubParts {
 169                         get { return sub_parts; }
 170                 }
 171
 172                 // FIXME: Really the only thing that is allowed as a subpart
 173                 // of an 'Or' part are required (not prohibited) text or
 174                 // property queries.  We should be clearer about the rules,
 175                 // and enforce them.
 176                 public void Add (QueryPart part)
 177                 {
 178                         sub_parts.Add (part);
 179                 }
 180         }
 181 }