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 | |
|---|---|---|
.gif "Public method") |
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 | |
|---|---|---|
.gif "Public property") |
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. |
|
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.) |
|
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. |
.gif "Protected property") |
FriendlyName | Returns a user-friendly name. (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 | Infrastructure. Gets a value that indicates whether MajorObject have been loaded. (Inherited from MajorObject.) |
|
KeyForCollection | Returns the key used in collections. (Inherited from NamedComponent.) |
|
Language | Gets or sets the language identifier of 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 MiningModel objects 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 Database object that is the parent of the MiningStructure. |
|
ParentServer | Gets the Server object that is the parent of the MiningStructure. |
|
Site | Infrastructure. Gets or sets the site of the component. (Inherited from NamedComponent.) |
|
SiteID | Infrastructure. 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. |
Top
Methods
| Name | Description | |
|---|---|---|
.gif "Protected method") |
AddToContainer | Infrastructure. Adds a ModelComponent object to the specified container. (Inherited from ModelComponent.) |
|
AfterInsert | Infrastructure. Displays a ModelComponent object after added to the specified index. (Inherited from ModelComponent.) |
|
AfterMove | Infrastructure. Displays a ModelComponent object after moving to the specified index. (Inherited from ModelComponent.) |
|
AfterRemove | Infrastructure. Displays a ModelComponentCollection after a ModelComponent object is removed. (Inherited from ModelComponent.) |
|
BeforeRemove | Infrastructure. Removes the ModelComponent object before the cleanup. (Inherited from ModelComponent.) |
|
CanProcess | Indicates 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. Creates a new copy of the MajorObject object. (Inherited from MajorObject.) |
|
CopyTo(MiningStructure) | Copies the content of the object to another object (the destination). |
|
CopyTo(MajorObject, Boolean) | Copies the object to the specified destination. (Inherited from ProcessableMajorObject.) |
|
CreateMiningModel() | Creates a child mining model object within the mining 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. |
|
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 | Security Critical. (Inherited from MarshalByRefObject.) |
|
Dispose | (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.) |
|
GetCreateReferences | Infrastructure. Gets a Hashtable to create references. (Inherited from MajorObject.) |
|
GetDependents | Infrastructure. Gets the dependents to the specified Hashtable. (Inherited from MajorObject.) |
|
GetDropDependents | Infrastructure. Gets the drop dependents. (Inherited from MajorObject.) |
|
GetHashCode | (Inherited from Object.) |
|
GetLifetimeService | Security Critical. (Inherited from MarshalByRefObject.) |
|
GetReferences | Infrastructure. Gets the objects that the MajorObject references. (Inherited from MajorObject.) |
|
GetType | (Inherited from Object.) |
|
GetUpdateOverwrites | Infrastructure. Gets the Hashtable object that overwrites the updated MajorObject. (Inherited from MajorObject.) |
|
InitializeLifetimeService | Security Critical. (Inherited from MarshalByRefObject.) |
|
Process() | Processes the ProcessableMajorObject. (Inherited from ProcessableMajorObject.) |
|
Process(ProcessType) | Processes the ProcessableMajorObject with the specified process type. (Inherited from ProcessableMajorObject.) |
|
Process(ProcessType, Binding) | Processes the ProcessableMajorObject with the specified process type. (Inherited from ProcessableMajorObject.) |
|
Process(ProcessType, ErrorConfiguration) | Processes the ProcessableMajorObject with the specified process type. (Inherited from ProcessableMajorObject.) |
|
Process(ProcessType, WriteBackTableCreation) | Processes the ProcessableMajorObject with the specified process type and writeback option. (Inherited from ProcessableMajorObject.) |
|
Process(ProcessType, ErrorConfiguration, XmlaWarningCollection) | Processes the ProcessableMajorObject with the specified process type. (Inherited from ProcessableMajorObject.) |
|
Process(ProcessType, ErrorConfiguration, XmlaWarningCollection, ImpactDetailCollection) | Processes the ProcessableMajorObject with the specified process type. (Inherited from ProcessableMajorObject.) |
|
Process(ProcessType, ErrorConfiguration, XmlaWarningCollection, ImpactDetailCollection, Boolean) | Processes the ProcessableMajorObject with the specified process type. (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. Removes a ModelComponent object from the specified container. (Inherited from ModelComponent.) |
|
Submit() | Infrastructure. Submits a ModelComponent object. (Inherited from ModelComponent.) |
|
Submit(Boolean) | Infrastructure. Submits a ModelComponent object. (Inherited from ModelComponent.) |
|
ToString | Returns a string containing the name of the 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) | 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) | Indicates whether the MajorObject is valid. (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) | Indicates whether the MajorObject is valid. (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) | Indicates whether the MajorObject is valid. (Inherited from MajorObject.) |
Top
Events
| Name | Description | |
|---|---|---|
.gif "Public event") |
Disposed | (Inherited from Component.) |
Top
Explicit Interface Implementations
| Name | Description | |
|---|---|---|
.gif "Explicit interface implemetation") .gif "Private method") |
ICloneable.Clone | Returns the Clone implementation of the mining structure. |
|
IDeserializationCallback.OnDeserialization | Runs when the entire object graph has been deserialized. (Inherited from MajorObject.) |
|
IFormattable.ToString | Formats the value of the current instance using the specified format. (Inherited from NamedComponent.) |
|
IDeserializationStartCallback.OnDeserializationBegin | Runs when the entire object graph starts to deserialized. (Inherited from MajorObject.) |
.gif "Private property") |
IHostableComponent.Host | Gets or sets the IServiceProvider that is the host of the ModelComponent. (Inherited from ModelComponent.) |
|
IMajorObject.BaseType | Gets the base type implementation of the mining structure. |
|
IMajorObject.CreateBody | Returns the CreateBody implementation of the mining structure. |
|
IMajorObject.DependsOn | Returns the DependsOn implementation of the mining structure. |
|
IMajorObject.ObjectReference | Gets the object reference implementation of the mining structure. |
|
IMajorObject.ParentDatabase | Gets the parent database implementation of the mining structure. |
|
IMajorObject.ParentServer | Gets the parent server implementation of the mining structure. |
|
IMajorObject.Path | Gets the path implementation of the mining structure. |
|
IMajorObject.WriteRef | Returns the WriteRef implementation of the mining structure. |
|
IModelComponent.FriendlyPath | Gets a friendly path for the ModelComponent. (Inherited from ModelComponent.) |
|
IModelComponent.OwningCollection | Gets or sets the collection that owns the current object. (Inherited from ModelComponent.) |
|
IProcessable.LastProcessed | Gets or sets the DateTime on which the object was last processed. (Inherited from ProcessableMajorObject.) |
|
IProcessable.State | Gets or sets the AnalysisState of this current instance. (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.