Package mondrian.xmla

Enum Class RowsetDefinition

java.lang.Object
java.lang.Enum<RowsetDefinition>
mondrian.xmla.RowsetDefinition
All Implemented Interfaces:
Serializable, Comparable<RowsetDefinition>, Constable
public enum RowsetDefinition extends Enum<RowsetDefinition>
RowsetDefinition defines a rowset, including the columns it should contain.

See "XML for Analysis Rowsets", page 38 of the XML for Analysis Specification, version 1.1.

Author:
jhyde

  • Enum Constant Details

    • DISCOVER_DATASOURCES

      public static final RowsetDefinition DISCOVER_DATASOURCES
      Returns a list of XML for Analysis data sources available on the server or Web Service. (For an example of how these may be published, see "XML for Analysis Implementation Walkthrough" in the XML for Analysis specification.)

      http://msdn2.microsoft.com/en-us/library/ms126129(SQL.90).aspx

      restrictions

      Not supported

    • DISCOVER_SCHEMA_ROWSETS

      public static final RowsetDefinition DISCOVER_SCHEMA_ROWSETS
      Note that SQL Server also returns the data-mining columns.

      restrictions

      Not supported

    • DISCOVER_ENUMERATORS

      public static final RowsetDefinition DISCOVER_ENUMERATORS
      restrictions

      Not supported

    • DISCOVER_PROPERTIES

      public static final RowsetDefinition DISCOVER_PROPERTIES
      restrictions

      Not supported

    • DISCOVER_KEYWORDS

      public static final RowsetDefinition DISCOVER_KEYWORDS
      restrictions

      Not supported

    • DISCOVER_LITERALS

      public static final RowsetDefinition DISCOVER_LITERALS
      restrictions

      Not supported

    • DBSCHEMA_CATALOGS

      public static final RowsetDefinition DBSCHEMA_CATALOGS
      restrictions

      Not supported

    • DBSCHEMA_COLUMNS

      public static final RowsetDefinition DBSCHEMA_COLUMNS
      restrictions

      Not supported COLUMN_OLAP_TYPE

    • DBSCHEMA_PROVIDER_TYPES

      public static final RowsetDefinition DBSCHEMA_PROVIDER_TYPES
      restrictions

      Not supported

    • DBSCHEMA_SCHEMATA

      public static final RowsetDefinition DBSCHEMA_SCHEMATA

    • DBSCHEMA_TABLES

      public static final RowsetDefinition DBSCHEMA_TABLES
      http://msdn2.microsoft.com/en-us/library/ms126299(SQL.90).aspx

      restrictions: TABLE_CATALOG Optional TABLE_SCHEMA Optional TABLE_NAME Optional TABLE_TYPE Optional TABLE_OLAP_TYPE Optional

      Not supported

    • DBSCHEMA_TABLES_INFO

      public static final RowsetDefinition DBSCHEMA_TABLES_INFO
      http://msdn.microsoft.com/library/en-us/oledb/htm/ oledbtables_info_rowset.asp

      restrictions

      Not supported

    • MDSCHEMA_ACTIONS

      public static final RowsetDefinition MDSCHEMA_ACTIONS
      http://msdn2.microsoft.com/en-us/library/ms126032(SQL.90).aspx

      restrictions CATALOG_NAME Optional SCHEMA_NAME Optional CUBE_NAME Mandatory ACTION_NAME Optional ACTION_TYPE Optional COORDINATE Mandatory COORDINATE_TYPE Mandatory INVOCATION (Optional) The INVOCATION restriction column defaults to the value of MDACTION_INVOCATION_INTERACTIVE. To retrieve all actions, use the MDACTION_INVOCATION_ALL value in the INVOCATION restriction column. CUBE_SOURCE (Optional) A bitmap with one of the following valid values:

      1 CUBE 2 DIMENSION

      Default restriction is a value of 1.

      Not supported

    • MDSCHEMA_CUBES

      public static final RowsetDefinition MDSCHEMA_CUBES
      http://msdn2.microsoft.com/en-us/library/ms126271(SQL.90).aspx

      restrictions CATALOG_NAME Optional. SCHEMA_NAME Optional. CUBE_NAME Optional. CUBE_TYPE (Optional) A bitmap with one of these valid values: 1 CUBE 2 DIMENSION Default restriction is a value of 1. BASE_CUBE_NAME Optional.

      Not supported CREATED_ON LAST_SCHEMA_UPDATE SCHEMA_UPDATED_BY LAST_DATA_UPDATE DATA_UPDATED_BY ANNOTATIONS

    • MDSCHEMA_DIMENSIONS

      public static final RowsetDefinition MDSCHEMA_DIMENSIONS
      http://msdn2.microsoft.com/en-us/library/ms126180(SQL.90).aspx http://msdn2.microsoft.com/en-us/library/ms126180.aspx

      restrictions CATALOG_NAME Optional. SCHEMA_NAME Optional. CUBE_NAME Optional. DIMENSION_NAME Optional. DIMENSION_UNIQUE_NAME Optional. CUBE_SOURCE (Optional) A bitmap with one of the following valid values: 1 CUBE 2 DIMENSION Default restriction is a value of 1.

      DIMENSION_VISIBILITY (Optional) A bitmap with one of the following valid values: 1 Visible 2 Not visible Default restriction is a value of 1.

    • MDSCHEMA_FUNCTIONS

      public static final RowsetDefinition MDSCHEMA_FUNCTIONS
      http://msdn2.microsoft.com/en-us/library/ms126257(SQL.90).aspx

      restrictions LIBRARY_NAME Optional. INTERFACE_NAME Optional. FUNCTION_NAME Optional. ORIGIN Optional.

      Not supported DLL_NAME Optional HELP_FILE Optional HELP_CONTEXT Optional - SQL Server xml schema says that this must be present OBJECT Optional CAPTION The display caption for the function.

    • MDSCHEMA_HIERARCHIES

      public static final RowsetDefinition MDSCHEMA_HIERARCHIES
      http://msdn2.microsoft.com/en-us/library/ms126062(SQL.90).aspx

      restrictions CATALOG_NAME Optional. SCHEMA_NAME Optional. CUBE_NAME Optional. DIMENSION_UNIQUE_NAME Optional. HIERARCHY_NAME Optional. HIERARCHY_UNIQUE_NAME Optional. HIERARCHY_ORIGIN (Optional) A default restriction is in effect on MD_USER_DEFINED and MD_SYSTEM_ENABLED. CUBE_SOURCE (Optional) A bitmap with one of the following valid values: 1 CUBE 2 DIMENSION Default restriction is a value of 1. HIERARCHY_VISIBILITY (Optional) A bitmap with one of the following valid values: 1 Visible 2 Not visible Default restriction is a value of 1.

      Not supported HIERARCHY_ORIGIN HIERARCHY_DISPLAY_FOLDER INSTANCE_SELECTION

    • MDSCHEMA_LEVELS

      public static final RowsetDefinition MDSCHEMA_LEVELS
      http://msdn2.microsoft.com/en-us/library/ms126038(SQL.90).aspx

      restriction CATALOG_NAME Optional. SCHEMA_NAME Optional. CUBE_NAME Optional. DIMENSION_UNIQUE_NAME Optional. HIERARCHY_UNIQUE_NAME Optional. LEVEL_NAME Optional. LEVEL_UNIQUE_NAME Optional. LEVEL_ORIGIN (Optional) A default restriction is in effect on MD_USER_DEFINED and MD_SYSTEM_ENABLED CUBE_SOURCE (Optional) A bitmap with one of the following valid values: 1 CUBE 2 DIMENSION Default restriction is a value of 1. LEVEL_VISIBILITY (Optional) A bitmap with one of the following values: 1 Visible 2 Not visible Default restriction is a value of 1.

      Not supported CUSTOM_ROLLUP_SETTINGS LEVEL_UNIQUE_SETTINGS LEVEL_ORDERING_PROPERTY LEVEL_DBTYPE LEVEL_MASTER_UNIQUE_NAME LEVEL_NAME_SQL_COLUMN_NAME Customers:(All)!NAME LEVEL_KEY_SQL_COLUMN_NAME Customers:(All)!KEY LEVEL_UNIQUE_NAME_SQL_COLUMN_NAME Customers:(All)!UNIQUE_NAME LEVEL_ATTRIBUTE_HIERARCHY_NAME LEVEL_KEY_CARDINALITY LEVEL_ORIGIN

    • MDSCHEMA_MEASURES

      public static final RowsetDefinition MDSCHEMA_MEASURES
      http://msdn2.microsoft.com/en-us/library/ms126250(SQL.90).aspx

      restrictions CATALOG_NAME Optional. SCHEMA_NAME Optional. CUBE_NAME Optional. MEASURE_NAME Optional. MEASURE_UNIQUE_NAME Optional. CUBE_SOURCE (Optional) A bitmap with one of the following valid values: 1 CUBE 2 DIMENSION Default restriction is a value of 1. MEASURE_VISIBILITY (Optional) A bitmap with one of the following valid values: 1 Visible 2 Not Visible Default restriction is a value of 1.

      Not supported MEASURE_GUID NUMERIC_PRECISION NUMERIC_SCALE MEASURE_UNITS EXPRESSION MEASURE_NAME_SQL_COLUMN_NAME MEASURE_UNQUALIFIED_CAPTION MEASUREGROUP_NAME MEASURE_DISPLAY_FOLDER DEFAULT_FORMAT_STRING

    • MDSCHEMA_MEMBERS

      public static final RowsetDefinition MDSCHEMA_MEMBERS
      http://msdn2.microsoft.com/es-es/library/ms126046.aspx

      restrictions CATALOG_NAME Optional. SCHEMA_NAME Optional. CUBE_NAME Optional. DIMENSION_UNIQUE_NAME Optional. HIERARCHY_UNIQUE_NAME Optional. LEVEL_UNIQUE_NAME Optional. LEVEL_NUMBER Optional. MEMBER_NAME Optional. MEMBER_UNIQUE_NAME Optional. MEMBER_CAPTION Optional. MEMBER_TYPE Optional. TREE_OP (Optional) Only applies to a single member: MDTREEOP_ANCESTORS (0x20) returns all the ancestors. MDTREEOP_CHILDREN (0x01) returns only the immediate children. MDTREEOP_SIBLINGS (0x02) returns members on the same level. MDTREEOP_PARENT (0x04) returns only the immediate parent. MDTREEOP_SELF (0x08) returns itself in the list of returned rows. MDTREEOP_DESCENDANTS (0x10) returns all the descendants. CUBE_SOURCE (Optional) A bitmap with one of the following valid values: 1 CUBE 2 DIMENSION Default restriction is a value of 1.

      Not supported

    • MDSCHEMA_PROPERTIES

      public static final RowsetDefinition MDSCHEMA_PROPERTIES
      http://msdn2.microsoft.com/en-us/library/ms126309(SQL.90).aspx

      restrictions CATALOG_NAME Mandatory SCHEMA_NAME Optional CUBE_NAME Optional DIMENSION_UNIQUE_NAME Optional HIERARCHY_UNIQUE_NAME Optional LEVEL_UNIQUE_NAME Optional

      MEMBER_UNIQUE_NAME Optional PROPERTY_NAME Optional PROPERTY_TYPE Optional PROPERTY_CONTENT_TYPE (Optional) A default restriction is in place on MDPROP_MEMBER OR MDPROP_CELL. PROPERTY_ORIGIN (Optional) A default restriction is in place on MD_USER_DEFINED OR MD_SYSTEM_ENABLED CUBE_SOURCE (Optional) A bitmap with one of the following valid values: 1 CUBE 2 DIMENSION Default restriction is a value of 1. PROPERTY_VISIBILITY (Optional) A bitmap with one of the following valid values: 1 Visible 2 Not visible Default restriction is a value of 1.

      Not supported PROPERTY_ORIGIN CUBE_SOURCE PROPERTY_VISIBILITY CHARACTER_MAXIMUM_LENGTH CHARACTER_OCTET_LENGTH NUMERIC_PRECISION NUMERIC_SCALE DESCRIPTION SQL_COLUMN_NAME LANGUAGE PROPERTY_ATTRIBUTE_HIERARCHY_NAME PROPERTY_CARDINALITY MIME_TYPE PROPERTY_IS_VISIBLE

    • MDSCHEMA_SETS

      public static final RowsetDefinition MDSCHEMA_SETS
      http://msdn2.microsoft.com/en-us/library/ms126290(SQL.90).aspx

      restrictions CATALOG_NAME Optional. SCHEMA_NAME Optional. CUBE_NAME Optional. SET_NAME Optional. SCOPE Optional. HIERARCHY_UNIQUE_NAME Optional. CUBE_SOURCE Optional. Note: Only one hierarchy can be included, and only those named sets whose hierarchies exactly match the restriction are returned.

      Not supported EXPRESSION DIMENSIONS SET_DISPLAY_FOLDER

    • MDSCHEMA_KPIS

      public static final RowsetDefinition MDSCHEMA_KPIS

    • MDSCHEMA_MEASUREGROUPS

      public static final RowsetDefinition MDSCHEMA_MEASUREGROUPS

    • DISCOVER_XML_METADATA

      public static final RowsetDefinition DISCOVER_XML_METADATA
      restrictions

      Not supported

    • DBSCHEMA_SOURCE_TABLES

      public static final RowsetDefinition DBSCHEMA_SOURCE_TABLES

    • MDSCHEMA_MEASUREGROUP_DIMENSIONS

      public static final RowsetDefinition MDSCHEMA_MEASUREGROUP_DIMENSIONS

  • Field Details

    • CATALOG_NAME_GETTER

      public static final Util.Functor1<String,org.olap4j.metadata.Catalog> CATALOG_NAME_GETTER

    • SCHEMA_NAME_GETTER

      public static final Util.Functor1<String,org.olap4j.metadata.Schema> SCHEMA_NAME_GETTER

    • ELEMENT_NAME_GETTER

      public static final Util.Functor1<String,org.olap4j.metadata.MetadataElement> ELEMENT_NAME_GETTER

    • ELEMENT_UNAME_GETTER

      public static final Util.Functor1<String,org.olap4j.metadata.MetadataElement> ELEMENT_UNAME_GETTER

    • MEMBER_TYPE_GETTER

      public static final Util.Functor1<org.olap4j.metadata.Member.Type,org.olap4j.metadata.Member> MEMBER_TYPE_GETTER

    • PROPDEF_NAME_GETTER

      public static final Util.Functor1<String,PropertyDefinition> PROPDEF_NAME_GETTER

  • Method Details

    • values

      public static RowsetDefinition[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static RowsetDefinition valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • getRowset

      public abstract mondrian.xmla.Rowset getRowset(XmlaRequest request, XmlaHandler handler)

    • lookupColumn

      public mondrian.xmla.RowsetDefinition.Column lookupColumn(String name)

    • writeRowsetXmlSchemaTop

      protected void writeRowsetXmlSchemaTop(SaxWriter writer)

    • writeRowsetXmlSchemaRowDef

      protected void writeRowsetXmlSchemaRowDef(SaxWriter writer)

    • writeRowsetXmlSchemaBottom

      protected void writeRowsetXmlSchemaBottom(SaxWriter writer)

    • getDescription

      public String getDescription()