Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

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.

Namespace:  Microsoft.AnalysisServices
Assembly:  Microsoft.AnalysisServices (in Microsoft.AnalysisServices.dll)
[GuidAttribute("EEF145A8-5946-492d-9422-032C1178B04F")]
public sealed class MiningStructure : ProcessableMajorObject, 
	IMajorObject, INamedComponent, IModelComponent, IComponent, IDisposable, 
	ICloneable

The MiningStructure type exposes the following members.

  NameDescription
Public methodMiningStructure()Initializes a new instance of MiningStructure using the default values.
Public methodMiningStructure(String)Initializes a new instance of MiningStructure using a name.
Public methodMiningStructure(String, String)Initializes a new instance of MiningStructure using a name and an identifier.
Top
  NameDescription
Public propertyAnnotationsGets the collection object of all annotations to current object. (Inherited from MajorObject.)
Public propertyCacheModeGets or sets the caching mechanism used for training data retrieved while processing a mining structure.
Public propertyCaseTableNameGets or sets the name of the case table that is associated with the MiningStructure object.
Public propertyCollationGets or sets the collation used by MiningStructure.
Public propertyColumnsGets the collection of columns associated with a MiningStructure.
Public propertyContainer (Inherited from Component.)
Public propertyCreatedTimestampGets or sets the date and time of the creation of the object. (Inherited from MajorObject.)
Public propertyDataSourceGets the DataSource object that is associated with a MiningStructure.
Public propertyDataSourceViewGets the DataSourceView object that is associated with a MiningStructure.
Public propertyDescriptionGets or sets a description string of current object. (Inherited from MajorObject.)
Public propertyErrorConfigurationGets or sets the settings for handling errors that can occur when the MiningStructure is processed.
Public propertyFilterComponentGets or sets an MDX expression that defines the slice of the source cube that is used for the mining structure.
Protected propertyFriendlyNameReturns a user-friendly name. (Inherited from NamedComponent.)
Public propertyHoldoutActualSizeGets 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.
Public propertyHoldoutMaxCasesGets or sets the maximum number of cases in the partition of the MiningStructure that contains testing data.
Public propertyHoldoutMaxPercentGets or sets the percentage of cases in the source data of the MiningStructure that are used for testing.
Public propertyHoldoutSeedGets or sets the seed used to initialize partitioning of the MiningStructure into training and testing data sets.
Public propertyIDGets or sets the identifier of the component. (Inherited from NamedComponent.)
Public propertyIsLoadedInfrastructure. Gets a value that indicates whether MajorObject have been loaded. (Inherited from MajorObject.)
Protected propertyKeyForCollectionReturns the key used in collections. (Inherited from NamedComponent.)
Public propertyLanguageGets or sets the language identifier of MiningStructure.
Public propertyLastProcessedGets or sets the DateTime on which the object was last processed. (Inherited from ProcessableMajorObject.)
Public propertyLastSchemaUpdateGets or sets the date and time when current object schema was last updated. (Inherited from MajorObject.)
Public propertyMiningModelsGets the collection of MiningModel objects associated with a MiningStructure.
Public propertyMiningStructurePermissionsGets or sets the collection of permissions on a MiningStructure object.
Public propertyNameGets or sets the name of the component. (Inherited from NamedComponent.)
Public propertyOwningCollectionGets or sets the collection that contains the ModelComponent. (Inherited from ModelComponent.)
Public propertyParentGets the Database object that is the parent of the MiningStructure.
Public propertyParentServerGets the Server object that is the parent of the MiningStructure.
Public propertySiteInfrastructure. Gets or sets the site of the component. (Inherited from NamedComponent.)
Public propertySiteIDInfrastructure. Gets or sets the identifier for the site associated with the component. (Inherited from NamedComponent.)
Public propertySourceGets or sets the source of data to which MiningStructure is bound.
Public propertyStateGets or sets the AnalysisState of this current instance. (Inherited from ProcessableMajorObject.)
Public propertyTranslationsGets the collection of Translation objects associated with a MiningStructure.
Top
  NameDescription
Protected methodAddToContainerInfrastructure. Adds a ModelComponent object to the specified container. (Inherited from ModelComponent.)
Protected methodAfterInsertInfrastructure. Displays a ModelComponent object after added to the specified index. (Inherited from ModelComponent.)
Protected methodAfterMoveInfrastructure. Displays a ModelComponent object after moving to the specified index. (Inherited from ModelComponent.)
Protected methodAfterRemoveInfrastructure. Displays a ModelComponentCollection after a ModelComponent object is removed. (Inherited from ModelComponent.)
Protected methodBeforeRemoveInfrastructure. Removes the ModelComponent object before the cleanup. (Inherited from ModelComponent.)
Public methodCanProcessIndicates whether the mining structure can be processed with the specified ProcessType parameter. (Overrides ProcessableMajorObject.CanProcess(ProcessType).)
Public methodClone()Creates a new full copy of the MiningStructure object.
Protected methodClone(Boolean)Infrastructure. Creates a new copy of the MajorObject object. (Inherited from MajorObject.)
Public methodCopyTo(MiningStructure)Copies the content of the object to another object (the destination).
Protected methodCopyTo(MajorObject, Boolean)Copies the object to the specified destination. (Inherited from ProcessableMajorObject.)
Public methodCreateMiningModel()Creates a child mining model object within the mining structure.
Public methodCreateMiningModel(Boolean)Create a mining model with a default name and optionally adds the model to the collection of models for the current structure.
Public methodCreateMiningModel(Boolean, String)Creates a mining model with the specified name and optionally adds the model to the collection of models for the structure.
Public methodCreateObjRefSecurity Critical. (Inherited from MarshalByRefObject.)
Public methodDispose (Inherited from Component.)
Public methodDrop()Removes current object and updates server. (Inherited from MajorObject.)
Public methodDrop(DropOptions)Removes current object and updates server using specified options. (Inherited from MajorObject.)
Public methodDrop(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 methodDrop(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 methodDrop(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 methodEquals (Inherited from Object.)
Protected methodGetCreateReferencesInfrastructure. Gets a Hashtable to create references. (Inherited from MajorObject.)
Public methodGetDependentsInfrastructure. Gets the dependents to the specified Hashtable. (Inherited from MajorObject.)
Protected methodGetDropDependentsInfrastructure. Gets the drop dependents. (Inherited from MajorObject.)
Public methodGetHashCode (Inherited from Object.)
Public methodGetLifetimeServiceSecurity Critical. (Inherited from MarshalByRefObject.)
Public methodGetReferencesInfrastructure. Gets the objects that the MajorObject references. (Inherited from MajorObject.)
Public methodGetType (Inherited from Object.)
Public methodGetUpdateOverwritesInfrastructure. Gets the Hashtable object that overwrites the updated MajorObject. (Inherited from MajorObject.)
Public methodInitializeLifetimeServiceSecurity Critical. (Inherited from MarshalByRefObject.)
Public methodProcess()Processes the ProcessableMajorObject. (Inherited from ProcessableMajorObject.)
Public methodProcess(ProcessType)Processes the ProcessableMajorObject with the specified process type. (Inherited from ProcessableMajorObject.)
Public methodProcess(ProcessType, Binding)Processes the ProcessableMajorObject with the specified process type. (Inherited from ProcessableMajorObject.)
Public methodProcess(ProcessType, ErrorConfiguration)Processes the ProcessableMajorObject with the specified process type. (Inherited from ProcessableMajorObject.)
Public methodProcess(ProcessType, WriteBackTableCreation)Processes the ProcessableMajorObject with the specified process type and writeback option. (Inherited from ProcessableMajorObject.)
Public methodProcess(ProcessType, ErrorConfiguration, XmlaWarningCollection)Processes the ProcessableMajorObject with the specified process type. (Inherited from ProcessableMajorObject.)
Public methodProcess(ProcessType, ErrorConfiguration, XmlaWarningCollection, ImpactDetailCollection)Processes the ProcessableMajorObject with the specified process type. (Inherited from ProcessableMajorObject.)
Public methodProcess(ProcessType, ErrorConfiguration, XmlaWarningCollection, ImpactDetailCollection, Boolean)Processes the ProcessableMajorObject with the specified process type. (Inherited from ProcessableMajorObject.)
Public methodRefresh()Updates current object from server definitions. (Inherited from MajorObject.)
Public methodRefresh(Boolean)Updates current object from server definitions and loaded dependent objects if specified. (Inherited from MajorObject.)
Public methodRefresh(Boolean, RefreshType)Updates current object from server definitions and loaded dependent objects if specified. (Inherited from MajorObject.)
Protected methodRemoveFromContainerInfrastructure. Removes a ModelComponent object from the specified container. (Inherited from ModelComponent.)
Public methodSubmit()Infrastructure. Submits a ModelComponent object. (Inherited from ModelComponent.)
Public methodSubmit(Boolean)Infrastructure. Submits a ModelComponent object. (Inherited from ModelComponent.)
Public methodToStringReturns a string containing the name of the component. (Inherited from NamedComponent.)
Public methodUpdate()Updates server definition of current object to actual values using the default values to update dependent objects. (Inherited from MajorObject.)
Public methodUpdate(UpdateOptions)Updates server definition of current object to actual values using the specified options to update dependent objects. (Inherited from MajorObject.)
Public methodUpdate(UpdateOptions, UpdateMode)Updates server definition of current object to actual values using the specified options to update dependent objects. (Inherited from MajorObject.)
Public methodUpdate(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 methodUpdate(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 methodUpdate(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 methodValidate(ValidationErrorCollection)Validates the element to which it is appended; returns any errors encountered in a collection. (Inherited from ModelComponent.)
Public methodValidate(ValidationResultCollection)Indicates whether the MajorObject is valid. (Inherited from MajorObject.)
Public methodValidate(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 methodValidate(ValidationResultCollection, ValidationOptions)Indicates whether the MajorObject is valid. (Inherited from MajorObject.)
Public methodValidate(ValidationErrorCollection, Boolean, ServerEdition)Validates the current mining structure and returns a collection of validation errors. (Overrides NamedComponent.Validate(ValidationErrorCollection, Boolean, ServerEdition).)
Public methodValidate(ValidationResultCollection, ValidationOptions, ServerEdition)Indicates whether the MajorObject is valid. (Inherited from MajorObject.)
Top
  NameDescription
Public eventDisposed (Inherited from Component.)
Top
  NameDescription
Explicit interface implemetationPrivate methodICloneable.CloneReturns the Clone implementation of the mining structure.
Explicit interface implemetationPrivate methodIDeserializationCallback.OnDeserializationRuns when the entire object graph has been deserialized. (Inherited from MajorObject.)
Explicit interface implemetationPrivate methodIFormattable.ToStringFormats the value of the current instance using the specified format. (Inherited from NamedComponent.)
Explicit interface implemetationPrivate methodIDeserializationStartCallback.OnDeserializationBeginRuns when the entire object graph starts to deserialized. (Inherited from MajorObject.)
Explicit interface implemetationPrivate propertyIHostableComponent.HostGets or sets the IServiceProvider that is the host of the ModelComponent. (Inherited from ModelComponent.)
Explicit interface implemetationPrivate propertyIMajorObject.BaseTypeGets the base type implementation of the mining structure.
Explicit interface implemetationPrivate methodIMajorObject.CreateBodyReturns the CreateBody implementation of the mining structure.
Explicit interface implemetationPrivate methodIMajorObject.DependsOnReturns the DependsOn implementation of the mining structure.
Explicit interface implemetationPrivate propertyIMajorObject.ObjectReferenceGets the object reference implementation of the mining structure.
Explicit interface implemetationPrivate propertyIMajorObject.ParentDatabaseGets the parent database implementation of the mining structure.
Explicit interface implemetationPrivate propertyIMajorObject.ParentServerGets the parent server implementation of the mining structure.
Explicit interface implemetationPrivate propertyIMajorObject.PathGets the path implementation of the mining structure.
Explicit interface implemetationPrivate methodIMajorObject.WriteRefReturns the WriteRef implementation of the mining structure.
Explicit interface implemetationPrivate propertyIModelComponent.FriendlyPathGets a friendly path for the ModelComponent. (Inherited from ModelComponent.)
Explicit interface implemetationPrivate propertyIModelComponent.OwningCollectionGets or sets the collection that owns the current object. (Inherited from ModelComponent.)
Explicit interface implemetationPrivate propertyIProcessable.LastProcessedGets or sets the DateTime on which the object was last processed. (Inherited from ProcessableMajorObject.)
Explicit interface implemetationPrivate propertyIProcessable.StateGets or sets the AnalysisState of this current instance. (Inherited from ProcessableMajorObject.)
Top

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

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.