Share via


ModelComparisonFilter Class

Represents a filter that can be defined for comparison.

Inheritance Hierarchy

System.Object
  Microsoft.Data.Schema.SchemaModel.ModelComparisonFilter

Namespace:  Microsoft.Data.Schema.SchemaModel
Assembly:  Microsoft.Data.Schema (in Microsoft.Data.Schema.dll)

Syntax

'Declaration
Public NotInheritable Class ModelComparisonFilter
public sealed class ModelComparisonFilter
public ref class ModelComparisonFilter sealed
[<Sealed>]
type ModelComparisonFilter =  class end
public final class ModelComparisonFilter

The ModelComparisonFilter type exposes the following members.

Constructors

  Name Description
Public method ModelComparisonFilter(ModelSchema) Initializes a new instance of the ModelComparisonFilter class.
Public method ModelComparisonFilter(ModelSchema, ICollection<Type>) Initializes a new instance of the ModelComparisonFilter class.
Public method ModelComparisonFilter(ModelSchema, ICollection<ModelPropertyClass>, ICollection<ModelRelationshipClass>)
Public method ModelComparisonFilter(ModelSchema, ICollection<ModelElementClass>, ICollection<ModelPropertyClass>, ICollection<ModelRelationshipClass>)
Public method ModelComparisonFilter(ModelSchema, ICollection<Type>, ICollection<ModelPropertyClass>, ICollection<ModelRelationshipClass>)

Top

Properties

  Name Description
Public property ElementTypesIncluded Gets a collection of the element types that are included in the comparison.
Public property ExcludedPropertyClasses Gets a collection of properties that are excluded during comparison.
Public property ExcludedRelationshipClasses Gets a collection of relationships that are excluded during comparison.

Top

Methods

  Name Description
Public method Equals Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public method IsElementTypeExplicitlyIncluded
Public method IsPropertyClassExcluded
Public method IsRelationshipClassExcluded
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method ToString Returns a string that represents the current object. (Inherited from Object.)

Top

Remarks

A list of properties can be defined to be excluded during comparison. Also, a list of relationships can be defined to be excluded during comparison.

Collation of the comparison used can use source collation or target collation. The user can also use elements in the source model as the base; in that case, anything in the target but not in the source will not be treated as drop.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Reference

Microsoft.Data.Schema.SchemaModel Namespace