Article
05/23/2011

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
	MiningModel()	Initializes a new instance of MiningModel using the default values.
	MiningModel(String)	Initializes a new instance of MiningModel using a name.
	MiningModel(String, String)	Initializes a new instance of MiningModel class using a name and an identifier.

Top

Properties

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

Top

Methods

	Name	Description
	AddToContainer	Infrastructure. (Inherited from ModelComponent.)
	AfterInsert	Infrastructure. (Inherited from ModelComponent.)
	AfterMove	Infrastructure. (Inherited from ModelComponent.)
	AfterRemove	Infrastructure. (Inherited from ModelComponent.)
	BeforeRemove	Infrastructure. (Inherited from ModelComponent.)
	CanProcess	(Overrides ProcessableMajorObject.CanProcess(ProcessType).)
	Clone()	Creates a new full copy of the MiningModel object.
	Clone(Boolean)	Infrastructure. (Inherited from MajorObject.)
	CopyTo(MiningModel)	Copies a MiningModel to the specified object.
	CopyTo(ModelComponent)	Infrastructure. (Inherited from ModelComponent.)
	CopyTo(NamedComponent)	(Inherited from NamedComponent.)
	CopyTo(MajorObject, Boolean)	(Inherited from ProcessableMajorObject.)
	CreateObjRef	(Inherited from MarshalByRefObject.)
	Dispose()	(Inherited from Component.)
	Dispose(Boolean)	(Inherited from Component.)
	Drop()	Removes current object and updates server. (Inherited from MajorObject.)
	Drop(DropOptions)	Removes current object and updates server using specified options. (Inherited from MajorObject.)
	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.)
	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.)
	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.)
	Equals	(Inherited from Object.)
	Finalize	(Inherited from Component.)
	FindRelatedColumn	Returns the specified column from the mining structure that is associated with the model.
	GetCreateReferences	Infrastructure. (Inherited from MajorObject.)
	GetDependents	Infrastructure. (Inherited from MajorObject.)
	GetDropDependents	Infrastructure. (Inherited from MajorObject.)
	GetHashCode	(Inherited from Object.)
	GetLifetimeService	(Inherited from MarshalByRefObject.)
	GetReferences	Infrastructure. (Inherited from MajorObject.)
	GetService	(Inherited from Component.)
	GetType	(Inherited from Object.)
	GetUpdateOverwrites	Infrastructure. (Inherited from MajorObject.)
	InitializeLifetimeService	(Inherited from MarshalByRefObject.)
	MemberwiseClone()	(Inherited from Object.)
	MemberwiseClone(Boolean)	(Inherited from MarshalByRefObject.)
	Process()	(Inherited from ProcessableMajorObject.)
	Process(ProcessType)	(Inherited from ProcessableMajorObject.)
	Process(ProcessType, Binding)	(Inherited from ProcessableMajorObject.)
	Process(ProcessType, ErrorConfiguration)	(Inherited from ProcessableMajorObject.)
	Process(ProcessType, WriteBackTableCreation)	(Inherited from ProcessableMajorObject.)
	Process(ProcessType, ErrorConfiguration, XmlaWarningCollection)	(Inherited from ProcessableMajorObject.)
	Process(ProcessType, ErrorConfiguration, XmlaWarningCollection, ImpactDetailCollection)	(Inherited from ProcessableMajorObject.)
	Process(ProcessType, ErrorConfiguration, XmlaWarningCollection, ImpactDetailCollection, Boolean)	(Inherited from ProcessableMajorObject.)
	Refresh()	Updates current object from server definitions. (Inherited from MajorObject.)
	Refresh(Boolean)	Updates current object from server definitions and loaded dependent objects if specified. (Inherited from MajorObject.)
	Refresh(Boolean, RefreshType)	Updates current object from server definitions and loaded dependent objects if specified. (Inherited from MajorObject.)
	RemoveFromContainer	Infrastructure. (Inherited from ModelComponent.)
	Reset	(Inherited from NamedComponent.)
	Submit()	Infrastructure. (Inherited from ModelComponent.)
	Submit(Boolean)	Infrastructure. (Inherited from ModelComponent.)
	ToString	(Inherited from NamedComponent.)
	Update()	Updates server definition of current object to actual values using the default values to update dependent objects. (Inherited from MajorObject.)
	Update(UpdateOptions)	Updates server definition of current object to actual values using the specified options to update dependent objects. (Inherited from MajorObject.)
	Update(UpdateOptions, UpdateMode)	Updates server definition of current object to actual values using the specified options to update dependent objects. (Inherited from MajorObject.)
	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.)
	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.)
	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.)
	Validate(ValidationErrorCollection)	Validates the element to which it is appended; returns any errors encountered in a collection. (Inherited from ModelComponent.)
	Validate(ValidationResultCollection)	(Inherited from MajorObject.)
	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.)
	Validate(ValidationResultCollection, ValidationOptions)	(Inherited from MajorObject.)
	Validate(ValidationErrorCollection, Boolean, ServerEdition)	(Overrides NamedComponent.Validate(ValidationErrorCollection, Boolean, ServerEdition).)
	Validate(ValidationResultCollection, ValidationOptions, ServerEdition)	(Inherited from MajorObject.)

Top

Events

	Name	Description
	Disposed	(Inherited from Component.)

Top

Explicit Interface Implementations

	Name	Description
	ICloneable.Clone
	IDeserializationCallback.OnDeserialization	(Inherited from MajorObject.)
	IFormattable.ToString	(Inherited from NamedComponent.)
	IDeserializationStartCallback.OnDeserializationBegin	(Inherited from MajorObject.)
	IHostableComponent.Host	(Inherited from ModelComponent.)
	IMajorObject.BaseType
	IMajorObject.CreateBody
	IMajorObject.DependsOn
	IMajorObject.ObjectReference
	IMajorObject.ParentDatabase
	IMajorObject.ParentServer
	IMajorObject.Path
	IMajorObject.WriteRef
	IModelComponent.FriendlyPath	(Inherited from ModelComponent.)
	IModelComponent.OwningCollection	(Inherited from ModelComponent.)
	IProcessable.LastProcessed	(Inherited from ProcessableMajorObject.)
	IProcessable.State	(Inherited from ProcessableMajorObject.)

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.

Share via