com.sas.storage.olap.sasmdx
Class Schema

com.sas.storage.olap.sasmdx.Schema

All Implemented Interfaces:

SchemaInterface

public class Schema
implements SchemaInterface

Contains the client side implementation for com.sas.storage.olap.SchemaInterface. This implementation uses the IOM/OLAP interfaces provided by the SAS OLAP server. There actually aren't any remote calls in this particular class. All remote metadata calls are made from within the MetadataInterface implementation.

Method Summary

CubeInterface[]	getCubes() Returns the cubes associated with this schema.
Filter	getFilter() Returns a copy of the Filter object that was used to obtain this SchemaInterface.
java.lang.String	getLabel() Returns the schema's label.
MetadataInterface	getMetadata() Returns an instance of the MetadataInterface that is associated with this schema.
java.lang.String	getName() Returns the schema's name.

Method Detail

getName

public java.lang.String getName()
                         throws OLAPException

Description copied from interface: SchemaInterface

Returns the schema's name. The name of the schema.

Specified by:

getName in interface SchemaInterface

Returns:

The schema's name.

Throws:

OLAPException - if a database error occurs

getLabel

public java.lang.String getLabel()
                          throws OLAPException

Description copied from interface: SchemaInterface

Returns the schema's label. The label is descriptive text about the schema, i.e. a caption.

Specified by:

getLabel in interface SchemaInterface

Returns:

The schema's label.

Throws:

OLAPException - if a database error occurs

getCubes

public CubeInterface[] getCubes()
                         throws OLAPException

Description copied from interface: SchemaInterface

Returns the cubes associated with this schema.

Specified by:

getCubes in interface SchemaInterface

Returns:

An array of cubes associated with this schema.

Throws:

OLAPException - if a database error occurs

getFilter

public Filter getFilter()
                 throws OLAPException

Description copied from interface: SchemaInterface

Returns a copy of the Filter object that was used to obtain this SchemaInterface. The filter object may be applied explicitly via the MetadataInterface, or it may be created implicitly via a getSchemas() method.

Specified by:

getFilter in interface SchemaInterface

Returns:

A copy of the Filter object that was used to obtain this SchemaInterface

Throws:

OLAPException - if a database error occurs

getMetadata

public MetadataInterface getMetadata()
                              throws OLAPException

Description copied from interface: SchemaInterface

Returns an instance of the MetadataInterface that is associated with this schema. Null if the schema is not bound to a metadata object.

Specified by:

getMetadata in interface SchemaInterface

Returns:

The metadata object associated with this schema.

Throws:

OLAPException - if a database error occurs