1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164
|
//
// System.Web.UI.DataSourceSelectArguments.cs
//
// Author:
// Sanjay Gupta <gsanjay@novell.com>
//
// (C) 2004-2010 Novell, Inc (http://www.novell.com)
//
//
// Permission is hereby granted, free of charge, to any person obtaining
// a copy of this software and associated documentation files (the
// "Software"), to deal in the Software without restriction, including
// without limitation the rights to use, copy, modify, merge, publish,
// distribute, sublicense, and/or sell copies of the Software, and to
// permit persons to whom the Software is furnished to do so, subject to
// the following conditions:
//
// The above copyright notice and this permission notice shall be
// included in all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
// LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
// OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
// WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
//
using System;
namespace System.Web.UI
{
public sealed class DataSourceSelectArguments
{
string sortExpression;
int startingRowIndex;
int maxRows;
bool getTotalRowCount;
int totalRowCount = -1;
DataSourceCapabilities dsc = DataSourceCapabilities.None;
// MSDN: Gets a DataSourceSelectArguments object with the sort expression set to Empty.
public static DataSourceSelectArguments Empty {
get {
return new DataSourceSelectArguments ();
}
}
public DataSourceSelectArguments ()
{
}
public DataSourceSelectArguments (string sortExpression)
{
this.sortExpression = sortExpression;
}
public DataSourceSelectArguments (int startRowIndex, int maximumRows)
{
this.startingRowIndex = startRowIndex;
this.maxRows = maximumRows;
}
public DataSourceSelectArguments (string sortExpression, int startRowIndex, int maximumRows)
{
this.sortExpression = sortExpression;
this.startingRowIndex = startRowIndex;
this.maxRows = maximumRows;
}
public void AddSupportedCapabilities (DataSourceCapabilities capabilities)
{
this.dsc = this.dsc | capabilities;
}
// MSDN: The DataSourceSelectArguments class overrides the Object.Equals method to test
// equality using the various properties of the objects. If the MaximumRows,
// RetrieveTotalRowCount, SortExpression, StartRowIndex, and TotalRowCount properties
// are all equal in value, the Equals(Object) method returns true.
public override bool Equals (object obj)
{
DataSourceSelectArguments args = obj as DataSourceSelectArguments;
if (args == null)
return false;
return (this.SortExpression == args.SortExpression &&
this.StartRowIndex == args.StartRowIndex &&
this.MaximumRows == args.MaximumRows &&
this.RetrieveTotalRowCount == args.RetrieveTotalRowCount &&
this.TotalRowCount == args.TotalRowCount);
}
public override int GetHashCode ()
{
int hash = SortExpression != null ? SortExpression.GetHashCode() : 0;
return hash ^ StartRowIndex ^ MaximumRows ^ RetrieveTotalRowCount.GetHashCode() ^ TotalRowCount;
}
// The RaiseUnsupportedCapabilitiesError method is used by data-bound controls
// to compare additional requested capabilities represented by the properties
// of the DataSourceSelectArguments class, such as the ability to sort or page
// through a result set, with the capabilities supported by the data source view.
// The view calls its own RaiseUnsupportedCapabilityError method for each possible
// capability defined in the DataSourceCapabilities enumeration.
public void RaiseUnsupportedCapabilitiesError (DataSourceView view)
{
DataSourceCapabilities requestedCaps = RequestedCapabilities;
DataSourceCapabilities notSupportedCaps = (requestedCaps ^ dsc) & requestedCaps;
if (notSupportedCaps == DataSourceCapabilities.None)
return;
if ((notSupportedCaps & DataSourceCapabilities.RetrieveTotalRowCount) > 0)
notSupportedCaps = DataSourceCapabilities.RetrieveTotalRowCount;
else if ((notSupportedCaps & DataSourceCapabilities.Page) > 0)
notSupportedCaps = DataSourceCapabilities.Page;
view.RaiseUnsupportedCapabilityError (notSupportedCaps);
}
DataSourceCapabilities RequestedCapabilities {
get {
DataSourceCapabilities caps = DataSourceCapabilities.None;
if (!String.IsNullOrEmpty (SortExpression))
caps |= DataSourceCapabilities.Sort;
if (RetrieveTotalRowCount)
caps |= DataSourceCapabilities.RetrieveTotalRowCount;
if (StartRowIndex > 0 || MaximumRows > 0)
caps |= DataSourceCapabilities.Page;
return caps;
}
}
public int MaximumRows {
get { return this.maxRows; }
set { this.maxRows = value; }
}
public bool RetrieveTotalRowCount {
get { return this.getTotalRowCount; }
set { this.getTotalRowCount = value; }
}
public string SortExpression {
get {
if (sortExpression == null)
return String.Empty;
return this.sortExpression;
}
set { this.sortExpression = value; }
}
public int StartRowIndex {
get { return this.startingRowIndex; }
set { this.startingRowIndex = value; }
}
public int TotalRowCount {
get { return this.totalRowCount; }
set { this.totalRowCount = value; }
}
}
}
|