MiningStructure MiningStructure MiningStructure Class

Definition

Defines the structure for one or more mining models. A structure includes columns, bindings, and optional holdout partition. This class cannot be inherited.

[System.Runtime.InteropServices.Guid("EEF145A8-5946-492d-9422-032C1178B04F")]
public sealed class MiningStructure : Microsoft.AnalysisServices.ProcessableMajorObject, ICloneable, IDisposable, Microsoft.AnalysisServices.IMajorObject
type MiningStructure = class
    inherit ProcessableMajorObject
    interface IMajorObject
    interface INamedComponent
    interface IModelComponent
    interface IComponent
    interface IDisposable
    interface ICloneable
Public NotInheritable Class MiningStructure
Inherits ProcessableMajorObject
Implements ICloneable, IDisposable, IMajorObject
Inheritance
Attributes
Implements

Remarks

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

Constructors

MiningStructure() MiningStructure() MiningStructure()

Initializes a new instance of MiningStructure using the default values.

MiningStructure(String) MiningStructure(String) MiningStructure(String)

Initializes a new instance of MiningStructure using the specified name.

MiningStructure(String, String) MiningStructure(String, String) MiningStructure(String, String)

Initializes a new instance of MiningStructure using the specified name and identifier.

Properties

Annotations Annotations Annotations

Gets the collection of all annotations associated with the major object.

(Inherited from MajorObject)
CacheMode CacheMode CacheMode

Gets or sets the caching mechanism used for training data retrieved while processing a mining structure.

CaseTableName CaseTableName CaseTableName

Gets or sets the name of the case table that is associated with the MiningStructure object.

Collation Collation Collation

Gets or sets the collation used by MiningStructure.

Columns Columns Columns

Gets the collection of columns associated with a MiningStructure.

CreatedTimestamp CreatedTimestamp CreatedTimestamp

Gets or sets the date and time of the creation of the object.

(Inherited from MajorObject)
DataSource DataSource DataSource

Gets the DataSource object that is associated with a MiningStructure.

DataSourceView DataSourceView DataSourceView

Gets the DataSourceView object that is associated with a MiningStructure.

Description Description Description

Gets or sets the description of major object.

(Inherited from MajorObject)
ErrorConfiguration ErrorConfiguration ErrorConfiguration

Gets or sets the settings for handling errors that can occur when the MiningStructure is processed.

FilterComponent FilterComponent FilterComponent

Gets or sets an MDX expression that defines the slice of the source cube that is used for the mining structure.

FriendlyName FriendlyName FriendlyName

Gets a user-friendly name for the component.

(Inherited from NamedComponent)
HoldoutActualSize HoldoutActualSize HoldoutActualSize

Gets or sets 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 HoldoutMaxCases HoldoutMaxCases

Gets or sets the maximum number of cases in the partition of the MiningStructure that contains testing data.

HoldoutMaxPercent HoldoutMaxPercent HoldoutMaxPercent

Gets or sets the percentage of cases in the source data of the MiningStructure that are used for testing.

HoldoutSeed HoldoutSeed HoldoutSeed

Gets or sets the seed used to initialize partitioning of the MiningStructure into training and testing data sets.

ID ID ID

Gets or sets the identifier of the component.

(Inherited from NamedComponent)
IHostableComponent.Host IHostableComponent.Host IHostableComponent.Host Inherited from ModelComponent
IModelComponent.FriendlyPath IModelComponent.FriendlyPath IModelComponent.FriendlyPath Inherited from ModelComponent
IModelComponent.OwningCollection IModelComponent.OwningCollection IModelComponent.OwningCollection Inherited from ModelComponent
IProcessable.LastProcessed IProcessable.LastProcessed IProcessable.LastProcessed Inherited from ProcessableMajorObject
IProcessable.State IProcessable.State IProcessable.State Inherited from ProcessableMajorObject
IsLoaded IsLoaded IsLoaded

Gets a value that indicates whether MajorObject have been loaded.

(Inherited from MajorObject)
KeyForCollection KeyForCollection KeyForCollection

Gets the key used in collections.

(Inherited from NamedComponent)
Language Language Language

Gets or sets the language used by the MiningStructure.

LastProcessed LastProcessed LastProcessed

Gets or sets the DateTime on which the object was last processed.

(Inherited from ProcessableMajorObject)
LastSchemaUpdate LastSchemaUpdate LastSchemaUpdate

Gets or sets the date and time when current object schema was last updated.

(Inherited from MajorObject)
MiningModels MiningModels MiningModels

Gets the collection of models associated with a MiningStructure.

MiningStructurePermissions MiningStructurePermissions MiningStructurePermissions

Gets or sets the collection of permissions on a MiningStructure object.

Name Name Name

Gets or sets the name of the component.

(Inherited from NamedComponent)
OwningCollection OwningCollection OwningCollection

Gets or sets the collection that contains the ModelComponent.

(Inherited from ModelComponent)
Parent Parent Parent

Gets the parent Database object of the MiningStructure object.

ParentServer ParentServer ParentServer

Gets the parent Server object of the MiningStructure object.

Site Site Site

Gets or sets the site associated with the component.

(Inherited from NamedComponent)
SiteID SiteID SiteID

Gets or sets the identifier for the site associated with the component.

(Inherited from NamedComponent)
Source Source Source

Gets or sets the source of data to which MiningStructure is bound.

State State State

Gets or sets the AnalysisState of this current instance.

(Inherited from ProcessableMajorObject)
Translations Translations Translations

Gets the collection of Translation objects associated with a MiningStructure.

Methods

AddToContainer(IContainer) AddToContainer(IContainer) AddToContainer(IContainer)

Adds the ModelComponent object to the specified container.

(Inherited from ModelComponent)
AfterInsert(Int32) AfterInsert(Int32) AfterInsert(Int32)

Displays a ModelComponent object after added to the specified index.

(Inherited from ModelComponent)
AfterMove(Int32, Int32) AfterMove(Int32, Int32) AfterMove(Int32, Int32)

Displays a ModelComponent object after moving to the specified index.

(Inherited from ModelComponent)
AfterRemove(ModelComponentCollection) AfterRemove(ModelComponentCollection) AfterRemove(ModelComponentCollection)

Displays a ModelComponentCollection after a ModelComponent object is removed.

(Inherited from ModelComponent)
BeforeRemove(Boolean) BeforeRemove(Boolean) BeforeRemove(Boolean)

Removes the ModelComponent object before the cleanup.

(Inherited from ModelComponent)
CanProcess(ProcessType) CanProcess(ProcessType) CanProcess(ProcessType)

Indicates whether the mining structure can be processed with the specified ProcessType parameter.

Clone() Clone() Clone()

Returns a clone of the object.

Clone(Boolean) Clone(Boolean) Clone(Boolean)

Creates a new copy of the MajorObject object.

(Inherited from MajorObject)
CopyTo(MajorObject, Boolean) CopyTo(MajorObject, Boolean) CopyTo(MajorObject, Boolean)

Copies the object to the specified destination.

(Inherited from ProcessableMajorObject)
CopyTo(MiningStructure) CopyTo(MiningStructure) CopyTo(MiningStructure)

Copies the content of this object to another object (the destination).

CopyTo(ModelComponent) CopyTo(ModelComponent) CopyTo(ModelComponent)

Copies a ModelComponent object to the specified object.

(Inherited from ModelComponent)
CopyTo(NamedComponent) CopyTo(NamedComponent) CopyTo(NamedComponent)

Copies a NamedComponent object to the specified object.

(Inherited from NamedComponent)
CreateMiningModel() CreateMiningModel() CreateMiningModel()

Creates a child mining model object within the mining structure.

CreateMiningModel(Boolean) CreateMiningModel(Boolean) 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) CreateMiningModel(Boolean, String) CreateMiningModel(Boolean, String)

Creates a mining model with the specified name and optionally adds the model to the collection of models for the structure.

Drop() Drop() Drop()

Removes current object and updates server.

(Inherited from MajorObject)
Drop(DropOptions) Drop(DropOptions) Drop(DropOptions)

Removes current object and updates server using specified options.

(Inherited from MajorObject)
Drop(DropOptions, XmlaWarningCollection) Drop(DropOptions, XmlaWarningCollection) 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) Drop(DropOptions, XmlaWarningCollection, ImpactDetailCollection) 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) Drop(DropOptions, XmlaWarningCollection, ImpactDetailCollection, Boolean) 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)
GetCreateReferences(Hashtable, Boolean, Boolean) GetCreateReferences(Hashtable, Boolean, Boolean) GetCreateReferences(Hashtable, Boolean, Boolean)

Gets a Hashtable to create references.

(Inherited from MajorObject)
GetDependents(Hashtable) GetDependents(Hashtable) GetDependents(Hashtable)

Gets the dependents to the specified Hashtable.

(Inherited from MajorObject)
GetDropDependents(Hashtable, Hashtable) GetDropDependents(Hashtable, Hashtable) GetDropDependents(Hashtable, Hashtable)

Gets the drop dependents.

(Inherited from MajorObject)
GetReferences(Hashtable, Boolean) GetReferences(Hashtable, Boolean) GetReferences(Hashtable, Boolean)

Gets the objects that the MajorObject references.

(Inherited from MajorObject)
GetUpdateOverwrites(Boolean) GetUpdateOverwrites(Boolean) GetUpdateOverwrites(Boolean)

Gets the Hashtable object that overwrites the updated MajorObject.

(Inherited from MajorObject)
Process() Process() Process()

Processes the ProcessableMajorObject.

(Inherited from ProcessableMajorObject)
Process(ProcessType) Process(ProcessType) Process(ProcessType)

Processes the ProcessableMajorObject with the specified process type.

(Inherited from ProcessableMajorObject)
Process(ProcessType, ErrorConfiguration) Process(ProcessType, ErrorConfiguration) Process(ProcessType, ErrorConfiguration)

Processes the ProcessableMajorObject with the specified process type and error handling configuration.

(Inherited from ProcessableMajorObject)
Process(ProcessType, ErrorConfiguration, XmlaWarningCollection) Process(ProcessType, ErrorConfiguration, XmlaWarningCollection) Process(ProcessType, ErrorConfiguration, XmlaWarningCollection)

Processes the ProcessableMajorObject with the specified process type, error handling configuration and warnings.

(Inherited from ProcessableMajorObject)
Process(ProcessType, ErrorConfiguration, XmlaWarningCollection, ImpactDetailCollection) Process(ProcessType, ErrorConfiguration, XmlaWarningCollection, ImpactDetailCollection) 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, ImpactDetailCollection, Boolean) Process(ProcessType, ErrorConfiguration, XmlaWarningCollection, ImpactDetailCollection, Boolean) 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, IBinding) Process(ProcessType, IBinding) Process(ProcessType, IBinding)

Processes the ProcessableMajorObject with the specified process type and binding.

(Inherited from ProcessableMajorObject)
Process(ProcessType, WriteBackTableCreation) Process(ProcessType, WriteBackTableCreation) Process(ProcessType, WriteBackTableCreation)

Processes the ProcessableMajorObject with the specified process type and writeback option.

(Inherited from ProcessableMajorObject)
Refresh() Refresh() Refresh()

Updates the object from server definitions.

(Inherited from MajorObject)
Refresh(Boolean) Refresh(Boolean) Refresh(Boolean)

Updates the object from server definitions, as well as loaded dependent objects [if specified].

(Inherited from MajorObject)
Refresh(Boolean, RefreshType) Refresh(Boolean, RefreshType) Refresh(Boolean, RefreshType)

Updates the object from server definitions, as well as loaded dependent objects [if specified].

(Inherited from MajorObject)
RemoveFromContainer(IContainer) RemoveFromContainer(IContainer) RemoveFromContainer(IContainer)

Removes the ModelComponent object from the specified container.

(Inherited from ModelComponent)
Reset() Reset() Reset()

Resets the component to its initial state.

(Inherited from NamedComponent)
Submit() Submit() Submit()

Submits a ModelComponent object.

(Inherited from ModelComponent)
Submit(Boolean) Submit(Boolean) Submit(Boolean)

Submits a ModelComponent object.

(Inherited from ModelComponent)
ToString() ToString() ToString()

Returns a string representing the named-component.

(Inherited from NamedComponent)
Update() Update() Update()

Updates server definition of current object to actual values using the default values to update dependent objects.

(Inherited from MajorObject)
Update(UpdateOptions) Update(UpdateOptions) 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) Update(UpdateOptions, UpdateMode) 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) Update(UpdateOptions, UpdateMode, XmlaWarningCollection) 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) Update(UpdateOptions, UpdateMode, XmlaWarningCollection, ImpactDetailCollection) 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) Update(UpdateOptions, UpdateMode, XmlaWarningCollection, ImpactDetailCollection, Boolean) 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) Validate(ValidationErrorCollection) Validate(ValidationErrorCollection)

Validates the element to which it is appended; returns any errors encountered in a collection.

(Inherited from ModelComponent)
Validate(ValidationErrorCollection, Boolean) Validate(ValidationErrorCollection, Boolean) 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, Boolean, ServerEdition) Validate(ValidationErrorCollection, Boolean, ServerEdition) Validate(ValidationErrorCollection, Boolean, ServerEdition)

Validates the current mining structure and returns a collection of validation errors.

Validate(ValidationResultCollection) Validate(ValidationResultCollection) Validate(ValidationResultCollection)

Indicates whether the MajorObject is valid.

(Inherited from MajorObject)
Validate(ValidationResultCollection, ValidationOptions) Validate(ValidationResultCollection, ValidationOptions) Validate(ValidationResultCollection, ValidationOptions)

Indicates whether the MajorObject is valid.

(Inherited from MajorObject)
Validate(ValidationResultCollection, ValidationOptions, ServerEdition) Validate(ValidationResultCollection, ValidationOptions, ServerEdition) Validate(ValidationResultCollection, ValidationOptions, ServerEdition)

Indicates whether the MajorObject is valid.

(Inherited from MajorObject)

Explicit Interface Implementations

ICloneable.Clone() ICloneable.Clone() ICloneable.Clone()
IDeserializationCallback.OnDeserialization(Object) IDeserializationCallback.OnDeserialization(Object) IDeserializationCallback.OnDeserialization(Object) Inherited from MajorObject
IDeserializationStartCallback.OnDeserializationBegin(Object) IDeserializationStartCallback.OnDeserializationBegin(Object) IDeserializationStartCallback.OnDeserializationBegin(Object) Inherited from MajorObject
IFormattable.ToString(String, IFormatProvider) IFormattable.ToString(String, IFormatProvider) IFormattable.ToString(String, IFormatProvider) Inherited from NamedComponent
IMajorObject.BaseType IMajorObject.BaseType IMajorObject.BaseType
IMajorObject.CreateBody() IMajorObject.CreateBody() IMajorObject.CreateBody()
IMajorObject.DependsOn(IMajorObject) IMajorObject.DependsOn(IMajorObject) IMajorObject.DependsOn(IMajorObject)
IMajorObject.ObjectReference IMajorObject.ObjectReference IMajorObject.ObjectReference
IMajorObject.ParentDatabase IMajorObject.ParentDatabase IMajorObject.ParentDatabase
IMajorObject.ParentServer IMajorObject.ParentServer IMajorObject.ParentServer
IMajorObject.Path IMajorObject.Path IMajorObject.Path
IMajorObject.WriteRef(XmlWriter) IMajorObject.WriteRef(XmlWriter) IMajorObject.WriteRef(XmlWriter)

Fields

MaxIDLength MaxIDLength MaxIDLength

Specifies the maximum length of the identifier.

(Inherited from NamedComponent)
MaxNameLength MaxNameLength MaxNameLength

Specifies the maximum length of the name.

(Inherited from NamedComponent)

Applies to