Share via

  • Article

AxisCollection Class

Gets a read-only collection of Axis objects contained by a CellSet.

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

Syntax

'Declaration
Public NotInheritable Class AxisCollection _
    Implements ICollection, IEnumerable
'Usage
Dim instance As AxisCollection

public sealed class AxisCollection : ICollection, 
    IEnumerable

public ref class AxisCollection sealed : ICollection, 
    IEnumerable

[<SealedAttribute>]
type AxisCollection =  
    class
        interface ICollection
        interface IEnumerable
    end

public final class AxisCollection implements ICollection, IEnumerable

Remarks

The AxisCollection is used by a CellSet to represent the axes returned by a query. Each Axis contained by an AxisCollection represents a set of congruent tuples organized along one or more hierarchies.

Note

The filter axis is not contained in this collection. To access the filter axis, you must reference the OlapInfo.AxesInfo.FilterAxes property of the CellSet.

Examples

The following subroutine, given a CellSet, iterates through the AxisCollection (represented by the Axes property of the CellSet) and displays information for each axis.

Public Sub ListAxes(ByRef cellsetToCheck As CellSet)

    ' Check the parameter before performing actions on it.
    If cellsetToCheck Is Nothing Then
        Throw New System.ArgumentNullException("cellsetToCheck")
    Else
        ' Iterate through the axes of the
        ' CellSet object. The Axes property of the 
        ' CellSet object returns a reference to the
        ' AxisCollection object.

        Try
            Dim axisToCheck As Axis

            Debug.WriteLine("Found " & cellsetToCheck.Axes.Count & _
                " axes in cellset:")

            For Each axisToCheck In cellsetToCheck.Axes

                Debug.WriteLine("  Name:  " & _
                    axisToCheck.Name)
            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 meta data.
            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

Inheritance Hierarchy

System.Object
  Microsoft.AnalysisServices.AdomdClient.AxisCollection

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.