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

CubeCollection Class

Contains a read-only, on-demand list of CubeDef objects contained by an AdomdConnection.

System.Object
  Microsoft.AnalysisServices.AdomdClient.CubeCollection

Namespace:  Microsoft.AnalysisServices.AdomdClient
Assembly:  Microsoft.AnalysisServices.AdomdClient (in Microsoft.AnalysisServices.AdomdClient.dll)
public sealed class CubeCollection : ICollection, 
	IEnumerable

The CubeCollection type exposes the following members.

  NameDescription
Public propertyCountGets the number of CubeDef objects in the collection.
Public propertyIsSynchronizedGets a value indicating whether access to the collection is synchronized (thread safe).
Public propertyItem[Int32]Gets the specified CubeDef from the collection by its index. In Microsoft Visual C#, this property is the indexer for the CubeCollection class.
Public propertyItem[String]Gets the specified CubeDef from the collection by its name. In Microsoft Visual C#, this property is the indexer for the CubeCollection class.
Public propertySyncRootGets an Object that can be used to synchronize access to the collection.
Top
  NameDescription
Public methodCopyToCopies the elements of the collection to the specified array.
Public methodEquals (Inherited from Object.)
Public methodFindGets the CubeDef from the collection by its specified name.
Public methodGetEnumeratorGets an enumerator for iterating through the CubeCollection.
Public methodGetHashCode (Inherited from Object.)
Public methodGetType (Inherited from Object.)
Public methodToString (Inherited from Object.)
Top
  NameDescription
Explicit interface implemetationPrivate methodICollection.CopyToCopies the elements of the CubeCollection to an array, starting at a particular array index.
Explicit interface implemetationPrivate methodIEnumerable.GetEnumeratorGets an enumerator for iterating through the CubeCollection.
Top

The following subroutine, given a connected instance of an AdomdConnection, iterates through the CubeCollection collection and displays various properties:

Public Sub ListCubes(ByRef ConnectionToCheck As AdomdConnection)

    ' Check the parameter before performing actions on it.
    If ConnectionToCheck Is Nothing Then
        Throw New System.ArgumentNullException("ConnectionToCheck")
    ElseIf ConnectionToCheck.State <> ConnectionState.Open Then
        Throw New System.ArgumentException( _
            "The specified connection is not open.")
    Else
        ' Iterate through the Cubes collection of the
        ' AdomdConnection object.

        Try
            ' Note that this example does not provide 
            ' information about the various collections, such as
            ' NamedSets, provided by the Cube object. Because
            ' these collections are loaded on demand, you should
            ' reference them only if you need information
            ' from them.
            Dim cubeToCheck As CubeDef

            Debug.WriteLine("Found " & ConnectionToCheck.Cubes.Count & _
                " cubes in database:")

            For Each cubeToCheck In ConnectionToCheck.Cubes
                Debug.WriteLine("Cube:  " & cubeToCheck.Name)
                Debug.WriteLine("  Caption:        " & _
                    cubeToCheck.Caption)
                Debug.WriteLine("  Description:    " & _
                    cubeToCheck.Description)
                Debug.WriteLine("  LastProcessed:  " & _
                    cubeToCheck.LastProcessed)
            Next
        Catch ex As AdomdConnectionException
            ' The connection could not be opened or was disconnected.
            ' This error can occur at any time, if the provider is 
            ' disconnected from the server.
            Debug.WriteLine(ex)
            Throw ex
        Catch ex As AdomdErrorResponseException
            ' A response is received from a provider which indicates an error.
            Debug.WriteLine(ex)
            Throw ex
        Catch ex As AdomdUnknownResponseException
            ' A response has been returned from the provider that 
            ' was not understood.
            Debug.WriteLine(ex)
            Throw ex
        Catch ex As AdomdCacheExpiredException
            ' A cached version of an ADOMD.NET object is no longer valid.
            ' This error is typically raised when reviewing metadata.
            Debug.WriteLine(ex)
            Throw ex
        Catch ex As AdomdException
            ' Any other error raised by ADOMD.NET.
            Debug.WriteLine(ex)
            Throw ex
        Catch ex As Exception
            ' Any other error.
            Debug.WriteLine(ex)
            Throw ex
        End Try
    End If
End Sub
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.