C#/.NET Little Wonders: Use Cast() and OfType() to Change Sequence Type(zz)
Once again, in this series of posts I look at the parts of the .NET Framework that may seem trivial, but can help improve your code by making it easier to write and maintain. The index of all my past little wonders posts can be found here.
We’ve seen how the Select() extension method lets you project a sequence from one type to a new type which is handy for getting just parts of items, or building new items. But what happens when the items in the sequence are already the type you want, but the sequence itself is typed to an interface or super-type instead of the sub-type you need?
For example, you may have a sequence of Rectangle stored in an IEnumerable<Shape> and want to consider it an IEnumerable<Rectangle> sequence instead.
Today we’ll look at two handy extension methods, Cast<TResult>() and OfType<TResult>() which help you with this task.
Cast<TResult>() – Attempt to cast all items to type TResult
So, the first thing we can do would be to attempt to create a sequence of TResult from every item in the source sequence. Typically we’d do this if we had an IEnumerable<T>where we knew that every item was actually a TResult where TResult inherits/implements T.
For example, assume the typical Shape example classes:
1: // abstract base class
2: public abstract class Shape { }
3:
4: // a basic rectangle
5: public class Rectangle : Shape
6: {
7: public int Widtgh { get; set; }
8: public int Height { get; set; }
9: }
And let’s assume we have a sequence of Shape where every Shape is a Rectangle…
1: var shapes = new List<Shape>
2: {
3: new Rectangle { Width = 3, Height = 5 },
4: new Rectangle { Width = 10, Height = 13 },
5: // ...
6: };
To get the sequence of Shape as a sequence of Rectangle, of course, we could use a Select() clause, such as:
1: // select each Shape, cast it to Rectangle
2: var rectangles = shapes
3: .Select(s => (Rectangle)s)
4: .ToList();
But that’s a bit verbose, and fortunately there is already a facility built in and ready to use in the form of the Cast<TResult>() extension method:
1: // cast each item to Rectangle and store in a List<Rectangle>
2: var rectangles = shapes
3: .Cast<Rectangle>()
4: .ToList();
However, we should note that if anything in the list cannot be cast to a Rectangle, you will get an InvalidCastException thrown at runtime. Thus, if our Shape sequence had a Circle in it, the call to Cast<Rectangle>() would have failed. As such, you should only do this when you are reasonably sure of what the sequence actually contains (or are willing to handle an exception if you’re wrong).
Another handy use of Cast<TResult>() is using it to convert an IEnumerable to an IEnumerable<T>. If you look at the signature, you’ll see that the Cast<TResult>() extension method actually extends the older, object-based IEnumerable interface instead of the newer, generic IEnumerable<T>.
This is your gateway method for being able to use LINQ on older, non-generic sequences. For example, consider the following:
1: // the older, non-generic collections are sequence of object
2: var shapes = new ArrayList
3: {
4: new Rectangle { Width = 3, Height = 13 },
5: new Rectangle { Width = 10, Height = 20 },
6: // ...
7: };
Since this is an older, object based collection, we cannot use the LINQ extension methods on it directly. For example, if I wanted to query the Shape sequence for only those Rectangles whose Width is > 5, I can’t do this:
1: // compiler error, Where() operates on IEnumerable<T>, not IEnumerable
2: var bigRectangles = shapes.Where(r => r.Width > 5);
However, I can use Cast<Rectangle>() to treat my ArrayList as an IEnumerable<Rectangle> and then do the query!
1: // ah, that’s better!
2: var bigRectangles = shapes.Cast().Where(r => r.Width > 5);
Or, if you prefer, in LINQ query expression syntax:
1: var bigRectangles = from s in shapes.Cast>()
2: where s.Width > 5
3: select s;
One quick warning: Cast<TResult>() only attempts to cast, it won’t perform a cast conversion. That is, consider this:
1: var intList = new List<int> { 1, 1, 2, 3, 5, 8, 13, 21, 34, 55, 89 };
2:
3: // casting ints to longs, this should work, right?
4: var asLong = intList.Cast<long>().ToList();
Will the code above work?
No, you’ll get a InvalidCastException. Remember that Cast<TResult>() is an extension of IEnumerable, thus it is a sequence of object, which means that it will box every int as an object as it enumerates over it, and there is no cast conversion from object to long, and thus the cast fails.
In other words, a cast from int to long will succeed because there is a conversion from int to long. But a cast from int to object to long will not, because you can only unbox an item by casting it to its exact type.
For more information on why cast-converting boxed values doesn’t work, see this post on The Dangers of Casting Boxed Values (here).
OfType<TResult>() – Filter sequence to only items of type TResult
So, we’ve seen how we can use Cast<TResult>() to change the type of our sequence, when we expect all the items of the sequence to be of a specific type. But what do we do when a sequence contains many different types, and we are only concerned with a subset of a given type?
For example, what if a sequence of Shape contains Rectangle and Circle instances, and we just want to select all of the Rectangle instances? Well, let’s say we had this sequence of Shape:
1: var shapes = new List<Shape>
2: {
3: new Rectangle { Width = 3, Height = 5 },
4: new Rectangle { Width = 10, Height = 13 },
5: new Circle { Radius = 10 },
6: new Square { Side = 13 },
7: // ...
8: };
Well, we could get the rectangles using Select(), like:
1: var onlyRectangles = shapes.Where(s => s is Rectangle).ToList();
But fortunately, an easier way has already been written for us in the form of the OfType<T>() extension method:
1: // returns only a sequence of the shapes that are Rectangles
2: var onlyRectangles = shapes.OfType<Rectangle>().ToList();
Now we have a sequence of only the Rectangles in the original sequence, we can also use this to chain other queries that depend on Rectangles, such as:
1: // select only Rectangles, then filter to only those more than
2: // 5 units wide...
3: var onlyBigRectangles = shapes.OfType<Rectangle>()
4: .Where(r => r.Width > 5)
5: .ToList();
The OfType<Rectangle>() will filter the sequence to only the items that are of type Rectangle (or a subclass of it), and that results in an IEnumerable<Rectangle>, we can then apply the other LINQ extension methods to query that list further.
Just as Cast<TResult>() is an extension method on IEnumerable (and not IEnumerable<T>), the same is true for OfType<T>(). This means that you can use OfType<TResult>() on object-based collections as well.
For example, given an ArrayList containing Shapes, as below:
1: // object-based collections are a sequence of object
2: var shapes = new ArrayList
3: {
4: new Rectangle { Width = 3, Height = 5 },
5: new Rectangle { Width = 10, Height = 13 },
6: new Circle { Radius = 10 },
7: new Square { Side = 13 },
8: // ...
9: };
We can use OfType<Rectangle> to filter the sequence to only Rectangle items (and subclasses), and then chain other LINQ expressions, since we will then be of type IEnumerable<Rectangle>:
1: // OfType() converts the sequence of object to a new sequence
2: // containing only Rectangle or sub-types of Rectangle.
3: var onlyBigRectangles = shapes.OfType<Rectangle>()
4: .Where(r => r.Width > 5)
5: .ToList();
Summary
So now we’ve seen two different ways to get a sequence of a superclass or interface down to a more specific sequence of a subclass or implementation. The Cast<TResult>() method casts every item in the source sequence to type TResult, and the OfType<TResult>() method selects only those items in the source sequence that are of type TResult.
You can use these to downcast sequences, or adapt older types and sequences that only implement IEnumerable (such as DataTable, ArrayList, etc.).
C#/.NET Little Wonders: Use Cast() and OfType() to Change Sequence Type(zz)的更多相关文章
- EntityFramework异常The specified cast from a materialized 'System.Double' type to the 'System.Single' type is not valid.
实体类: public class ReportEntity { public string FactorName { get; set; } public double MaxVal { get; ...
- entity framework异常 The specified cast from a materialized 'System.Int32' type to the 'System.String' type is not valid
ROW_NUMBER() OVER (ORDER BY (select Null)) AS Id entity framework 查询中有这句会有异常
- .NET LINQ 转换数据类型
转换数据类型 转换方法更改输入对象的类型. LINQ 查询中的转换运算可用于各种应用程序.下面是一些示例: Enumerable.AsEnumerable<TSource&g ...
- 第5章 LINQ
5.4 LINQ查询运算符 using System; using System.Collections.Generic; using System.Linq; using System.Text; ...
- C#基础之IEnumerable
1.IEnumerable的作用 在使用Linq查询数据时经常以IEnumerable<T>来作为数据查询返回对象,在使用foreach进行遍历时需要该对象实现IEnumerable接口, ...
- csharp: get Web.Services WebMethod
using System; using System.Collections.Generic; using System.Linq; using System.Web; using System.We ...
- 从扩展方法到匿名方法再到LINQ
1.首先我们应该知道什么是扩展方法: 扩展方法使您能够向现有类型“添加”方法,而无需创建新的派生类型.重新编译或以其他方式修改原始类型. 扩展方法是一种特殊的静态方法,但可以像扩展类型上的实例方法一样 ...
- C# LiNq的语法以及常用的扩展方法
首先先来扯一下,这篇博文是我第一次写的,主要是我的一些摘录,希望对大家有所帮助. Linq的基础 •LINQ(读音link):Linq To SQL(过时).Linq To Object.Linq T ...
- IEnumerable
C#基础之IEnumerable 1.IEnumerable的作用 在使用Linq查询数据时经常以IEnumerable<T>来作为数据查询返回对象,在使用foreach进行遍历时需要该对 ...
随机推荐
- 创建DLL、Lib以及使用DLL、Lib
1.要在生成DLL文件的同时生成Lib文件,函数声明时前面要加__declspec(dllexport). 可在头文件中如下定义: #ifndef __MYDLL_H#define __MYDLL_H ...
- Codeforces Round #371 (Div. 2)(set\unique)
B. Filya and Homework time limit per test 1 second memory limit per test 256 megabytes input standar ...
- logstash之multiline插件,匹配多行日志
在外理日志时,除了访问日志外,还要处理运行时日志,该日志大都用程序写的,比如log4j.运行时日志跟访问日志最大的不同是,运行时日志是多行,也就是说,连续的多行才能表达一个意思. 在filter中,加 ...
- jQueryEasyUi验证
多重验证: { field : 'startPort', title : "起始端口", editor: "text", width : 50, edi ...
- Android ANR分析(2)
转自:http://blog.csdn.net/ruingman/article/details/53118202 定义 主线程在特定的时间内没有做完特定的事情 常见的场景 A.input事件超过 ...
- css控制文字显示长度,超过用省略号替代
.line_text { width:200px; white-space:nowrap; overflow:hidden; text-overflow:ellipsis; } <span cl ...
- 【翻译二十】-java线程池
Thread Pools Most of the executor implementations in java.util.concurrent use thread pools, which co ...
- SQLAlchemy ORM高级查询之过滤,排序
order_by,filter的语法. 用久了才会熟悉. Session = sessionmaker(bind=engine) session = Session() print(session.q ...
- Sql Server 索引之唯一索引和筛选索引
唯一索引(UNIQUE INDEX) 当主键创建时如果不设置为聚集索引,那么就一定是唯一的非聚集索引.实际上,唯一索引,故名思议就是它要求该列上的值是唯一的.唯一索引能够保证索引键中不包含重复的值, ...
- 基于PHP+Ajax实现表单验证的详解
一,利用键盘响应,在不刷新本页面的情况下验证表单输入是否合法 用户通过onkeydown和onkeyup事件来触发响应事件.使用方法和onclick事件类似.onkeydown表示当键盘上的键被按下时 ...