mondrian.xmla
Enum RowsetDefinition

java.lang.Object
  java.lang.Enum<RowsetDefinition>
      mondrian.xmla.RowsetDefinition

All Implemented Interfaces:

Serializable, Comparable<RowsetDefinition>

 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

Nested Class Summary

(package private) static class	RowsetDefinition.Column
(package private) static class	RowsetDefinition.DbschemaCatalogsRowset
(package private) static class	RowsetDefinition.DbschemaColumnsRowset
(package private) static class	RowsetDefinition.DbschemaProviderTypesRowset
(package private) static class	RowsetDefinition.DbschemaSchemataRowset
(package private) static class	RowsetDefinition.DbschemaTablesInfoRowset
(package private) static class	RowsetDefinition.DbschemaTablesRowset
(package private) static class	RowsetDefinition.DBType The only OLE DB Types Indicators returned by SQL Server are thoses coded below.
(package private) static class	RowsetDefinition.DiscoverDatasourcesRowset
(package private) static class	RowsetDefinition.DiscoverEnumeratorsRowset
(package private) static class	RowsetDefinition.DiscoverKeywordsRowset
(package private) static class	RowsetDefinition.DiscoverLiteralsRowset
(package private) static class	RowsetDefinition.DiscoverPropertiesRowset
(package private) static class	RowsetDefinition.DiscoverSchemaRowsetsRowset
(package private) static class	RowsetDefinition.MdschemaActionsRowset
(package private) static class	RowsetDefinition.MdschemaCubesRowset
(package private) static class	RowsetDefinition.MdschemaDimensionsRowset
(package private) static class	RowsetDefinition.MdschemaFunctionsRowset
(package private) static class	RowsetDefinition.MdschemaHierarchiesRowset
(package private) static class	RowsetDefinition.MdschemaLevelsRowset
(package private) static class	RowsetDefinition.MdschemaMeasuresRowset
(package private) static class	RowsetDefinition.MdschemaMembersRowset
(package private) static class	RowsetDefinition.MdschemaPropertiesRowset
(package private) static class	RowsetDefinition.MdschemaSetsRowset
(package private) static class	RowsetDefinition.Type

Enum Constant Summary

DBSCHEMA_CATALOGS
restrictions Not supported

DBSCHEMA_COLUMNS
restrictions Not supported COLUMN_OLAP_TYPE

DBSCHEMA_PROVIDER_TYPES
restrictions Not supported

DBSCHEMA_SCHEMATA

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
http://msdn.microsoft.com/library/default.asp?url=/library/en-us/oledb/htm/oledbtables_info_rowset.asp restrictions Not supported

DISCOVER_DATASOURCES
Returns a list of XML for Analysis data sources available on the server or Web Service.

DISCOVER_ENUMERATORS
restrictions Not supported

DISCOVER_KEYWORDS
restrictions Not supported

DISCOVER_LITERALS
restrictions Not supported

DISCOVER_PROPERTIES
restrictions Not supported

DISCOVER_SCHEMA_ROWSETS
Note that SQL Server also returns the data-mining columns.

MDSCHEMA_ACTIONS
http://msdn2.microsoft.com/en-us/library/ms126032(SQL.90).aspx http://msdn.microsoft.com/library/default.asp?url=/library/en-us/oledb/htm/olapactions_rowset.asp 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.

MDSCHEMA_CUBES
http://msdn2.microsoft.com/en-us/library/ms126271(SQL.90).aspx http://msdn.microsoft.com/library/default.asp?url=/library/en-us/oledb/htm/olapproperties_rowset.asp restrictions CATALOG_NAME Optional.

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.

MDSCHEMA_FUNCTIONS
http://msdn2.microsoft.com/en-us/library/ms126257(SQL.90).aspx http://msdn.microsoft.com/library/en-us/oledb/htm/olapfunctions_rowset.asp restrictions LIBRARY_NAME Optional.

MDSCHEMA_HIERARCHIES
http://msdn2.microsoft.com/en-us/library/ms126062(SQL.90).aspx http://msdn.microsoft.com/library/default.asp?url=/library/en-us/oledb/htm/olapproperties_rowset.asp restrictions CATALOG_NAME Optional.

MDSCHEMA_LEVELS
http://msdn2.microsoft.com/en-us/library/ms126038(SQL.90).aspx http://msdn.microsoft.com/library/en-us/oledb/htm/olaplevels_rowset.asp restriction CATALOG_NAME Optional.

MDSCHEMA_MEASURES
http://msdn2.microsoft.com/en-us/library/ms126250(SQL.90).aspx http://msdn.microsoft.com/library/default.asp?url=/library/en-us/oledb/htm/olapmeasures_rowset.asp restrictions CATALOG_NAME Optional.

MDSCHEMA_MEMBERS
http://msdn2.microsoft.com/es-es/library/ms126046.aspx restrictions CATALOG_NAME Optional.

MDSCHEMA_PROPERTIES
http://msdn2.microsoft.com/en-us/library/ms126309(SQL.90).aspx http://msdn.microsoft.com/library/default.asp?url=/library/en-us/oledb/htm/olapproperties_rowset.asp 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.

MDSCHEMA_SETS
http://msdn2.microsoft.com/en-us/library/ms126290(SQL.90).aspx http://msdn.microsoft.com/library/default.asp?url=/library/en-us/oledb/htm/olapproperties_rowset.asp restrictions CATALOG_NAME Optional.

Field Summary

(package private) RowsetDefinition.Column[]	columnDefinitions
(package private) RowsetDefinition.Column[]	sortColumnDefinitions

Method Summary

(package private) Comparator<Rowset.Row>	getComparator() Returns a comparator with which to sort rows of this rowset definition.
String	getDescription()
(package private) static int	getDimensionType(Dimension dim)
abstract Rowset	getRowset(XmlaRequest request, XmlaHandler handler)
RowsetDefinition.Column	lookupColumn(String name)
(package private) static void	serialize(StringBuilder buf, Collection<String> strings)
(package private) static List<Cube>	sortedCubes(Schema schema)
static RowsetDefinition	valueOf(String name) Returns the enum constant of this type with the specified name.
static RowsetDefinition[]	values() Returns an array containing the constants of this enum type, in the order they are declared.
(package private) void	writeRowsetXmlSchema(SaxWriter writer) Generates an XML schema description to the writer.
protected void	writeRowsetXmlSchemaBottom(SaxWriter writer)
protected void	writeRowsetXmlSchemaRowDef(SaxWriter writer)
protected void	writeRowsetXmlSchemaTop(SaxWriter writer)

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

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/default.asp?url=/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 http://msdn.microsoft.com/library/default.asp?url=/library/en-us/oledb/htm/olapactions_rowset.asp 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 http://msdn.microsoft.com/library/default.asp?url=/library/en-us/oledb/htm/olapproperties_rowset.asp 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 http://msdn.microsoft.com/library/en-us/oledb/htm/olapfunctions_rowset.asp 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 http://msdn.microsoft.com/library/default.asp?url=/library/en-us/oledb/htm/olapproperties_rowset.asp 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_IS_VISIBLE 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 http://msdn.microsoft.com/library/en-us/oledb/htm/olaplevels_rowset.asp 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 http://msdn.microsoft.com/library/default.asp?url=/library/en-us/oledb/htm/olapmeasures_rowset.asp 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 of 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 of 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 http://msdn.microsoft.com/library/default.asp?url=/library/en-us/oledb/htm/olapproperties_rowset.asp 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 http://msdn.microsoft.com/library/default.asp?url=/library/en-us/oledb/htm/olapproperties_rowset.asp 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

Field Detail

columnDefinitions

final transient RowsetDefinition.Column[] columnDefinitions

sortColumnDefinitions

final transient RowsetDefinition.Column[] sortColumnDefinitions

Method Detail

values

public static RowsetDefinition[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (RowsetDefinition c : RowsetDefinition.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static RowsetDefinition valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

getRowset

public abstract Rowset getRowset(XmlaRequest request,
                                 XmlaHandler handler)

lookupColumn

public RowsetDefinition.Column lookupColumn(String name)

getComparator

Comparator<Rowset.Row> getComparator()

Returns a comparator with which to sort rows of this rowset definition. The sort order is defined by the sortColumnDefinitions field. If the rowset is not sorted, returns null.

writeRowsetXmlSchema

void writeRowsetXmlSchema(SaxWriter writer)

Generates an XML schema description to the writer. This is broken into top, Row definition and bottom so that on a case by case basis a RowsetDefinition can redefine the Row definition output. The default assumes a flat set of elements, but for example, SchemaRowsets has a element with child elements.

Parameters:

writer - SAX writer

See Also:

XmlaHandler.writeDatasetXmlSchema(SaxWriter, mondrian.xmla.XmlaHandler.SetType)

writeRowsetXmlSchemaTop

protected void writeRowsetXmlSchemaTop(SaxWriter writer)

writeRowsetXmlSchemaRowDef

protected void writeRowsetXmlSchemaRowDef(SaxWriter writer)

writeRowsetXmlSchemaBottom

protected void writeRowsetXmlSchemaBottom(SaxWriter writer)

getDescription

public String getDescription()

getDimensionType

static int getDimensionType(Dimension dim)

serialize

static void serialize(StringBuilder buf,
                      Collection<String> strings)

sortedCubes

static List<Cube> sortedCubes(Schema schema)