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 | |
|---|---|---|
.gif "Public method") |
MiningModel() | Initializes a new instance of the MiningModel class using the default values. |
|
MiningModel(String) | Initializes a new instance of the MiningModel class using a name. |
|
MiningModel(String, String) | Initializes a new instance of the MiningModel class using a name and an identifier. |
Top
Properties
| Name | Description | |
|---|---|---|
.gif "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. |
|
AlgorithmParameters | Gets the applicable set of algorithm parameters, independent of assigned algorithm. |
|
AllowDrillThrough | Gets or sets a value that indicates whether drillthrough is permitted on the mining model. |
|
Annotations | Gets the collection object of all annotations to current object. (Inherited from MajorObject.) |
|
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.) |
|
Filter | Gets or sets the filter expression associated with the mining model. |
|
FoldingParameters | Gets or sets the folding parameters associated with the mining model. |
.gif "Protected property") |
FriendlyName | Returns a user-friendly name. (Inherited from NamedComponent.) |
|
ID | Gets or sets the identifier of the component. (Inherited from NamedComponent.) |
|
IsLoaded | Infrastructure. Gets a value that indicates whether MajorObject have been loaded. (Inherited from MajorObject.) |
|
KeyForCollection | Returns the key used in collections. (Inherited from NamedComponent.) |
|
Language | Gets or sets the language to use by default. |
|
LastProcessed | Gets or sets the DateTime on which the object was last processed. (Inherited from ProcessableMajorObject.) |
|
LastSchemaUpdate | Gets or sets the date and time when current object schema was last updated. (Inherited from MajorObject.) |
|
MiningModelPermissions | Gets the collection of permissions for a MiningModel object. |
|
Name | Gets or sets the name of the component. (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 | Infrastructure. Gets or sets the site of the component. (Inherited from NamedComponent.) |
|
SiteID | Infrastructure. Gets or sets the identifier for the site associated with the component. (Inherited from NamedComponent.) |
|
State | Gets or sets the AnalysisState of this current instance. (Inherited from ProcessableMajorObject.) |
|
Translations | Gets the collection of Translation objects associated with the MiningModel object. |
Top
Methods
| Name | Description | |
|---|---|---|
.gif "Protected method") |
AddToContainer | Infrastructure. Adds a ModelComponent object to the specified container. (Inherited from ModelComponent.) |
|
AfterInsert | Infrastructure. Displays a ModelComponent object after added to the specified index. (Inherited from ModelComponent.) |
|
AfterMove | Infrastructure. Displays a ModelComponent object after moving to the specified index. (Inherited from ModelComponent.) |
|
AfterRemove | Infrastructure. Displays a ModelComponentCollection after a ModelComponent object is removed. (Inherited from ModelComponent.) |
|
BeforeRemove | Infrastructure. Removes the ModelComponent object before the cleanup. (Inherited from ModelComponent.) |
|
CanProcess | Indicates whether the mining model can be processed with the specified process type. (Overrides ProcessableMajorObject.CanProcess(ProcessType).) |
|
Clone() | Returns a clone of the object. |
|
Clone(Boolean) | Infrastructure. Creates a new copy of the MajorObject object. (Inherited from MajorObject.) |
|
CopyTo(MiningModel) | Copies the content of the object to another object (the destination). |
|
CopyTo(MajorObject, Boolean) | Copies the object to the specified destination. (Inherited from ProcessableMajorObject.) |
|
CreateObjRef | Security Critical. (Inherited from MarshalByRefObject.) |
|
Dispose | (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.) |
|
FindRelatedColumn | Finds the specified column from the mining structure that is associated with the model. |
|
GetCreateReferences | Infrastructure. Gets a Hashtable to create references. (Inherited from MajorObject.) |
|
GetDependents | Infrastructure. Gets the dependents to the specified Hashtable. (Inherited from MajorObject.) |
|
GetDropDependents | Infrastructure. Gets the drop dependents. (Inherited from MajorObject.) |
|
GetHashCode | (Inherited from Object.) |
|
GetLifetimeService | Security Critical. (Inherited from MarshalByRefObject.) |
|
GetReferences | Infrastructure. Gets the objects that the MajorObject references. (Inherited from MajorObject.) |
|
GetType | (Inherited from Object.) |
|
GetUpdateOverwrites | Infrastructure. Gets the Hashtable object that overwrites the updated MajorObject. (Inherited from MajorObject.) |
|
InitializeLifetimeService | Security Critical. (Inherited from MarshalByRefObject.) |
|
Process() | Processes the ProcessableMajorObject. (Inherited from ProcessableMajorObject.) |
|
Process(ProcessType) | Processes the ProcessableMajorObject with the specified process type. (Inherited from ProcessableMajorObject.) |
|
Process(ProcessType, Binding) | Processes the ProcessableMajorObject with the specified process type. (Inherited from ProcessableMajorObject.) |
|
Process(ProcessType, ErrorConfiguration) | Processes the ProcessableMajorObject with the specified process type. (Inherited from ProcessableMajorObject.) |
|
Process(ProcessType, WriteBackTableCreation) | Processes the ProcessableMajorObject with the specified process type and writeback option. (Inherited from ProcessableMajorObject.) |
|
Process(ProcessType, ErrorConfiguration, XmlaWarningCollection) | Processes the ProcessableMajorObject with the specified process type. (Inherited from ProcessableMajorObject.) |
|
Process(ProcessType, ErrorConfiguration, XmlaWarningCollection, ImpactDetailCollection) | Processes the ProcessableMajorObject with the specified process type. (Inherited from ProcessableMajorObject.) |
|
Process(ProcessType, ErrorConfiguration, XmlaWarningCollection, ImpactDetailCollection, Boolean) | Processes the ProcessableMajorObject with the specified process type. (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. Removes a ModelComponent object from the specified container. (Inherited from ModelComponent.) |
|
Submit() | Infrastructure. Submits a ModelComponent object. (Inherited from ModelComponent.) |
|
Submit(Boolean) | Infrastructure. Submits a ModelComponent object. (Inherited from ModelComponent.) |
|
ToString | Returns a string containing the name of the component. (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) | Indicates whether the MajorObject is valid. (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) | Indicates whether the MajorObject is valid. (Inherited from MajorObject.) |
|
Validate(ValidationErrorCollection, Boolean, ServerEdition) | Determines whether the mining model is valid. (Overrides NamedComponent.Validate(ValidationErrorCollection, Boolean, ServerEdition).) |
|
Validate(ValidationResultCollection, ValidationOptions, ServerEdition) | Indicates whether the MajorObject is valid. (Inherited from MajorObject.) |
Top
Events
| Name | Description | |
|---|---|---|
.gif "Public event") |
Disposed | (Inherited from Component.) |
Top
Explicit Interface Implementations
| Name | Description | |
|---|---|---|
.gif "Explicit interface implemetation") .gif "Private method") |
ICloneable.Clone | Returns a clone of the object. |
|
IDeserializationCallback.OnDeserialization | Runs when the entire object graph has been deserialized. (Inherited from MajorObject.) |
|
IFormattable.ToString | Formats the value of the current instance using the specified format. (Inherited from NamedComponent.) |
|
IDeserializationStartCallback.OnDeserializationBegin | Runs when the entire object graph starts to deserialized. (Inherited from MajorObject.) |
.gif "Private property") |
IHostableComponent.Host | Gets or sets the IServiceProvider that is the host of the ModelComponent. (Inherited from ModelComponent.) |
|
IMajorObject.BaseType | Gets the base type implementation of the mining model. |
|
IMajorObject.CreateBody | Creates a new body for the mining model. |
|
IMajorObject.DependsOn | Determines whether the mining model depends on an object. |
|
IMajorObject.ObjectReference | Gets the object reference implementation of the mining model. |
|
IMajorObject.ParentDatabase | Gets the parent database implementation of the mining model. |
|
IMajorObject.ParentServer | Gets the parent server implementation of the mining model. |
|
IMajorObject.Path | Gets the path implementation of the mining model. |
|
IMajorObject.WriteRef | Writes a reference for the mining model. |
|
IModelComponent.FriendlyPath | Gets a friendly path for the ModelComponent. (Inherited from ModelComponent.) |
|
IModelComponent.OwningCollection | Gets or sets the collection that owns the current object. (Inherited from ModelComponent.) |
|
IProcessable.LastProcessed | Gets or sets the DateTime on which the object was last processed. (Inherited from ProcessableMajorObject.) |
|
IProcessable.State | Gets or sets the AnalysisState of this current instance. (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.