MiningModel Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Defines the details of an individual mining model. This class cannot be inherited.
[System.Runtime.InteropServices.Guid("AB0A80A1-D3FB-45f0-8D3A-37455E7BF4DB")]
public sealed class MiningModel : Microsoft.AnalysisServices.ProcessableMajorObject, ICloneable, IDisposable, Microsoft.AnalysisServices.IMajorObject[<System.Runtime.InteropServices.Guid("AB0A80A1-D3FB-45f0-8D3A-37455E7BF4DB")>]
type MiningModel = class
inherit ProcessableMajorObject
interface IMajorObject
interface INamedComponent
interface IModelComponent
interface IComponent
interface IDisposable
interface ICloneablePublic 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() |
Initializes a new instance of the MiningModel class using the default values. |
| MiningModel(String, String) |
Initializes a new instance of the MiningModel class using the specified name and identifier. |
| MiningModel(String) |
Initializes a new instance of the MiningModel class using the specified name. |
Fields
| MaxIDLength |
Specifies the maximum length of the identifier. (Inherited from NamedComponent) |
| MaxNameLength |
Specifies the maximum length of the name. (Inherited from NamedComponent) |
Properties
| 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 an indication whether drillthrough is permitted on the mining model. |
| Annotations |
Gets the collection of all annotations associated with the major 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. |
| CreatedTimestamp |
Gets or sets the date and time of the creation of the object. (Inherited from MajorObject) |
| Description |
Gets or sets the description of major 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. |
| FriendlyName |
Gets a user-friendly name for the component. (Inherited from NamedComponent) |
| ID |
Gets or sets the identifier of the component. (Inherited from NamedComponent) |
| IsLoaded |
Gets a value that indicates whether MajorObject have been loaded. (Inherited from MajorObject) |
| KeyForCollection |
Gets 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 parent MiningStructure object of the MiningModel object. |
| ParentDatabase |
Gets the parent Database object of the MiningModel object. |
| ParentServer |
Gets the parent Server object of the MiningModel object. |
| Site |
Gets or sets the site associated with the component. (Inherited from NamedComponent) |
| SiteID |
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. |
Methods
| AddToContainer(IContainer) |
Adds the ModelComponent object to the specified container. (Inherited from ModelComponent) |
| AfterInsert(Int32) |
Displays a ModelComponent object after added to the specified index. (Inherited from ModelComponent) |
| AfterMove(Int32, Int32) |
Displays a ModelComponent object after moving to the specified index. (Inherited from ModelComponent) |
| AfterRemove(ModelComponentCollection) |
Displays a ModelComponentCollection after a ModelComponent object is removed. (Inherited from ModelComponent) |
| BeforeRemove(Boolean) |
Removes the ModelComponent object before the cleanup. (Inherited from ModelComponent) |
| CanProcess(ProcessType) |
Indicates whether the mining model can be processed with the specified process type. |
| Clone() |
Returns a clone of the object. |
| Clone(Boolean) |
Creates a new copy of the MajorObject object. (Inherited from MajorObject) |
| CopyTo(MajorObject, Boolean) |
Copies the object to the specified destination. (Inherited from ProcessableMajorObject) |
| CopyTo(MiningModel) |
Copies the content of this object to another object (the destination). |
| CopyTo(ModelComponent) |
Copies a ModelComponent object to the specified object. (Inherited from ModelComponent) |
| CopyTo(NamedComponent) |
Copies a NamedComponent object to the specified object. (Inherited from NamedComponent) |
| Drop() |
Removes current object and updates server. (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) |
| 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) |
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) |
Removes current object and updates server using specified options. (Inherited from MajorObject) |
| FindRelatedColumn(MiningStructureColumn) |
Finds the specified column from the mining structure that is associated with the model. |
| GetCreateReferences(Hashtable, Boolean, Boolean) |
Gets a Hashtable to create references. (Inherited from MajorObject) |
| GetDependents(Hashtable) |
Gets the dependents to the specified Hashtable. (Inherited from MajorObject) |
| GetDropDependents(Hashtable, Hashtable) |
Gets the drop dependents. (Inherited from MajorObject) |
| GetReferences(Hashtable, Boolean) |
Gets the objects that the MajorObject references. (Inherited from MajorObject) |
| GetUpdateOverwrites(Boolean) |
Gets the Hashtable object that overwrites the updated MajorObject. (Inherited from MajorObject) |
| Process() |
Processes the ProcessableMajorObject. (Inherited from ProcessableMajorObject) |
| Process(ProcessType, ErrorConfiguration, XmlaWarningCollection, ImpactDetailCollection, Boolean) |
Processes the ProcessableMajorObject with the specified process type, error handling configuration, warnings and impact details. (Inherited from ProcessableMajorObject) |
| Process(ProcessType, ErrorConfiguration, XmlaWarningCollection, ImpactDetailCollection) |
Processes the ProcessableMajorObject with the specified process type, error handling configuration, warnings and impact details. (Inherited from ProcessableMajorObject) |
| Process(ProcessType, ErrorConfiguration, XmlaWarningCollection) |
Processes the ProcessableMajorObject with the specified process type, error handling configuration and warnings. (Inherited from ProcessableMajorObject) |
| Process(ProcessType, ErrorConfiguration) |
Processes the ProcessableMajorObject with the specified process type and error handling configuration. (Inherited from ProcessableMajorObject) |
| Process(ProcessType, IBinding) |
Processes the ProcessableMajorObject with the specified process type and binding. (Inherited from ProcessableMajorObject) |
| Process(ProcessType, WriteBackTableCreation) |
Processes the ProcessableMajorObject with the specified process type and writeback option. (Inherited from ProcessableMajorObject) |
| Process(ProcessType) |
Processes the ProcessableMajorObject with the specified process type. (Inherited from ProcessableMajorObject) |
| Refresh() |
Updates the object from server definitions. (Inherited from MajorObject) |
| Refresh(Boolean, RefreshType) |
Updates the object from server definitions, as well as loaded dependent objects [if specified]. (Inherited from MajorObject) |
| Refresh(Boolean) |
Updates the object from server definitions, as well as loaded dependent objects [if specified]. (Inherited from MajorObject) |
| RemoveFromContainer(IContainer) |
Removes the ModelComponent object from the specified container. (Inherited from ModelComponent) |
| Reset() |
Resets the component to its initial state. (Inherited from NamedComponent) |
| Submit() |
Submits a ModelComponent object. (Inherited from ModelComponent) |
| Submit(Boolean) |
Submits a ModelComponent object. (Inherited from ModelComponent) |
| ToString() |
Returns a string representing the named-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, 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) |
| 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) |
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) |
Updates server definition of current object to actual values using the specified options 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) |
| Validate(ValidationErrorCollection, Boolean, ServerEdition) |
Determines whether the mining model is valid. |
| 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) |
Validates the element to which it is appended; returns any errors encountered in a collection. (Inherited from ModelComponent) |
| Validate(ValidationResultCollection, ValidationOptions, ServerEdition) |
Indicates whether the MajorObject is valid. (Inherited from MajorObject) |
| Validate(ValidationResultCollection, ValidationOptions) |
Indicates whether the MajorObject is valid. (Inherited from MajorObject) |
| Validate(ValidationResultCollection) |
Indicates whether the MajorObject is valid. (Inherited from MajorObject) |
Explicit Interface Implementations
| ICloneable.Clone() | |
| IDeserializationCallback.OnDeserialization(Object) | (Inherited from MajorObject) |
| IDeserializationStartCallback.OnDeserializationBegin(Object) | (Inherited from MajorObject) |
| IFormattable.ToString(String, IFormatProvider) | (Inherited from NamedComponent) |
| IHostableComponent.Host | (Inherited from ModelComponent) |
| IMajorObject.BaseType | |
| IMajorObject.CreateBody() | |
| IMajorObject.DependsOn(IMajorObject) | |
| IMajorObject.ObjectReference | |
| IMajorObject.ParentDatabase | |
| IMajorObject.ParentServer | |
| IMajorObject.Path | |
| IMajorObject.WriteRef(XmlWriter) | |
| IModelComponent.FriendlyPath | (Inherited from ModelComponent) |
| IModelComponent.OwningCollection | (Inherited from ModelComponent) |
| IProcessable.LastProcessed | (Inherited from ProcessableMajorObject) |
| IProcessable.State | (Inherited from ProcessableMajorObject) |