• Article

MiningStructure Class

Defines the structure for one or more mining models. A structure includes columns, bindings, and optional holdout partition. 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.MiningStructure

Namespace:  Microsoft.AnalysisServices
Assembly:  Microsoft.AnalysisServices (in Microsoft.AnalysisServices.dll)

Syntax

'Declaration
<GuidAttribute("EEF145A8-5946-492d-9422-032C1178B04F")> _
Public NotInheritable Class MiningStructure _
    Inherits ProcessableMajorObject _
    Implements IMajorObject, INamedComponent, IModelComponent, IComponent,  _
    IDisposable, ICloneable
'Usage
Dim instance As MiningStructure

[GuidAttribute("EEF145A8-5946-492d-9422-032C1178B04F")]
public sealed class MiningStructure : ProcessableMajorObject, 
    IMajorObject, INamedComponent, IModelComponent, IComponent, IDisposable, 
    ICloneable

[GuidAttribute(L"EEF145A8-5946-492d-9422-032C1178B04F")]
public ref class MiningStructure sealed : public ProcessableMajorObject, 
    IMajorObject, INamedComponent, IModelComponent, IComponent, IDisposable, 
    ICloneable

[<SealedAttribute>]
[<GuidAttribute("EEF145A8-5946-492d-9422-032C1178B04F")>]
type MiningStructure =  
    class
        inherit ProcessableMajorObject
        interface IMajorObject
        interface INamedComponent
        interface IModelComponent
        interface IComponent
        interface IDisposable
        interface ICloneable
    end

public final class MiningStructure extends ProcessableMajorObject implements IMajorObject, INamedComponent, IModelComponent, IComponent, IDisposable, ICloneable

The MiningStructure type exposes the following members.

Constructors

  Name Description
Public method MiningStructure() Initializes a new instance of MiningStructure using the default values.
Public method MiningStructure(String) Initializes a new instance of MiningStructure using a name.
Public method MiningStructure(String, String) Initializes a new instance of MiningStructure using a name and an identifier.

Top

Properties

  Name Description
Public property Annotations Gets the collection object of all annotations to current object. (Inherited from MajorObject.)
Public property CacheMode Gets or sets the caching mechanism used for training data retrieved while processing a mining structure.
Protected property CanRaiseEvents (Inherited from Component.)
Public property CaseTableName Gets or sets the name of the case table that is associated with the MiningStructure object.
Public property Collation Gets or sets the collation used by MiningStructure.
Public property Columns Gets the collection of columns associated with a MiningStructure.
Public property Container (Inherited from Component.)
Public property CreatedTimestamp Gets or sets the date and time of the creation of the object. (Inherited from MajorObject.)
Public property DataSource Gets the DataSource object that is associated with a MiningStructure.
Public property DataSourceView Gets the DataSourceView object that is associated with a MiningStructure.
Public property Description Gets or sets a description string of current object. (Inherited from MajorObject.)
Protected property DesignMode (Inherited from Component.)
Public property ErrorConfiguration Gets or sets the settings for handling errors that can occur when the MiningStructure is processed.
Protected property Events (Inherited from Component.)
Public property FilterComponent Gets or sets an MDX expression that defines the slice of the source cube that is used for the mining structure.
Protected property FriendlyName (Inherited from NamedComponent.)
Public property HoldoutActualSize Returns the size of the holdout partition that is associated with a MiningStructure. This value is read-only and is not available until the MiningStructure has been processed.
Public property HoldoutMaxCases Gets or sets the maximum number of cases in the partition of the MiningStructure that contains testing data.
Public property HoldoutMaxPercent Gets or sets the percentage of cases in the source data of the MiningStructure that are used for testing.
Public property HoldoutSeed Gets or sets the seed used to initialize partitioning of the MiningStructure into training and testing data sets[.]
Public property ID (Inherited from NamedComponent.)
Public property IsLoaded Infrastructure. (Inherited from MajorObject.)
Protected property KeyForCollection (Inherited from NamedComponent.)
Public property Language Gets or sets the language identifier of MiningStructure.
Public property LastProcessed (Inherited from ProcessableMajorObject.)
Public property LastSchemaUpdate Gets or sets the date and time when current object schema was last updated. (Inherited from MajorObject.)
Public property MiningModels Gets the collection of MiningModel objects associated with a MiningStructure.
Public property MiningStructurePermissions Gets or sets the collection of permissions on a MiningStructure object.
Public property Name (Inherited from NamedComponent.)
Public property OwningCollection Gets or sets the collection that contains the ModelComponent. (Inherited from ModelComponent.)
Public property Parent Gets the Database object that is the parent of the MiningStructure.
Public property ParentServer Gets the Server object that is the parent of the MiningStructure.
Public property Site (Inherited from NamedComponent.)
Public property SiteID (Inherited from NamedComponent.)
Public property Source Gets or sets the source of data to which MiningStructure is bound.
Public property State (Inherited from ProcessableMajorObject.)
Public property Translations Gets the collection of Translation objects associated with a MiningStructure.

Top

Methods

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

Top

Events

  Name Description
Public event Disposed (Inherited from Component.)

Top

Remarks

Many mining models can be defined that use the same structure.

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.