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
	MiningStructure()	Initializes a new instance of MiningStructure using the default values.
	MiningStructure(String)	Initializes a new instance of MiningStructure using a name.
	MiningStructure(String, String)	Initializes a new instance of MiningStructure using a name and an identifier.

Top

Properties

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

Top

Methods

	Name	Description
	AddToContainer	Infrastructure. (Inherited from ModelComponent.)
	AfterInsert	Infrastructure. (Inherited from ModelComponent.)
	AfterMove	Infrastructure. (Inherited from ModelComponent.)
	AfterRemove	Infrastructure. (Inherited from ModelComponent.)
	BeforeRemove	Infrastructure. (Inherited from ModelComponent.)
	CanProcess	Returns a Boolean value indicating whether the mining structure can be processed with the specified ProcessType parameter. (Overrides ProcessableMajorObject.CanProcess(ProcessType).)
	Clone()	Creates a new full copy of the MiningStructure object.
	Clone(Boolean)	Infrastructure. (Inherited from MajorObject.)
	CopyTo(MiningStructure)	Copies a MiningStructure to the specified object.
	CopyTo(ModelComponent)	Infrastructure. (Inherited from ModelComponent.)
	CopyTo(NamedComponent)	(Inherited from NamedComponent.)
	CopyTo(MajorObject, Boolean)	(Inherited from ProcessableMajorObject.)
	CreateMiningModel()
	CreateMiningModel(Boolean)	Create a mining model with a default name and optionally adds the model to the collection of models for the current structure.
	CreateMiningModel(Boolean, String)	Creates a mining model with the specified name and optionally adds the model to the collection of models for the structure.
	CreateObjRef	(Inherited from MarshalByRefObject.)
	Dispose()	(Inherited from Component.)
	Dispose(Boolean)	(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.)
	Finalize	(Inherited from Component.)
	GetCreateReferences	Infrastructure. (Inherited from MajorObject.)
	GetDependents	Infrastructure. (Inherited from MajorObject.)
	GetDropDependents	Infrastructure. (Inherited from MajorObject.)
	GetHashCode	(Inherited from Object.)
	GetLifetimeService	(Inherited from MarshalByRefObject.)
	GetReferences	Infrastructure. (Inherited from MajorObject.)
	GetService	(Inherited from Component.)
	GetType	(Inherited from Object.)
	GetUpdateOverwrites	Infrastructure. (Inherited from MajorObject.)
	InitializeLifetimeService	(Inherited from MarshalByRefObject.)
	MemberwiseClone()	(Inherited from Object.)
	MemberwiseClone(Boolean)	(Inherited from MarshalByRefObject.)
	Process()	(Inherited from ProcessableMajorObject.)
	Process(ProcessType)	(Inherited from ProcessableMajorObject.)
	Process(ProcessType, Binding)	(Inherited from ProcessableMajorObject.)
	Process(ProcessType, ErrorConfiguration)	(Inherited from ProcessableMajorObject.)
	Process(ProcessType, WriteBackTableCreation)	(Inherited from ProcessableMajorObject.)
	Process(ProcessType, ErrorConfiguration, XmlaWarningCollection)	(Inherited from ProcessableMajorObject.)
	Process(ProcessType, ErrorConfiguration, XmlaWarningCollection, ImpactDetailCollection)	(Inherited from ProcessableMajorObject.)
	Process(ProcessType, ErrorConfiguration, XmlaWarningCollection, ImpactDetailCollection, Boolean)	(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. (Inherited from ModelComponent.)
	Reset	(Inherited from NamedComponent.)
	Submit()	Infrastructure. (Inherited from ModelComponent.)
	Submit(Boolean)	Infrastructure. (Inherited from ModelComponent.)
	ToString	(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)	(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)	(Inherited from MajorObject.)
	Validate(ValidationErrorCollection, Boolean, ServerEdition)	Validates the current mining structure and returns a collection of validation errors. (Overrides NamedComponent.Validate(ValidationErrorCollection, Boolean, ServerEdition).)
	Validate(ValidationResultCollection, ValidationOptions, ServerEdition)	(Inherited from MajorObject.)

Top

Events

	Name	Description
	Disposed	(Inherited from Component.)

Top

Explicit Interface Implementations

	Name	Description
	ICloneable.Clone
	IDeserializationCallback.OnDeserialization	(Inherited from MajorObject.)
	IFormattable.ToString	(Inherited from NamedComponent.)
	IDeserializationStartCallback.OnDeserializationBegin	(Inherited from MajorObject.)
	IHostableComponent.Host	(Inherited from ModelComponent.)
	IMajorObject.BaseType
	IMajorObject.CreateBody
	IMajorObject.DependsOn
	IMajorObject.ObjectReference
	IMajorObject.ParentDatabase
	IMajorObject.ParentServer
	IMajorObject.Path
	IMajorObject.WriteRef
	IModelComponent.FriendlyPath	(Inherited from ModelComponent.)
	IModelComponent.OwningCollection	(Inherited from ModelComponent.)
	IProcessable.LastProcessed	(Inherited from ProcessableMajorObject.)
	IProcessable.State	(Inherited from ProcessableMajorObject.)

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.

See Also

Reference

Microsoft.AnalysisServices Namespace