MiningStructure 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 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[<System.Runtime.InteropServices.Guid("EEF145A8-5946-492d-9422-032C1178B04F")>]
type MiningStructure = class
inherit ProcessableMajorObject
interface IMajorObject
interface INamedComponent
interface IModelComponent
interface IComponent
interface IDisposable
interface ICloneablePublic 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() |
Initializes a new instance of MiningStructure using the default values. |
| MiningStructure(String, String) |
Initializes a new instance of MiningStructure using the specified name and identifier. |
| MiningStructure(String) |
Initializes a new instance of MiningStructure 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
| Annotations |
Gets the collection of all annotations associated with the major object. (Inherited from MajorObject) |
| CacheMode |
Gets or sets the caching mechanism used for training data retrieved while processing a mining structure. |
| 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. |
| 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 the description of major object. (Inherited from MajorObject) |
| ErrorConfiguration |
Gets or sets the settings for handling errors that can occur when the MiningStructure is processed. |
| FilterComponent |
Gets or sets an MDX expression that defines the slice of the source cube that is used for the mining structure. |
| FriendlyName |
Gets a user-friendly name for the component. (Inherited from NamedComponent) |
| 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 |
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 |
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 used by the MiningStructure. |
| 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) |
| MiningModels |
Gets the collection of models associated with a MiningStructure. |
| MiningStructurePermissions |
Gets or sets the collection of permissions on a MiningStructure 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 Database object of the MiningStructure object. |
| ParentServer |
Gets the parent Server object of the MiningStructure 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) |
| Source |
Gets or sets the source of data to which MiningStructure is bound. |
| State |
Gets or sets the AnalysisState of this current instance. (Inherited from ProcessableMajorObject) |
| Translations |
Gets the collection of Translation objects associated with a MiningStructure. |
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 structure can be processed with the specified ProcessType parameter. |
| 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(MiningStructure) |
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) |
| CreateMiningModel() |
Creates a child mining model object within the mining 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. |
| CreateMiningModel(Boolean) |
Create a mining model with a default name and optionally adds the model to the collection of models for the current structure. |
| 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) |
| 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) |
Validates the current mining structure and returns a collection of validation errors. |
| 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) |