• Article

MiningModel Class

Defines the details of an individual mining model. This class cannot be inherited.

Inheritance Hierarchy

System.Object
  System.MarshalByRefObject
    System.ComponentModel.Component
      Microsoft.AnalysisServices.ModelComponent
        Microsoft.AnalysisServices.NamedComponent
          Microsoft.AnalysisServices.MajorObject
            Microsoft.AnalysisServices.ProcessableMajorObject
              Microsoft.AnalysisServices.MiningModel

Namespace:  Microsoft.AnalysisServices
Assembly:  Microsoft.AnalysisServices (in Microsoft.AnalysisServices.dll)

Syntax

'Declaration
<GuidAttribute("AB0A80A1-D3FB-45f0-8D3A-37455E7BF4DB")> _
Public NotInheritable Class MiningModel _
    Inherits ProcessableMajorObject _
    Implements IMajorObject, INamedComponent, IModelComponent, IComponent,  _
    IDisposable, ICloneable
'Usage
Dim instance As MiningModel

[GuidAttribute("AB0A80A1-D3FB-45f0-8D3A-37455E7BF4DB")]
public sealed class MiningModel : ProcessableMajorObject, 
    IMajorObject, INamedComponent, IModelComponent, IComponent, IDisposable, 
    ICloneable

[GuidAttribute(L"AB0A80A1-D3FB-45f0-8D3A-37455E7BF4DB")]
public ref class MiningModel sealed : public ProcessableMajorObject, 
    IMajorObject, INamedComponent, IModelComponent, IComponent, IDisposable, 
    ICloneable

[<SealedAttribute>]
[<GuidAttribute("AB0A80A1-D3FB-45f0-8D3A-37455E7BF4DB")>]
type MiningModel =  
    class
        inherit ProcessableMajorObject
        interface IMajorObject
        interface INamedComponent
        interface IModelComponent
        interface IComponent
        interface IDisposable
        interface ICloneable
    end

public final class MiningModel extends ProcessableMajorObject implements IMajorObject, INamedComponent, IModelComponent, IComponent, IDisposable, ICloneable

The MiningModel type exposes the following members.

Constructors

  Name Description
Public method MiningModel() Initializes a new instance of MiningModel using the default values.
Public method MiningModel(String) Initializes a new instance of MiningModel using a name.
Public method MiningModel(String, String) Initializes a new instance of MiningModel class using a name and an identifier.

Top

Properties

  Name Description
Public property Algorithm Gets or sets the algorithm associated with the MiningModel, which can be supplied by Microsoft or can be your own custom algorithm.
Public property AlgorithmParameters Gets the applicable set of AlgorithmParameters, independent of assigned algorithm.
Public property AllowDrillThrough Gets or sets a value determining whether drillthrough is permitted on the mining model.
Public property Annotations Gets the collection object of all annotations to current object. (Inherited from MajorObject.)
Protected property CanRaiseEvents (Inherited from Component.)
Public property Collation Gets or sets the collation used by the MiningModel object.
Public property Columns Gets the collection of columns associated with the MiningModel object.
Public property Container (Inherited from Component.)
Public property CreatedTimestamp Gets or sets the date and time of the creation of the object. (Inherited from MajorObject.)
Public property Description Gets or sets a description string of current object. (Inherited from MajorObject.)
Protected property DesignMode (Inherited from Component.)
Protected property Events (Inherited from Component.)
Public property Filter Gets or sets the filter expression associated with the mining model.
Public property FoldingParameters
Protected property FriendlyName (Inherited from NamedComponent.)
Public property ID (Inherited from NamedComponent.)
Public property IsLoaded Infrastructure. (Inherited from MajorObject.)
Protected property KeyForCollection (Inherited from NamedComponent.)
Public property Language Gets or sets the language to use by default.
Public property LastProcessed (Inherited from ProcessableMajorObject.)
Public property LastSchemaUpdate Gets or sets the date and time when current object schema was last updated. (Inherited from MajorObject.)
Public property MiningModelPermissions Contains the collection of permissions for a MiningModel object.
Public property Name (Inherited from NamedComponent.)
Public property OwningCollection Gets or sets the collection that contains the ModelComponent. (Inherited from ModelComponent.)
Public property Parent Gets the MiningStructure to which this mining model belongs.
Public property ParentDatabase Gets the Database object that is the parent of the MiningModel object.
Public property ParentServer Gets the Server object that is the parent of the MiningModel object.
Public property Site (Inherited from NamedComponent.)
Public property SiteID (Inherited from NamedComponent.)
Public property State (Inherited from ProcessableMajorObject.)
Public property Translations Contains the collection of Translation objects associated with the MiningModel object.

Top

Methods

  Name Description
Protected method AddToContainer Infrastructure. (Inherited from ModelComponent.)
Protected method AfterInsert Infrastructure. (Inherited from ModelComponent.)
Protected method AfterMove Infrastructure. (Inherited from ModelComponent.)
Protected method AfterRemove Infrastructure. (Inherited from ModelComponent.)
Protected method BeforeRemove Infrastructure. (Inherited from ModelComponent.)
Public method CanProcess (Overrides ProcessableMajorObject.CanProcess(ProcessType).)
Public method Clone() Creates a new full copy of the MiningModel object.
Protected method Clone(Boolean) Infrastructure. (Inherited from MajorObject.)
Public method CopyTo(MiningModel) Copies a MiningModel to the specified object.
Protected method CopyTo(ModelComponent) Infrastructure. (Inherited from ModelComponent.)
Protected method CopyTo(NamedComponent) (Inherited from NamedComponent.)
Protected method CopyTo(MajorObject, Boolean) (Inherited from ProcessableMajorObject.)
Public method CreateObjRef (Inherited from MarshalByRefObject.)
Public method Dispose() (Inherited from Component.)
Protected method Dispose(Boolean) (Inherited from Component.)
Public method Drop() Removes current object and updates server. (Inherited from MajorObject.)
Public method Drop(DropOptions) Removes current object and updates server using specified options. (Inherited from MajorObject.)
Public method Drop(DropOptions, XmlaWarningCollection) Removes current object and updates server using specified options. Warnings resulting from drop operation are returned on the specified warnings object. (Inherited from MajorObject.)
Public method Drop(DropOptions, XmlaWarningCollection, ImpactDetailCollection) Removes current object and updates server using specified options. Warnings resulting from drop operation are returned on the specified warnings variable and results for affected objects in operation are returned on specified impactResult variable. (Inherited from MajorObject.)
Public method Drop(DropOptions, XmlaWarningCollection, ImpactDetailCollection, Boolean) Removes current object and updates server using specified options. Warnings resulting from drop operation are returned on the specified warnings variable and results for affected objects in operation are returned on specified impactResult variable. (Inherited from MajorObject.)
Public method Equals (Inherited from Object.)
Protected method Finalize (Inherited from Component.)
Public method FindRelatedColumn Returns the specified column from the mining structure that is associated with the model.
Protected method GetCreateReferences Infrastructure. (Inherited from MajorObject.)
Public method GetDependents Infrastructure. (Inherited from MajorObject.)
Protected method GetDropDependents Infrastructure. (Inherited from MajorObject.)
Public method GetHashCode (Inherited from Object.)
Public method GetLifetimeService (Inherited from MarshalByRefObject.)
Public method GetReferences Infrastructure. (Inherited from MajorObject.)
Protected method GetService (Inherited from Component.)
Public method GetType (Inherited from Object.)
Public method GetUpdateOverwrites Infrastructure. (Inherited from MajorObject.)
Public method InitializeLifetimeService (Inherited from MarshalByRefObject.)
Protected method MemberwiseClone() (Inherited from Object.)
Protected method MemberwiseClone(Boolean) (Inherited from MarshalByRefObject.)
Public method Process() (Inherited from ProcessableMajorObject.)
Public method Process(ProcessType) (Inherited from ProcessableMajorObject.)
Public method Process(ProcessType, Binding) (Inherited from ProcessableMajorObject.)
Public method Process(ProcessType, ErrorConfiguration) (Inherited from ProcessableMajorObject.)
Public method Process(ProcessType, WriteBackTableCreation) (Inherited from ProcessableMajorObject.)
Public method Process(ProcessType, ErrorConfiguration, XmlaWarningCollection) (Inherited from ProcessableMajorObject.)
Public method Process(ProcessType, ErrorConfiguration, XmlaWarningCollection, ImpactDetailCollection) (Inherited from ProcessableMajorObject.)
Public method Process(ProcessType, ErrorConfiguration, XmlaWarningCollection, ImpactDetailCollection, Boolean) (Inherited from ProcessableMajorObject.)
Public method Refresh() Updates current object from server definitions. (Inherited from MajorObject.)
Public method Refresh(Boolean) Updates current object from server definitions and loaded dependent objects if specified. (Inherited from MajorObject.)
Public method Refresh(Boolean, RefreshType) Updates current object from server definitions and loaded dependent objects if specified. (Inherited from MajorObject.)
Protected method RemoveFromContainer Infrastructure. (Inherited from ModelComponent.)
Protected method Reset (Inherited from NamedComponent.)
Public method Submit() Infrastructure. (Inherited from ModelComponent.)
Public method Submit(Boolean) Infrastructure. (Inherited from ModelComponent.)
Public method ToString (Inherited from NamedComponent.)
Public method Update() Updates server definition of current object to actual values using the default values to update dependent objects. (Inherited from MajorObject.)
Public method Update(UpdateOptions) Updates server definition of current object to actual values using the specified options to update dependent objects. (Inherited from MajorObject.)
Public method Update(UpdateOptions, UpdateMode) Updates server definition of current object to actual values using the specified options to update dependent objects. (Inherited from MajorObject.)
Public method Update(UpdateOptions, UpdateMode, XmlaWarningCollection) Updates server definition of current object to actual values using the specified options to update dependent objects and reports any warnings from operation. (Inherited from MajorObject.)
Public method Update(UpdateOptions, UpdateMode, XmlaWarningCollection, ImpactDetailCollection) Updates server definition of current object to actual values using specified options to update dependent objects, reports any warnings from operation, and returns affected objects from operation. (Inherited from MajorObject.)
Public method Update(UpdateOptions, UpdateMode, XmlaWarningCollection, ImpactDetailCollection, Boolean) Updates server definition of current object to actual values using specified options to update dependent objects, reports any warnings from operation, and returns affected objects from operation. If analyzeImpactOnly is true, an impact analysis operation is performed with no update operation. (Inherited from MajorObject.)
Public method Validate(ValidationErrorCollection) Validates the element to which it is appended; returns any errors encountered in a collection. (Inherited from ModelComponent.)
Public method Validate(ValidationResultCollection) (Inherited from MajorObject.)
Public method Validate(ValidationErrorCollection, Boolean) Validates the element to which it is appended; returns any errors encountered in a collection. Also contains a parameter to enable return of detailed errors. (Inherited from ModelComponent.)
Public method Validate(ValidationResultCollection, ValidationOptions) (Inherited from MajorObject.)
Public method Validate(ValidationErrorCollection, Boolean, ServerEdition) (Overrides NamedComponent.Validate(ValidationErrorCollection, Boolean, ServerEdition).)
Public method Validate(ValidationResultCollection, ValidationOptions, ServerEdition) (Inherited from MajorObject.)

Top

Events

  Name Description
Public event Disposed (Inherited from Component.)

Top

Remarks

Many mining models can share the same structure, but changing the algorithm, or changing the columns whose values are to be predicted, does change the structure. The set of columns in the MiningModel must be a subset of the columns of the owning structure and share the same nested table structure. You can exclude columns either by omitting them or by setting the usage value to none.

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.