Delen via


Cube Class

Represents a cube from a database. 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.Cube

Namespace:  Microsoft.AnalysisServices
Assembly:  Microsoft.AnalysisServices (in Microsoft.AnalysisServices.dll)

Syntax

'Declaration
<GuidAttribute("127B4EBB-5328-4f6a-8A3B-72CF9BDA5F77")> _
Public NotInheritable Class Cube _
    Inherits ProcessableMajorObject _
    Implements IMajorObject, INamedComponent, IModelComponent, IComponent,  _
    IDisposable, ICloneable
'Usage
Dim instance As Cube
[GuidAttribute("127B4EBB-5328-4f6a-8A3B-72CF9BDA5F77")]
public sealed class Cube : ProcessableMajorObject, IMajorObject, 
    INamedComponent, IModelComponent, IComponent, IDisposable, ICloneable
[GuidAttribute(L"127B4EBB-5328-4f6a-8A3B-72CF9BDA5F77")]
public ref class Cube sealed : public ProcessableMajorObject, 
    IMajorObject, INamedComponent, IModelComponent, IComponent, IDisposable, 
    ICloneable
[<SealedAttribute>]
[<GuidAttribute("127B4EBB-5328-4f6a-8A3B-72CF9BDA5F77")>]
type Cube =  
    class 
        inherit ProcessableMajorObject 
        interface IMajorObject 
        interface INamedComponent 
        interface IModelComponent 
        interface IComponent 
        interface IDisposable 
        interface ICloneable 
    end
public final class Cube extends ProcessableMajorObject implements IMajorObject, INamedComponent, IModelComponent, IComponent, IDisposable, ICloneable

The Cube type exposes the following members.

Constructors

  Name Description
Public method Cube() Initializes a new instance of the Cube class using the default values.
Public method Cube(String) Initializes a new instance of Cube using a name.
Public method Cube(String, String) Initializes a new instance of the Cube class, using a name and an identifier.

Top

Properties

  Name Description
Public property Actions Gets the actions collection for the cube.
Public property AggregationPrefix Gets or sets the prefix for aggregations in the cube.
Public property AllMeasures Gets all measures as an enumeration object.
Public property Annotations Gets the collection object of all annotations to current object. (Inherited from MajorObject.)
Public property Collation Gets or sets the collation string for a Cube.
Public property Container (Inherited from Component.)
Public property CreatedTimestamp Gets or sets the date and time of the creation of the object. (Inherited from MajorObject.)
Public property CubePermissions Gets the permissions collection associated with a cube.
Public property DataSource Gets the DataSource object associated with a Cube.
Public property DataSourceView Gets the DataSourceView object associated with a Cube.
Public property DefaultMdxScript Gets the defaultmdxscript object associated with a Cube.
Public property DefaultMeasure Gets or sets the DefaultMeasure associated with a Cube.
Public property Description Gets or sets a description string of current object. (Inherited from MajorObject.)
Public property Dimensions Gets the dimensions collection associated with a Cube.
Public property ErrorConfiguration Gets or sets the ErrorConfiguration associated with a Cube.
Public property EstimatedRows Gets or sets the number of EstimatedRows for a Cube.
Protected property FriendlyName Returns a user-friendly name. (Inherited from NamedComponent.)
Public property ID Gets or sets the identifier of the component. (Inherited from NamedComponent.)
Public property IsLoaded Infrastructure. Gets a value that indicates whether MajorObject have been loaded. (Inherited from MajorObject.)
Protected property KeyForCollection Returns the key used in collections. (Inherited from NamedComponent.)
Public property Kpis Gets a collection of Kpis associated with a Cube.
Public property Language Gets or sets the default Language to use for the Cube.
Public property LastProcessed Gets or sets the DateTime on which the object was last processed. (Inherited from ProcessableMajorObject.)
Public property LastSchemaUpdate Gets or sets the date and time when current object schema was last updated. (Inherited from MajorObject.)
Public property MdxScripts Gets a collection of MdxScripts associated with a Cube.
Public property MeasureGroups Gets a collection of MeasureGroups associated with a Cube.
Public property Name Gets or sets the name of the component. (Inherited from NamedComponent.)
Public property OwningCollection Gets or sets the collection that contains the ModelComponent. (Inherited from ModelComponent.)
Public property Parent Gets the parent Database of the Cube object.
Public property ParentServer Gets the Server object that is the parent of the Cube.
Public property Perspectives Gets the perspectives for the cube.
Public property ProactiveCaching Gets or sets the proactive caching settings for the cube.
Public property ProcessingMode Gets or sets the index and aggregation settings for cube processing.
Public property ProcessingPriority Gets or sets the processing priority for the cube.
Public property ScriptCacheProcessingMode Gets or sets the script cache settings for processing.
Public property ScriptErrorHandlingMode Gets or sets the script error handling mode.
Public property Site Infrastructure. Gets or sets the site of the component. (Inherited from NamedComponent.)
Public property SiteID Infrastructure. Gets or sets the identifier for the site associated with the component. (Inherited from NamedComponent.)
Public property Source Gets or sets the source for a relational cube.
Public property State Gets or sets the AnalysisState of this current instance. (Inherited from ProcessableMajorObject.)
Public property StorageLocation Gets or sets the storage location for the cube.
Public property StorageMode Gets or sets the storage mode for the cube.
Public property Translations Gets the translations for the cube.
Public property Visible Gets or sets a value that indicates whether a cube can be viewed.

Top

Methods

  Name Description
Protected method AddToContainer Infrastructure. Adds a ModelComponent object to the specified container. (Inherited from ModelComponent.)
Protected method AfterInsert Infrastructure. Displays a ModelComponent object after added to the specified index. (Inherited from ModelComponent.)
Protected method AfterMove Infrastructure. Displays a ModelComponent object after moving to the specified index. (Inherited from ModelComponent.)
Protected method AfterRemove Infrastructure. Displays a ModelComponentCollection after a ModelComponent object is removed. (Inherited from ModelComponent.)
Protected method BeforeRemove Infrastructure. Removes the ModelComponent object before the cleanup. (Inherited from ModelComponent.)
Public method CanProcess Indicates whether the cube can perform the specified processing. (Overrides ProcessableMajorObject.CanProcess(ProcessType).)
Public method Clone() Creates a new, full copy of an object.
Protected method Clone(Boolean) Infrastructure. Creates a new copy of the MajorObject object. (Inherited from MajorObject.)
Public method CopyTo(Cube) Copies a Cube to the specified object.
Protected method CopyTo(MajorObject, Boolean) Copies the object to the specified destination. (Inherited from ProcessableMajorObject.)
Public method CreateObjRef Security Critical. (Inherited from MarshalByRefObject.)
Public method Dispose (Inherited from Component.)
Public method Drop() Removes current object and updates server. (Inherited from MajorObject.)
Public method Drop(DropOptions) Removes current object and updates server using specified options. (Inherited from MajorObject.)
Public method 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.)
Public method 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.)
Public method 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.)
Public method Equals (Inherited from Object.)
Protected method GetCreateReferences Infrastructure. Gets a Hashtable to create references. (Inherited from MajorObject.)
Public method GetDependents Adds the mining structures and subsequent dependants to the specified Hashtable. (Overrides MajorObject.GetDependents(Hashtable).)
Protected method GetDropDependents Infrastructure. Gets the drop dependents. (Inherited from MajorObject.)
Public method GetHashCode (Inherited from Object.)
Public method GetLifetimeService Security Critical. (Inherited from MarshalByRefObject.)
Public method GetReferences Gets the objects that the cube references. (Overrides MajorObject.GetReferences(Hashtable, Boolean).)
Public method GetType (Inherited from Object.)
Public method GetUpdateOverwrites Infrastructure. Gets the Hashtable object that overwrites the updated MajorObject. (Inherited from MajorObject.)
Public method InitializeLifetimeService Security Critical. (Inherited from MarshalByRefObject.)
Public method LinkMeasureGroup(MeasureGroup, String) Generates a regular measure group, but it is set up to point to other measure groups. As parameters, this method takes the measure group (source) you want to link to and a data source identifier.
Public method LinkMeasureGroup(MeasureGroup, String, String) Generates a regular measure group, but it is set up to point to other measure groups. As parameters, this method takes the measure group (source) you want to link to and a data source identifier.
Public method Process() Processes the ProcessableMajorObject. (Inherited from ProcessableMajorObject.)
Public method Process(ProcessType) Processes the ProcessableMajorObject with the specified process type. (Inherited from ProcessableMajorObject.)
Public method Process(ProcessType, Binding) Processes the ProcessableMajorObject with the specified process type. (Inherited from ProcessableMajorObject.)
Public method Process(ProcessType, ErrorConfiguration) Processes the ProcessableMajorObject with the specified process type. (Inherited from ProcessableMajorObject.)
Public method Process(ProcessType, WriteBackTableCreation) Processes the ProcessableMajorObject with the specified process type and writeback option. (Inherited from ProcessableMajorObject.)
Public method Process(ProcessType, ErrorConfiguration, XmlaWarningCollection) Processes the ProcessableMajorObject with the specified process type. (Inherited from ProcessableMajorObject.)
Public method Process(ProcessType, ErrorConfiguration, XmlaWarningCollection, ImpactDetailCollection) Processes the ProcessableMajorObject with the specified process type. (Inherited from ProcessableMajorObject.)
Public method Process(ProcessType, ErrorConfiguration, XmlaWarningCollection, ImpactDetailCollection, Boolean) Processes the ProcessableMajorObject with the specified process type. (Inherited from ProcessableMajorObject.)
Public method Refresh() Updates current object from server definitions. (Inherited from MajorObject.)
Public method Refresh(Boolean) Updates current object from server definitions and loaded dependent objects if specified. (Inherited from MajorObject.)
Public method Refresh(Boolean, RefreshType) Updates current object from server definitions and loaded dependent objects if specified. (Inherited from MajorObject.)
Protected method RemoveFromContainer Infrastructure. Removes a ModelComponent object from the specified container. (Inherited from ModelComponent.)
Public method Submit() Infrastructure. Submits a ModelComponent object. (Inherited from ModelComponent.)
Public method Submit(Boolean) Infrastructure. Submits a ModelComponent object. (Inherited from ModelComponent.)
Public method ToString Returns a string containing the name of the component. (Inherited from NamedComponent.)
Public method Update() Updates server definition of current object to actual values using the default values to update dependent objects. (Inherited from MajorObject.)
Public method Update(UpdateOptions) Updates server definition of current object to actual values using the specified options to update dependent objects. (Inherited from MajorObject.)
Public method Update(UpdateOptions, UpdateMode) Updates server definition of current object to actual values using the specified options to update dependent objects. (Inherited from MajorObject.)
Public method 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.)
Public method 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.)
Public method 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.)
Public method Validate(ValidationErrorCollection) Validates the element to which it is appended; returns any errors encountered in a collection. (Inherited from ModelComponent.)
Public method Validate(ValidationResultCollection) Indicates whether the MajorObject is valid. (Inherited from MajorObject.)
Public method 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.)
Public method Validate(ValidationResultCollection, ValidationOptions) Indicates whether the MajorObject is valid. (Inherited from MajorObject.)
Public method Validate(ValidationErrorCollection, Boolean, ServerEdition) Determines whether the Cube is valid. (Overrides NamedComponent.Validate(ValidationErrorCollection, Boolean, ServerEdition).)
Public method Validate(ValidationResultCollection, ValidationOptions, ServerEdition) Indicates whether the MajorObject is valid. (Inherited from MajorObject.)
Public method Validate(ValidationErrorCollection, Boolean, Boolean, ServerEdition) Determines whether the Cube is valid.

Top

Events

  Name Description
Public event Disposed (Inherited from Component.)

Top

Explicit Interface Implementations

  Name Description
Explicit interface implemetationPrivate method ICloneable.Clone Creates a new copy of the object instance.
Explicit interface implemetationPrivate method IDeserializationCallback.OnDeserialization Runs when the entire object graph has been deserialized. (Inherited from MajorObject.)
Explicit interface implemetationPrivate method IFormattable.ToString Formats the value of the current instance using the specified format. (Inherited from NamedComponent.)
Explicit interface implemetationPrivate method IDeserializationStartCallback.OnDeserializationBegin Runs when the entire object graph starts to deserialized. (Inherited from MajorObject.)
Explicit interface implemetationPrivate property IHostableComponent.Host Gets or sets the IServiceProvider that is the host of the ModelComponent. (Inherited from ModelComponent.)
Explicit interface implemetationPrivate property IMajorObject.BaseType Gets the base type implementation of the Cube.
Explicit interface implemetationPrivate method IMajorObject.CreateBody Creates a new body for the Cube.
Explicit interface implemetationPrivate method IMajorObject.DependsOn Determines whether the Cube depends on an object.
Explicit interface implemetationPrivate property IMajorObject.ObjectReference Gets the object reference implementation of the Cube.
Explicit interface implemetationPrivate property IMajorObject.ParentDatabase Gets the parent database referred by the Cube.
Explicit interface implemetationPrivate property IMajorObject.Path Gets the path implementation of the Cube.
Explicit interface implemetationPrivate method IMajorObject.WriteRef Writes a reference for the Cube.
Explicit interface implemetationPrivate property IModelComponent.FriendlyPath Gets a friendly path for the ModelComponent. (Inherited from ModelComponent.)
Explicit interface implemetationPrivate property IModelComponent.OwningCollection Gets or sets the collection that owns the current object. (Inherited from ModelComponent.)
Explicit interface implemetationPrivate property IProcessable.LastProcessed Gets or sets the DateTime on which the object was last processed. (Inherited from ProcessableMajorObject.)
Explicit interface implemetationPrivate property IProcessable.State Gets or sets the AnalysisState of this current instance. (Inherited from ProcessableMajorObject.)

Top

Remarks

Cubes are managed from a cubes collection in a database. Cubes are created by adding them to the cubes collection in the database. Cubes are deleted by removing them from the cubes collection in the database.

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