AggregationInstance Class
Represents an instance of a defined Aggregation for a partition.
Inheritance Hierarchy
System.Object
System.MarshalByRefObject
System.ComponentModel.Component
Microsoft.AnalysisServices.ModelComponent
Microsoft.AnalysisServices.NamedComponent
Microsoft.AnalysisServices.AggregationInstance
Namespace: Microsoft.AnalysisServices
Assembly: Microsoft.AnalysisServices (in Microsoft.AnalysisServices.dll)
Syntax
'Declaration
<GuidAttribute("22940FE2-7C38-4243-9996-2FC8054500B2")> _
Public Class AggregationInstance _
Inherits NamedComponent _
Implements ICloneable
'Usage
Dim instance As AggregationInstance
[GuidAttribute("22940FE2-7C38-4243-9996-2FC8054500B2")]
public class AggregationInstance : NamedComponent,
ICloneable
[GuidAttribute(L"22940FE2-7C38-4243-9996-2FC8054500B2")]
public ref class AggregationInstance : public NamedComponent,
ICloneable
[<GuidAttribute("22940FE2-7C38-4243-9996-2FC8054500B2")>]
type AggregationInstance =
class
inherit NamedComponent
interface ICloneable
end
public class AggregationInstance extends NamedComponent implements ICloneable
The AggregationInstance type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
.gif "Public method") |
AggregationInstance() | Initializes a new instance of the AggregationInstance class using the default values. |
|
AggregationInstance(String) | Initializes a new instance of the AggregationInstance class using a name. |
|
AggregationInstance(String, String) | Initializes a new instance of the AggregationInstance class using a name and an identifier. |
Top
Properties
| Name | Description | |
|---|---|---|
.gif "Public property") |
AggregationType | Defines the type of aggregation stored in AggregationInstance. |
|
Annotations | Gets a collection within which you can store custom data. (Inherited from ModelComponent.) |
.gif "Protected property") |
CanRaiseEvents | (Inherited from Component.) |
|
Container | (Inherited from Component.) |
|
Description | Gets or sets the description of the component. (Inherited from NamedComponent.) |
|
DesignMode | (Inherited from Component.) |
|
Dimensions | Returns the collection of dimensions associated with an AggregationInstance. |
|
Events | (Inherited from Component.) |
|
FriendlyName | Returns a user-friendly name. (Inherited from NamedComponent.) |
|
ID | Gets or sets the identifier of the component. (Inherited from NamedComponent.) |
|
KeyForCollection | Returns the key used in collections. (Inherited from NamedComponent.) |
|
Measures | Gets the collection of measures associated with an AggregationInstance. |
|
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 | Infrastructure. Gets the IModelComponent object that is the parent of the ModelComponent object. (Inherited from ModelComponent.) |
|
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 table name for the aggregation, if different than the table associated with column binding. |
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.) |
|
Clone | Creates a new, full copy of the type of aggregation stored in [T:Microsoft.AnalysisServices.AggregationInstance.] object. |
|
CopyTo(AggregationInstance) | Copies an AggregationInstance to the another object. |
|
CopyTo(ModelComponent) | Infrastructure. Copies a ModelComponent object to the specified object. (Inherited from ModelComponent.) |
|
CopyTo(NamedComponent) | Infrastructure. Copies a NamedComponent object to the specified object. (Inherited from NamedComponent.) |
|
CreateObjRef | Security Critical. (Inherited from MarshalByRefObject.) |
|
Dispose() | (Inherited from Component.) |
|
Dispose(Boolean) | (Inherited from Component.) |
|
Equals | (Inherited from Object.) |
|
Finalize | (Inherited from Component.) |
|
GetHashCode | (Inherited from Object.) |
|
GetLifetimeService | Security Critical. (Inherited from MarshalByRefObject.) |
|
GetService | (Inherited from Component.) |
|
GetType | (Inherited from Object.) |
|
InitializeLifetimeService | Security Critical. (Inherited from MarshalByRefObject.) |
|
MemberwiseClone() | (Inherited from Object.) |
|
MemberwiseClone(Boolean) | (Inherited from MarshalByRefObject.) |
|
RemoveFromContainer | Infrastructure. Removes a ModelComponent object from the specified container. (Inherited from ModelComponent.) |
|
Reset | Infrastructure. Resets the component to its initial state. (Inherited from NamedComponent.) |
|
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.) |
|
Validate(ValidationErrorCollection) | Validates the element to which it is appended; returns any errors encountered in a collection. (Inherited from ModelComponent.) |
|
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) | Determines whether the NamedComponent is valid. (Inherited from NamedComponent.) |
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 | Creates and returns a new object that is a copy of the current instance of this AggregationInstance object. |
|
IFormattable.ToString | Formats the value of the current instance using the specified format. (Inherited from NamedComponent.) |
.gif "Private property") |
IHostableComponent.Host | Gets or sets the IServiceProvider that is the host of the ModelComponent. (Inherited from ModelComponent.) |
|
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.) |
Top
Remarks
When a Partition uses an AggregationDesign to generate aggregations for that partition, each Aggregation in the AggregationDesign is instantiated for that partition. Multiple partitions can use the same AggregationDesign to generate multiple instances of a defined Aggregation. Also note that user defined aggregations can be created on a partition without going through the AggregationDesign object.
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.