Class MultipleShapeFileFeatureLayer

Namespace

ThinkGeo.Core

Assembly

ThinkGeo.Core.dll

This layer represents multiple Shape Files of the same type.

public class MultipleShapeFileFeatureLayer : FeatureLayer

Inheritance

object

Layer

FeatureLayer

MultipleShapeFileFeatureLayer

Inherited Members

FeatureLayer.OnDrawingFeatures(DrawingFeaturesEventArgs)

FeatureLayer.OnDrawingWrappingFeatures(DrawingWrappingFeaturesFeatureLayerEventArgs)

FeatureLayer.DrawCore(GeoCanvas, Collection<SimpleCandidate>)

FeatureLayer.IsDrawingNeededCore(double)

FeatureLayer.SetupTools()

FeatureLayer.SetupToolsCore()

FeatureLayer.OpenCore()

FeatureLayer.CloseCore()

FeatureLayer.GetBoundingBoxCore()

FeatureLayer.GetWrappingFeaturesForDrawing(RectangleShape, IEnumerable<string>, RectangleShape)

FeatureLayer.GetCeiling(double)

FeatureLayer.Projection

FeatureLayer.EditTools

FeatureLayer.FeatureIdsToExclude

FeatureLayer.QueryTools

FeatureLayer.MaxRecordsToDraw

FeatureLayer.FeatureSource

FeatureLayer.DrawingQuality

FeatureLayer.ZoomLevelSet

FeatureLayer.DrawingMarginInPixel

FeatureLayer.IsOpenCore

FeatureLayer.DrawingFeatures

FeatureLayer.DrawingWrappingFeatures

Layer.CloneDeep()

Layer.CloneDeepCore()

Layer.LoadLayer(Uri)

Layer.LoadLayer(Stream)

Layer.Open()

Layer.Close()

Layer.GetBoundingBox()

Layer.Draw(GeoCanvas, Collection<SimpleCandidate>)

Layer.DrawWithColorTransformation(GeoCanvas, Collection<SimpleCandidate>, RectangleShape, float, float)

Layer.DrawException(GeoCanvas, Exception)

Layer.DrawExceptionCore(GeoCanvas, Exception)

Layer.OnDrawingException(DrawingExceptionLayerEventArgs)

Layer.OnDrawnException(DrawnExceptionLayerEventArgs)

Layer.IsDrawingNeeded(double)

Layer.DrawAttributionCore(GeoCanvas, string)

Layer.OnDrawingAttribution(DrawingAttributionLayerEventArgs)

Layer.OnDrawnAttribution(DrawnAttributionLayerEventArgs)

Layer.OnDrawingProgressChanged(DrawingProgressChangedEventArgs)

Layer.RequestDrawing()

Layer.RequestDrawing(RectangleShape)

Layer.RequestDrawing(IEnumerable<RectangleShape>)

Layer.RequestDrawing(TimeSpan)

Layer.RequestDrawing(TimeSpan, RequestDrawingBufferTimeType)

Layer.RequestDrawing(RectangleShape, TimeSpan)

Layer.RequestDrawing(RectangleShape, TimeSpan, RequestDrawingBufferTimeType)

Layer.RequestDrawing(IEnumerable<RectangleShape>, TimeSpan)

Layer.RequestDrawing(IEnumerable<RectangleShape>, TimeSpan, RequestDrawingBufferTimeType)

Layer.StartRequestDrawing()

Layer.OnRequestedDrawing(RequestedDrawingLayerEventArgs)

Layer.OnRequestingDrawing(RequestingDrawingLayerEventArgs)

Layer.IsOpen

Layer.DrawingTime

Layer.Name

Layer.Attribution

Layer.IsVisible

Layer.Transparency

Layer.BlueTranslation

Layer.RedTranslation

Layer.GreenTranslation

Layer.KeyColors

Layer.IsNegative

Layer.IsGrayscale

Layer.ColorMappings

Layer.DrawingExceptionMode

Layer.ThreadSafe

Layer.Background

Layer.WrappingMode

Layer.WrappingExtent

Layer.RequestDrawingInterval

Layer.DrawingProgressChanged

Layer.DrawingException

Layer.DrawnException

Layer.DrawingAttribution

Layer.DrawnAttribution

Layer.RequestedDrawing

Layer.RequestingDrawing

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Remarks

This layer represents multiple Shape Files of the same type. Many times, you will have multiple Shape Files that represent the same type and you want to draw all of the InternalFeatures in each Shape Files the same way. For example, you may have Shape Files that contain roads separated by state (TXRoads.shp, FLRoads.shp, etc.) but want them to seem like one layer, draw the same way and let you spatially query seamlessly between them. The MultipleShapeFileFeatureLayer accomplishes that goal. When you create the layer, you enter a pattern matching criterion -- such as C:\Roads??Roads.shp" -- and the layer will automatically include all of the Shape Files that match that pattern.

In addition to this, you can also generate single large indexes that index the multiple Shape Files. This means you can have one large road index for all of the road Shape Files, instead of having individual indexes for each layer. Not only is this faster to query, but it also allows you to minimize the number of files you need.

Constructors

MultipleShapeFileFeatureLayer()

This is a constructor for the class.

public MultipleShapeFileFeatureLayer()

Remarks

If you use this constructor, then you need to set to required properties manually.

MultipleShapeFileFeatureLayer(IEnumerable<string>)

public MultipleShapeFileFeatureLayer(IEnumerable<string> shapeFiles)

Parameters

shapeFiles IEnumerable<string>

MultipleShapeFileFeatureLayer(IEnumerable<string>, IEnumerable<string>)

This is the constructor for the class.

public MultipleShapeFileFeatureLayer(IEnumerable<string> shapeFiles, IEnumerable<string> indexes)

Parameters

shapeFiles IEnumerable<string>

This parameter represents the shape files to construct the MultipleShapeFileFeatureLayer. The format of it should be new string[] { "C:\CA_counties.shp", "C:\AZ_counties.shp" }.

indexes IEnumerable<string>

This parameter represents the shape files to construct the ShapeFileFeatureLayer. The format of it should be new string[] { "C:\CA_counties.midx", "C:\AZ_counties.midx" }.

Remarks

This is the constructor for this class. You can pass in a group of shapes and its corresponding indexs like string[] shapeFiles = new string[] { "C:\CA_counties.shp", "C:\AZ_counties.shp" }; string[] indexFiles = new string[] { "C:\CA_counties.midx", "C:\AZ_counties.midx" }; In this way, the MultipleShapeFileFeatureLayer will construct from the passing 2 shapes.

MultipleShapeFileFeatureLayer(string)

This is a constructor for the class.

public MultipleShapeFileFeatureLayer(string multipleShapeFilePattern)

Parameters

multipleShapeFilePattern string

This parameter is the matching pattern to determine which Shape Files are loaded.

Remarks

This constructor allows you to pass in the path and filename pattern to match.

MultipleShapeFileFeatureLayer(string, string)

This is a constructor for the class.

public MultipleShapeFileFeatureLayer(string multipleShapeFilePattern, string indexFilePattern)

Parameters

multipleShapeFilePattern string

This parameter is the path and filename matching pattern that determines which Shape Files are loaded.

indexFilePattern string

This parameter is the path and filename matching pattern that determines which index files are loaded.

Remarks

With this constructor you can specify differently-named indexes for the layer. If you have one large index, specify its path and filename here. If you have smaller single indexes, use wildcards to specify a pattern to match instead.

For example, if you had 50 road Shape Files named C:\Roads??Roads.shp (where ?? is the two-character state abbreviation), but only one large index, then you would specify a string like "C:\Roads\Roads.idx". If you instead had 50 individual indexes whose names matched the Shape Files, then you would use "C:\Roads??Roads.idx".

Properties

Encoding

This property gets and sets the encoding information for the DBF.

public Encoding Encoding { get; set; }

Property Value

Encoding

HasBoundingBox

This property checks to see if a Layer has a BoundingBox or not. If it has no BoundingBox, it will throw an exception when you call the GetBoundingBox() and GetFullExtent() APIs. In MultipleShapeFeatureLayer, we override this API and mark it as true.

public override bool HasBoundingBox { get; }

Property Value

bool

Remarks

The default implementation in the base class returns false.

IndexFilePattern

This property gets and sets the index file pattern that makes up this layer.

public string IndexFilePattern { get; set; }

Property Value

string

This property gets the index file pattern that makes up this layer.

Remarks

None

Indexes

public Collection<string> Indexes { get; }

Property Value

Collection<string>

MultipleShapeFilePattern

This property gets and sets the Shape File pattern that makes up this layer.

public string MultipleShapeFilePattern { get; set; }

Property Value

string

This property gets the Shape File pattern that makes up this layer.

Remarks

None

ShapeFiles

public Collection<string> ShapeFiles { get; }

Property Value

Collection<string>

Methods

BuildIndex(string)

This method builds a spatial index for the layer.

public static void BuildIndex(string multipleShapeFilePattern)

Parameters

multipleShapeFilePattern string

This parameter is the matching pattern that defines which Shape Files to include.

Remarks

This overload allows you to pass in a Shape File path and filename pattern. It will generate indexes for each Shape File it finds, matching the index file names to the Shape File names.

BuildIndex(string, string)

This method builds a spatial index for the layer.

public static void BuildIndex(string multipleShapeFilePattern, string indexFilePattern)

Parameters

multipleShapeFilePattern string

This parameter is the matching pattern that defines which Shape Files to include.

indexFilePattern string

This parameter is the matching pattern of how to name the index (or indexes).

Remarks

This overload allows you to pass in a path and filename pattern for Shapes Files and index files. If you use a pattern for the index file name, it will generate indexes for each Shape File it finds, matching the index file names to the Shape File names. Alternatively, if you use a concrete index file name, it will generate one large index instead.

If you enter an indexFilePattern like "C:\Roads\??Roads.idx", it will build individual indexes for each Shape File and name them according to the pattern. If you enter an absolute name, like "C:\Roads\Roads.idx", it will create one large index for all of the Shape Files.

BuildIndex(string, string, string, string)

This method builds a spatial index for the layer.

public static void BuildIndex(string multipleShapeFilePattern, string columnName, string regularExpression, string indexFilename)

Parameters

multipleShapeFilePattern string

This parameter is the matching pattern that defines which Shape Files to include.

columnName string

This parameter is the column name you want to apply the regular expression towards.

regularExpression string

This parameter is the regular expression you want to use to select certain features for your index.

indexFilename string

This parameter is the name of the index file you want to generate for the features that match the regular expression.

Remarks

This index-building method is very useful when you have a large number of Shape Files that contain only certain records you want. For example, you may have an individual Shape File for the states of Texas and Florida that contains only those states' roads. They are named TXRoads.shp for Texas and FLRoads.shp for Florida. Inside of these Shape Files there is a column that determines whether the roads are normal streets or highways. You, of course, want to draw highways differently. You could use a ValueStyle, but that would be slow because you'd have to look though all of the records at runtime to determine which are the highways. A better solution is to build a custom index that only has highways in it. In this way, you generate the index once and then runtime performance is fast.

In our scenario, we would create an index to include all of the road Shape Files by using the pattern "*Roads.shp". This will make sure we get both the Texas and Florida roads. Next, we specify the RoadType column as the column parameter. Then we provide a regular expression match that picks out all of the highways, and name the resulting index "Highways.idx". We can then build another, separate index just for the normal streets. In this way, we can quickly sort the roads from the highways -- and we didn't have to cut up our Shape Files to do it.

BuildIndex(string, string, string, string, BuildIndexMode)

This method builds a spatial index for the layer.

public static void BuildIndex(string multipleShapeFilePattern, string columnName, string regularExpression, string indexFilename, BuildIndexMode buildIndexMode)

Parameters

multipleShapeFilePattern string

This parameter is the matching pattern that defines which Shape Files to include.

columnName string

This parameter is the column name you want to apply the regular expression towards.

regularExpression string

This parameter is the regular expression you want to use to select certain features for your index.

indexFilename string

This parameter is the name of the index file you want to generate for the features that match the regular expression.

buildIndexMode BuildIndexMode

This parameter determines whether the index file will be rebuilt if it already exists.

Remarks

This index-building method is very useful when you have a large number of Shape Files that contain only certain records you want. For example, you may have an individual Shape File for the states of Texas and Florida that contains only those states' roads. They are named TXRoads.shp for Texas and FLRoads.shp for Florida. Inside of these Shape Files there is a column that determines whether the roads are normal streets or highways. You, of course, want to draw highways differently. You could use a ValueStyle, but that would be slow because you'd have to look though all of the records at runtime to determine which are the highways. A better solution is to build a custom index that only has highways in it. In this way, you generate the index once and then runtime performance is fast.

In our scenario, we would create an index to include all of the road Shape Files by using the pattern "*Roads.shp". This will make sure we get both the Texas and Florida roads. Next, we specify the RoadType column as the column parameter. Then we provide a regular expression match that picks out all of the highways, and name the resulting index "Highways.idx". We can then build another, separate index just for the normal streets. In this way, we can quickly sort the roads from the highways -- and we didn't have to cut up our Shape Files to do it.

BuildIndex(string, string, BuildIndexMode)

This method builds a spatial index for the layer.

public static void BuildIndex(string multipleShapeFilePattern, string indexFilePattern, BuildIndexMode buildIndexMode)

Parameters

multipleShapeFilePattern string

This parameter is the matching pattern that defines which Shape Files to include.

indexFilePattern string

This parameter is the matching pattern of how to name the index (or indexes).

buildIndexMode BuildIndexMode

This parameter determines whether an index file will be rebuilt if it already exists.

Remarks

This overload allows you to pass in a path and filename pattern for Shapes Files and index files. If you use a pattern for the index file name, it will generate indexes for each Shape File it finds, matching the index file names to the Shape File names. Alternatively, if you use a concrete index file name, it will generate one large index instead.

If you enter an indexFilePattern like "C:\Roads\??Roads.idx", it will build individual indexes for each Shape File and name them according to the pattern. If you enter an absolute name, like "C:\Roads\Roads.idx", it will create one large index for all of the Shape Files.

BuildIndex(string, BuildIndexMode)

This method builds a spatial index for the layer.

public static void BuildIndex(string multipleShapeFilePattern, BuildIndexMode buildIndexMode)

Parameters

multipleShapeFilePattern string

This parameter is the matching pattern that defines which Shape Files to include.

buildIndexMode BuildIndexMode

This parameter determines whether an index file will be rebuilt if it already exists.

Remarks

This overload allows you to pass in a Shape File path and filename pattern and determines if we re-build index files that already exist. It will generate indexes for each Shape File it finds, matching the index file names to the Shape File names.

BuildIndex(string[], string[])

This method builds a spatial index for the layer.

public static void BuildIndex(string[] multipleShapeFiles, string[] multipleShapeFileIndexes)

Parameters

multipleShapeFiles string[]

This parameter represents the shape files to construct the MultipleShapeFileFeatureLayer. The format of it should be new string[] { "C:\CA_counties.shp", "C:\AZ_counties.shp" }.

multipleShapeFileIndexes string[]

This parameter represents the shape files to construct the ShapeFileFeatureLayer. The format of it should be new string[] { "C:\CA_counties.midx", "C:\AZ_counties.midx" }.

BuildIndex(string[], string[], BuildIndexMode)

This method builds a spatial index for the layer.

public static void BuildIndex(string[] multipleShapeFiles, string[] multipleShapeFileIndexes, BuildIndexMode buildIndexMode)

Parameters

multipleShapeFiles string[]

This parameter represents the shape files to construct the MultipleShapeFileFeatureLayer. The format of it should be new string[] { "C:\CA_counties.shp", "C:\AZ_counties.shp" }.

multipleShapeFileIndexes string[]

This parameter represents the shape files to construct the ShapeFileFeatureLayer. The format of it should be new string[] { "C:\CA_counties.midx", "C:\AZ_counties.midx" }.

buildIndexMode BuildIndexMode

GetIndexPathFilenames()

This method returns a collection of the index files and their paths that make up the layer.

public Collection<string> GetIndexPathFilenames()

Returns

Collection<string>

This method returns a collection of the index files and their paths that make up the layer.

Remarks

None

GetShapePathFilenames()

This method returns a collection of the Shape Files and their paths that make up the layer.

public Collection<string> GetShapePathFilenames()

Returns

Collection<string>

This method returns a collection of the Shape Files and their paths that make up the layer.

Remarks

None