MiningModel MiningModel MiningModel Class

Definition

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

public ref class MiningModel sealed : Microsoft::AnalysisServices::ProcessableMajorObject, ICloneable, IDisposable, Microsoft::AnalysisServices::IMajorObject
[System.ComponentModel.Designer("Microsoft.AnalysisServices.Design.MiningModelComponentDesigner, Microsoft.AnalysisServices.Design", typeof(System.ComponentModel.Design.IDesigner))]
[System.Runtime.InteropServices.Guid("AB0A80A1-D3FB-45f0-8D3A-37455E7BF4DB")]
[System.Xml.Serialization.XmlRoot(ElementName="MiningModel", Namespace="http://schemas.microsoft.com/analysisservices/2003/engine")]
public sealed class MiningModel : Microsoft.AnalysisServices.ProcessableMajorObject, ICloneable, IDisposable, Microsoft.AnalysisServices.IMajorObject
Public NotInheritable Class MiningModel
Inherits ProcessableMajorObject
Implements ICloneable, IDisposable, IMajorObject
Inheritance
Attributes
Implements

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.

Constructors

MiningModel() MiningModel() MiningModel()

Initializes a new instance of the MiningModel class using the default values.

MiningModel(String) MiningModel(String) MiningModel(String)

Initializes a new instance of the MiningModel class using a name.

MiningModel(String, String) MiningModel(String, String) MiningModel(String, String)

Initializes a new instance of the MiningModel class using a name and an identifier.

Properties

Algorithm Algorithm Algorithm

Gets or sets the algorithm associated with the MiningModel, which can be supplied by Microsoft or can be your own custom algorithm.

AlgorithmParameters AlgorithmParameters AlgorithmParameters

Gets the applicable set of algorithm parameters, independent of assigned algorithm.

AllowDrillThrough AllowDrillThrough AllowDrillThrough

Gets or sets a value that indicates whether drillthrough is permitted on the mining model.

Annotations Annotations Annotations

Gets the collection object of all annotations to current object.

(Inherited from MajorObject)
Collation Collation Collation

Gets or sets the collation used by the MiningModel object.

Columns Columns Columns

Gets the collection of columns associated with the MiningModel object.

CreatedTimestamp CreatedTimestamp CreatedTimestamp

Gets or sets the date and time of the creation of the object.

(Inherited from MajorObject)
Description Description Description

Gets or sets a description string of current object.

(Inherited from MajorObject)
Filter Filter Filter

Gets or sets the filter expression associated with the mining model.

FoldingParameters FoldingParameters FoldingParameters

Gets or sets the folding parameters associated with the mining model.

FriendlyName FriendlyName FriendlyName

Returns a user-friendly name.

(Inherited from NamedComponent)
ID ID ID

Gets or sets the identifier of the component.

(Inherited from NamedComponent)
IHostableComponent.Host IHostableComponent.Host IHostableComponent.Host

Gets or sets the IServiceProvider that is the host of the ModelComponent.

(Inherited from ModelComponent)
IModelComponent.FriendlyPath IModelComponent.FriendlyPath IModelComponent.FriendlyPath

Gets a friendly path for the ModelComponent.

(Inherited from ModelComponent)
IModelComponent.OwningCollection IModelComponent.OwningCollection IModelComponent.OwningCollection

Gets or sets the collection that owns the current object.

(Inherited from ModelComponent)
IProcessable.LastProcessed IProcessable.LastProcessed IProcessable.LastProcessed

Gets or sets the DateTime on which the object was last processed.

(Inherited from ProcessableMajorObject)
IProcessable.State IProcessable.State IProcessable.State

Gets or sets the AnalysisState of this current instance.

(Inherited from ProcessableMajorObject)
IsLoaded IsLoaded IsLoaded

Gets a value that indicates whether MajorObject have been loaded.

(Inherited from MajorObject)
KeyForCollection KeyForCollection KeyForCollection

Returns the key used in collections.

(Inherited from NamedComponent)
Language Language Language

Gets or sets the language to use by default.

LastProcessed LastProcessed LastProcessed

Gets or sets the DateTime on which the object was last processed.

(Inherited from ProcessableMajorObject)
LastSchemaUpdate LastSchemaUpdate LastSchemaUpdate

Gets or sets the date and time when current object schema was last updated.

(Inherited from MajorObject)
MiningModelPermissions MiningModelPermissions MiningModelPermissions

Gets the collection of permissions for a MiningModel object.

Name Name Name

Gets or sets the name of the component.

(Inherited from NamedComponent)
OwningCollection OwningCollection OwningCollection

Gets or sets the collection that contains the ModelComponent.

(Inherited from ModelComponent)
Parent Parent Parent

Gets the MiningStructure to which this mining model belongs.

ParentDatabase ParentDatabase ParentDatabase

Gets the Database object that is the parent of the MiningModel object.

ParentServer ParentServer ParentServer

Gets the Server object that is the parent of the MiningModel object.

Site Site Site

Gets or sets the site of the component.

(Inherited from NamedComponent)
SiteID SiteID SiteID

Gets or sets the identifier for the site associated with the component.

(Inherited from NamedComponent)
State State State

Gets or sets the AnalysisState of this current instance.

(Inherited from ProcessableMajorObject)
Translations Translations Translations

Gets the collection of Translation objects associated with the MiningModel object.

Methods

AddToContainer(IContainer) AddToContainer(IContainer) AddToContainer(IContainer)

Adds a ModelComponent object to the specified container.

(Inherited from ModelComponent)
AfterInsert(Int32) AfterInsert(Int32) AfterInsert(Int32)

Displays a ModelComponent object after added to the specified index.

(Inherited from ModelComponent)
AfterMove(Int32, Int32) AfterMove(Int32, Int32) AfterMove(Int32, Int32)

Displays a ModelComponent object after moving to the specified index.

(Inherited from ModelComponent)
AfterRemove(ModelComponentCollection) AfterRemove(ModelComponentCollection) AfterRemove(ModelComponentCollection)

Displays a ModelComponentCollection after a ModelComponent object is removed.

(Inherited from ModelComponent)
BeforeRemove(Boolean) BeforeRemove(Boolean) BeforeRemove(Boolean)

Removes the ModelComponent object before the cleanup.

(Inherited from ModelComponent)
CanProcess(ProcessType) CanProcess(ProcessType) CanProcess(ProcessType)

Indicates whether the mining model can be processed with the specified process type.

Clone() Clone() Clone()

Returns a clone of the object.

Clone(Boolean) Clone(Boolean) Clone(Boolean)

Creates a new copy of the MajorObject object.

(Inherited from MajorObject)
CopyTo(MajorObject, Boolean) CopyTo(MajorObject, Boolean) CopyTo(MajorObject, Boolean)

Copies the object to the specified destination.

(Inherited from ProcessableMajorObject)
CopyTo(MiningModel) CopyTo(MiningModel) CopyTo(MiningModel)

Copies the content of the object to another object (the destination).

CopyTo(ModelComponent) CopyTo(ModelComponent) CopyTo(ModelComponent)

Copies a ModelComponent object to the specified object.

(Inherited from ModelComponent)
CopyTo(NamedComponent) CopyTo(NamedComponent) CopyTo(NamedComponent)

Copies a NamedComponent object to the specified object.

(Inherited from NamedComponent)
Drop() Drop() Drop()

Removes current object and updates server.

(Inherited from MajorObject)
Drop(DropOptions) Drop(DropOptions) Drop(DropOptions)

Removes current object and updates server using specified options.

(Inherited from MajorObject)
Drop(DropOptions, XmlaWarningCollection) Drop(DropOptions, XmlaWarningCollection) 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) Drop(DropOptions, XmlaWarningCollection, ImpactDetailCollection) 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) Drop(DropOptions, XmlaWarningCollection, ImpactDetailCollection, Boolean) 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)
FindRelatedColumn(MiningStructureColumn) FindRelatedColumn(MiningStructureColumn) FindRelatedColumn(MiningStructureColumn)

Finds the specified column from the mining structure that is associated with the model.

GetCreateReferences(Hashtable, Boolean, Boolean) GetCreateReferences(Hashtable, Boolean, Boolean) GetCreateReferences(Hashtable, Boolean, Boolean)

Gets a Hashtable to create references.

(Inherited from MajorObject)
GetDependents(Hashtable) GetDependents(Hashtable) GetDependents(Hashtable)

Gets the dependents to the specified Hashtable.

(Inherited from MajorObject)
GetDropDependents(Hashtable, Hashtable) GetDropDependents(Hashtable, Hashtable) GetDropDependents(Hashtable, Hashtable)

Gets the drop dependents.

(Inherited from MajorObject)
GetReferences(Hashtable, Boolean) GetReferences(Hashtable, Boolean) GetReferences(Hashtable, Boolean)

Gets the objects that the MajorObject references.

(Inherited from MajorObject)
GetUpdateOverwrites(Boolean) GetUpdateOverwrites(Boolean) GetUpdateOverwrites(Boolean)

Gets the Hashtable object that overwrites the updated MajorObject.

(Inherited from MajorObject)
Process() Process() Process()

Processes the ProcessableMajorObject.

(Inherited from ProcessableMajorObject)
Process(ProcessType) Process(ProcessType) Process(ProcessType)

Processes the ProcessableMajorObject with the specified process type.

(Inherited from ProcessableMajorObject)
Process(ProcessType, ErrorConfiguration) Process(ProcessType, ErrorConfiguration) Process(ProcessType, ErrorConfiguration)

Processes the ProcessableMajorObject with the specified process type.

(Inherited from ProcessableMajorObject)
Process(ProcessType, ErrorConfiguration, XmlaWarningCollection) Process(ProcessType, ErrorConfiguration, XmlaWarningCollection) Process(ProcessType, ErrorConfiguration, XmlaWarningCollection)

Processes the ProcessableMajorObject with the specified process type.

(Inherited from ProcessableMajorObject)
Process(ProcessType, ErrorConfiguration, XmlaWarningCollection, ImpactDetailCollection) Process(ProcessType, ErrorConfiguration, XmlaWarningCollection, ImpactDetailCollection) Process(ProcessType, ErrorConfiguration, XmlaWarningCollection, ImpactDetailCollection)

Processes the ProcessableMajorObject with the specified process type.

(Inherited from ProcessableMajorObject)
Process(ProcessType, ErrorConfiguration, XmlaWarningCollection, ImpactDetailCollection, Boolean) Process(ProcessType, ErrorConfiguration, XmlaWarningCollection, ImpactDetailCollection, Boolean) Process(ProcessType, ErrorConfiguration, XmlaWarningCollection, ImpactDetailCollection, Boolean)

Processes the ProcessableMajorObject with the specified process type.

(Inherited from ProcessableMajorObject)
Process(ProcessType, IBinding) Process(ProcessType, IBinding) Process(ProcessType, IBinding) Inherited from ProcessableMajorObject
Process(ProcessType, WriteBackTableCreation) Process(ProcessType, WriteBackTableCreation) Process(ProcessType, WriteBackTableCreation)

Processes the ProcessableMajorObject with the specified process type and writeback option.

(Inherited from ProcessableMajorObject)
Refresh() Refresh() Refresh()

Updates current object from server definitions.

(Inherited from MajorObject)
Refresh(Boolean) Refresh(Boolean) Refresh(Boolean)

Updates current object from server definitions and loaded dependent objects if specified.

(Inherited from MajorObject)
Refresh(Boolean, RefreshType) Refresh(Boolean, RefreshType) Refresh(Boolean, RefreshType)

Updates current object from server definitions and loaded dependent objects if specified.

(Inherited from MajorObject)
RemoveFromContainer(IContainer) RemoveFromContainer(IContainer) RemoveFromContainer(IContainer)

Removes a ModelComponent object from the specified container.

(Inherited from ModelComponent)
Reset() Reset() Reset()

Resets the component to its initial state.

(Inherited from NamedComponent)
Submit() Submit() Submit()

Submits a ModelComponent object.

(Inherited from ModelComponent)
Submit(Boolean) Submit(Boolean) Submit(Boolean)

Submits a ModelComponent object.

(Inherited from ModelComponent)
ToString() ToString() ToString()

Returns a string containing the name of the component.

(Inherited from NamedComponent)
Update() Update() Update()

Updates server definition of current object to actual values using the default values to update dependent objects.

(Inherited from MajorObject)
Update(UpdateOptions) Update(UpdateOptions) 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) Update(UpdateOptions, UpdateMode) 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) Update(UpdateOptions, UpdateMode, XmlaWarningCollection) 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) Update(UpdateOptions, UpdateMode, XmlaWarningCollection, ImpactDetailCollection) 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) Update(UpdateOptions, UpdateMode, XmlaWarningCollection, ImpactDetailCollection, Boolean) 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) Validate(ValidationErrorCollection) Validate(ValidationErrorCollection)

Validates the element to which it is appended; returns any errors encountered in a collection.

(Inherited from ModelComponent)
Validate(ValidationErrorCollection, Boolean) Validate(ValidationErrorCollection, Boolean) 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(ValidationErrorCollection, Boolean, ServerEdition) Validate(ValidationErrorCollection, Boolean, ServerEdition) Validate(ValidationErrorCollection, Boolean, ServerEdition)

Determines whether the mining model is valid.

Validate(ValidationResultCollection) Validate(ValidationResultCollection) Validate(ValidationResultCollection)

Indicates whether the MajorObject is valid.

(Inherited from MajorObject)
Validate(ValidationResultCollection, ValidationOptions) Validate(ValidationResultCollection, ValidationOptions) Validate(ValidationResultCollection, ValidationOptions)

Indicates whether the MajorObject is valid.

(Inherited from MajorObject)
Validate(ValidationResultCollection, ValidationOptions, ServerEdition) Validate(ValidationResultCollection, ValidationOptions, ServerEdition) Validate(ValidationResultCollection, ValidationOptions, ServerEdition)

Indicates whether the MajorObject is valid.

(Inherited from MajorObject)

Explicit Interface Implementations

ICloneable.Clone() ICloneable.Clone() ICloneable.Clone()

Returns a clone of the object.

IDeserializationCallback.OnDeserialization(Object) IDeserializationCallback.OnDeserialization(Object) IDeserializationCallback.OnDeserialization(Object)

Runs when the entire object graph has been deserialized.

(Inherited from MajorObject)
IDeserializationStartCallback.OnDeserializationBegin(Object) IDeserializationStartCallback.OnDeserializationBegin(Object) IDeserializationStartCallback.OnDeserializationBegin(Object)

Runs when the entire object graph starts to deserialized.

(Inherited from MajorObject)
IFormattable.ToString(String, IFormatProvider) IFormattable.ToString(String, IFormatProvider) IFormattable.ToString(String, IFormatProvider)

Formats the value of the current instance using the specified format.

(Inherited from NamedComponent)
IMajorObject.BaseType IMajorObject.BaseType IMajorObject.BaseType

Gets the base type implementation of the mining model.

IMajorObject.CreateBody() IMajorObject.CreateBody() IMajorObject.CreateBody()

Creates a new body for the mining model.

IMajorObject.DependsOn(IMajorObject) IMajorObject.DependsOn(IMajorObject) IMajorObject.DependsOn(IMajorObject)

Determines whether the mining model depends on an object.

IMajorObject.ObjectReference IMajorObject.ObjectReference IMajorObject.ObjectReference

Gets the object reference implementation of the mining model.

IMajorObject.ParentDatabase IMajorObject.ParentDatabase IMajorObject.ParentDatabase

Gets the parent database implementation of the mining model.

IMajorObject.ParentServer IMajorObject.ParentServer IMajorObject.ParentServer

Gets the parent server implementation of the mining model.

IMajorObject.Path IMajorObject.Path IMajorObject.Path

Gets the path implementation of the mining model.

IMajorObject.WriteRef(XmlWriter) IMajorObject.WriteRef(XmlWriter) IMajorObject.WriteRef(XmlWriter)

Writes a reference for the mining model.

Fields

MaxIDLength MaxIDLength MaxIDLength

Specifies the maximum length of the identifier.

(Inherited from NamedComponent)
MaxNameLength MaxNameLength MaxNameLength

Specifies the maximum length of the name.

(Inherited from NamedComponent)

Applies to