Export (0) Print
Expand All

MiningModel Class

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

Object
  MarshalByRefObject
    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)

[DesignerAttribute("Microsoft.AnalysisServices.Design.MiningModelComponentDesigner, Microsoft.AnalysisServices.Design", 
	typeof(IDesigner))]
[GuidAttribute("AB0A80A1-D3FB-45f0-8D3A-37455E7BF4DB")]
[XmlRootAttribute(ElementName = "MiningModel", Namespace = "http://schemas.microsoft.com/analysisservices/2003/engine")]
public sealed class MiningModel : ProcessableMajorObject, 
	IMajorObject, INamedComponent, IModelComponent, IComponent, IDisposable, 
	ICloneable

The MiningModel type exposes the following members.

  NameDescription
Public methodMiningModel()Initializes a new instance of the MiningModel class using the default values.
Public methodMiningModel(String)Initializes a new instance of the MiningModel class using a name.
Public methodMiningModel(String, String)Initializes a new instance of the MiningModel class using a name and an identifier.
Top

  NameDescription
Public propertyAlgorithmGets or sets the algorithm associated with the MiningModel, which can be supplied by Microsoft or can be your own custom algorithm.
Public propertyAlgorithmParametersGets the applicable set of algorithm parameters, independent of assigned algorithm.
Public propertyAllowDrillThroughGets or sets a value that indicates whether drillthrough is permitted on the mining model.
Public propertyAnnotationsGets the collection object of all annotations to current object. (Inherited from MajorObject.)
Public propertyCollationGets or sets the collation used by the MiningModel object.
Public propertyColumnsGets the collection of columns associated with the MiningModel object.
Public propertyContainer (Inherited from Component.)
Public propertyCreatedTimestampGets or sets the date and time of the creation of the object. (Inherited from MajorObject.)
Public propertyDescriptionGets or sets a description string of current object. (Inherited from MajorObject.)
Public propertyFilterGets or sets the filter expression associated with the mining model.
Public propertyFoldingParametersGets or sets the folding parameters associated with the mining model.
Protected propertyFriendlyNameReturns a user-friendly name. (Inherited from NamedComponent.)
Public propertyIDGets or sets the identifier of the component. (Inherited from NamedComponent.)
Public propertyIsLoadedInfrastructure. Gets a value that indicates whether MajorObject have been loaded. (Inherited from MajorObject.)
Protected propertyKeyForCollectionReturns the key used in collections. (Inherited from NamedComponent.)
Public propertyLanguageGets or sets the language to use by default.
Public propertyLastProcessedGets or sets the DateTime on which the object was last processed. (Inherited from ProcessableMajorObject.)
Public propertyLastSchemaUpdateGets or sets the date and time when current object schema was last updated. (Inherited from MajorObject.)
Public propertyMiningModelPermissionsGets the collection of permissions for a MiningModel object.
Public propertyNameGets or sets the name of the component. (Inherited from NamedComponent.)
Public propertyOwningCollectionGets or sets the collection that contains the ModelComponent. (Inherited from ModelComponent.)
Public propertyParentGets the MiningStructure to which this mining model belongs.
Public propertyParentDatabaseGets the Database object that is the parent of the MiningModel object.
Public propertyParentServerGets the Server object that is the parent of the MiningModel object.
Public propertySiteInfrastructure. Gets or sets the site of the component. (Inherited from NamedComponent.)
Public propertySiteIDInfrastructure. Gets or sets the identifier for the site associated with the component. (Inherited from NamedComponent.)
Public propertyStateGets or sets the AnalysisState of this current instance. (Inherited from ProcessableMajorObject.)
Public propertyTranslationsGets the collection of Translation objects associated with the MiningModel object.
Top

  NameDescription
Protected methodAddToContainerInfrastructure. Adds a ModelComponent object to the specified container. (Inherited from ModelComponent.)
Protected methodAfterInsertInfrastructure. Displays a ModelComponent object after added to the specified index. (Inherited from ModelComponent.)
Protected methodAfterMoveInfrastructure. Displays a ModelComponent object after moving to the specified index. (Inherited from ModelComponent.)
Protected methodAfterRemoveInfrastructure. Displays a ModelComponentCollection after a ModelComponent object is removed. (Inherited from ModelComponent.)
Protected methodBeforeRemoveInfrastructure. Removes the ModelComponent object before the cleanup. (Inherited from ModelComponent.)
Public methodCanProcessIndicates whether the mining model can be processed with the specified process type. (Overrides ProcessableMajorObject.CanProcess(ProcessType).)
Public methodClone()Returns a clone of the object.
Protected methodClone(Boolean)Infrastructure. Creates a new copy of the MajorObject object. (Inherited from MajorObject.)
Public methodCopyTo(MiningModel)Copies the content of the object to another object (the destination).
Protected methodCopyTo(MajorObject, Boolean)Copies the object to the specified destination. (Inherited from ProcessableMajorObject.)
Public methodCreateObjRefSecurity Critical. (Inherited from MarshalByRefObject.)
Public methodDispose (Inherited from Component.)
Public methodDrop()Removes current object and updates server. (Inherited from MajorObject.)
Public methodDrop(DropOptions)Removes current object and updates server using specified options. (Inherited from MajorObject.)
Public methodDrop(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 methodDrop(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 methodDrop(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 methodEquals (Inherited from Object.)
Public methodFindRelatedColumnFinds the specified column from the mining structure that is associated with the model.
Protected methodGetCreateReferencesInfrastructure. Gets a Hashtable to create references. (Inherited from MajorObject.)
Public methodGetDependentsInfrastructure. Gets the dependents to the specified Hashtable. (Inherited from MajorObject.)
Protected methodGetDropDependentsInfrastructure. Gets the drop dependents. (Inherited from MajorObject.)
Public methodGetHashCode (Inherited from Object.)
Public methodGetLifetimeServiceSecurity Critical. (Inherited from MarshalByRefObject.)
Public methodGetReferencesInfrastructure. Gets the objects that the MajorObject references. (Inherited from MajorObject.)
Public methodGetType (Inherited from Object.)
Public methodGetUpdateOverwritesInfrastructure. Gets the Hashtable object that overwrites the updated MajorObject. (Inherited from MajorObject.)
Public methodInitializeLifetimeServiceSecurity Critical. (Inherited from MarshalByRefObject.)
Public methodProcess()Processes the ProcessableMajorObject. (Inherited from ProcessableMajorObject.)
Public methodProcess(ProcessType)Processes the ProcessableMajorObject with the specified process type. (Inherited from ProcessableMajorObject.)
Public methodProcess(ProcessType, Binding)Processes the ProcessableMajorObject with the specified process type. (Inherited from ProcessableMajorObject.)
Public methodProcess(ProcessType, ErrorConfiguration)Processes the ProcessableMajorObject with the specified process type. (Inherited from ProcessableMajorObject.)
Public methodProcess(ProcessType, WriteBackTableCreation)Processes the ProcessableMajorObject with the specified process type and writeback option. (Inherited from ProcessableMajorObject.)
Public methodProcess(ProcessType, ErrorConfiguration, XmlaWarningCollection)Processes the ProcessableMajorObject with the specified process type. (Inherited from ProcessableMajorObject.)
Public methodProcess(ProcessType, ErrorConfiguration, XmlaWarningCollection, ImpactDetailCollection)Processes the ProcessableMajorObject with the specified process type. (Inherited from ProcessableMajorObject.)
Public methodProcess(ProcessType, ErrorConfiguration, XmlaWarningCollection, ImpactDetailCollection, Boolean)Processes the ProcessableMajorObject with the specified process type. (Inherited from ProcessableMajorObject.)
Public methodRefresh()Updates current object from server definitions. (Inherited from MajorObject.)
Public methodRefresh(Boolean)Updates current object from server definitions and loaded dependent objects if specified. (Inherited from MajorObject.)
Public methodRefresh(Boolean, RefreshType)Updates current object from server definitions and loaded dependent objects if specified. (Inherited from MajorObject.)
Protected methodRemoveFromContainerInfrastructure. Removes a ModelComponent object from the specified container. (Inherited from ModelComponent.)
Public methodSubmit()Infrastructure. Submits a ModelComponent object. (Inherited from ModelComponent.)
Public methodSubmit(Boolean)Infrastructure. Submits a ModelComponent object. (Inherited from ModelComponent.)
Public methodToStringReturns a string containing the name of the component. (Inherited from NamedComponent.)
Public methodUpdate()Updates server definition of current object to actual values using the default values to update dependent objects. (Inherited from MajorObject.)
Public methodUpdate(UpdateOptions)Updates server definition of current object to actual values using the specified options to update dependent objects. (Inherited from MajorObject.)
Public methodUpdate(UpdateOptions, UpdateMode)Updates server definition of current object to actual values using the specified options to update dependent objects. (Inherited from MajorObject.)
Public methodUpdate(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 methodUpdate(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 methodUpdate(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 methodValidate(ValidationErrorCollection)Validates the element to which it is appended; returns any errors encountered in a collection. (Inherited from ModelComponent.)
Public methodValidate(ValidationResultCollection)Indicates whether the MajorObject is valid. (Inherited from MajorObject.)
Public methodValidate(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 methodValidate(ValidationResultCollection, ValidationOptions)Indicates whether the MajorObject is valid. (Inherited from MajorObject.)
Public methodValidate(ValidationErrorCollection, Boolean, ServerEdition)Determines whether the mining model is valid. (Overrides NamedComponent.Validate(ValidationErrorCollection, Boolean, ServerEdition).)
Public methodValidate(ValidationResultCollection, ValidationOptions, ServerEdition)Indicates whether the MajorObject is valid. (Inherited from MajorObject.)
Top

  NameDescription
Public eventDisposed (Inherited from Component.)
Top

  NameDescription
Explicit interface implemetationPrivate methodICloneableCloneReturns a clone of the object.
Explicit interface implemetationPrivate methodIDeserializationCallbackOnDeserializationRuns when the entire object graph has been deserialized. (Inherited from MajorObject.)
Explicit interface implemetationPrivate methodIFormattableToStringFormats the value of the current instance using the specified format. (Inherited from NamedComponent.)
Explicit interface implemetationPrivate methodIDeserializationStartCallback.OnDeserializationBeginRuns when the entire object graph starts to deserialized. (Inherited from MajorObject.)
Explicit interface implemetationPrivate propertyIHostableComponent.HostGets or sets the IServiceProvider that is the host of the ModelComponent. (Inherited from ModelComponent.)
Explicit interface implemetationPrivate propertyIMajorObject.BaseTypeGets the base type implementation of the mining model.
Explicit interface implemetationPrivate methodIMajorObject.CreateBodyCreates a new body for the mining model.
Explicit interface implemetationPrivate methodIMajorObject.DependsOnDetermines whether the mining model depends on an object.
Explicit interface implemetationPrivate propertyIMajorObject.ObjectReferenceGets the object reference implementation of the mining model.
Explicit interface implemetationPrivate propertyIMajorObject.ParentDatabaseGets the parent database implementation of the mining model.
Explicit interface implemetationPrivate propertyIMajorObject.ParentServerGets the parent server implementation of the mining model.
Explicit interface implemetationPrivate propertyIMajorObject.PathGets the path implementation of the mining model.
Explicit interface implemetationPrivate methodIMajorObject.WriteRefWrites a reference for the mining model.
Explicit interface implemetationPrivate propertyIModelComponent.FriendlyPathGets a friendly path for the ModelComponent. (Inherited from ModelComponent.)
Explicit interface implemetationPrivate propertyIModelComponent.OwningCollectionGets or sets the collection that owns the current object. (Inherited from ModelComponent.)
Explicit interface implemetationPrivate propertyIProcessable.LastProcessedGets or sets the DateTime on which the object was last processed. (Inherited from ProcessableMajorObject.)
Explicit interface implemetationPrivate propertyIProcessable.StateGets or sets the AnalysisState of this current instance. (Inherited from ProcessableMajorObject.)
Top

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.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Community Additions

ADD
Show:
© 2014 Microsoft