Pentaho Home

Mondrian Documentation

Mining Meta Model Instance mondrian

DTD Name:mondrian.dtd
Class Name:MondrianDef
Root Element:Schema
Version:1.0

Overview

This is the XML model for Mondrian schemas.

Revision is $Id$

Imports

    Element Summary

    Classes

    ElementSchema

    A schema is a collection of cubes and virtual cubes. It can also contain shared dimensions (for use by those cubes), named sets, roles, and declarations of user-defined functions.

    Attributes

    AttributeTypeDefaultDescription
    nameStringnone Name of this schema
    descriptionStringnone Description of this schema.
    measuresCaptionStringnone Label for the measures dimension. Can be localized from Properties file using #{propertyname}.
    defaultRoleStringnone The name of the default role for connections to this schema

    Content

    ElementJava NameConstraintsDescription
    AnnotationsannotationsOptional Contains values of user-defined properties.
    ParameterparametersArray This schema's parameter definitions.
    DimensiondimensionsArray Shared dimensions in this schema.
    CubecubesArray Cubes in this schema.
    VirtualCubevirtualCubesArray Virtual cubes in this schema.
    NamedSetnamedSetsArray Named sets in this schema.
    RolerolesArray Roles in this schema.
    UserDefinedFunctionuserDefinedFunctionsArray Declarations of user-defined functions in this schema.

    ElementCubeDimension

    A CubeDimension is either a usage of a Dimension ('shared dimension', in MSOLAP parlance), or a 'private dimension'.

    Attributes

    AttributeTypeDefaultDescription
    nameStringnonenone
    captionStringnone A string being displayed instead of the Dimension's name. Can be localized from Properties file using #{propertyname}.
    visibleBooleantrue Whether this dimension is visible in the user-interface. Default true.
    descriptionStringnone Description of this dimension. Can be localized from Properties file using #{propertyname}.
    foreignKeyStringnone The name of the column in the fact table which joins to the leaf level of this dimension. Required in a private Dimension or a DimensionUsage, but not in a public Dimension.
    highCardinalityBooleanfalse Flag to mark this dimension as a high cardinality one and avoid caching.

    Content

    ElementJava NameConstraintsDescription
    AnnotationsannotationsOptional Contains values of user-defined properties.

    ElementCube

    Definition of a cube.

    Attributes

    AttributeTypeDefaultDescription
    nameStringnone Name of this cube.
    captionStringnone A string being displayed instead of the cube's name. Can be localized from Properties file using #{propertyname}.
    visibleBooleantrue Whether this cube is visible in the user-interface. Default true.
    descriptionStringnone Description of this cube. Can be localized from Properties file using #{propertyname}.
    defaultMeasureStringnone The name of the measure that would be taken as the default measure of the cube.
    cacheBooleantrue Should the Fact table data for this Cube be cached by Mondrian or not. The default action is to cache the data.
    enabledBooleantrue Whether element is enabled - if true, then the Cube is realized otherwise it is ignored.

    Content

    ElementJava NameConstraintsDescription
    AnnotationsannotationsOptional Contains values of user-defined properties.
    RelationfactRequired The fact table is the source of all measures in this cube. If this is a Table and the schema name is not present, table name is left unqualified.
    CubeDimensiondimensionsArray
    MeasuremeasuresArray
    CalculatedMembercalculatedMembersArray Calculated members in this cube.
    NamedSetnamedSetsArray Named sets in this cube.

    ElementVirtualCube

    A VirtualCube is a set of dimensions and measures gleaned from other cubes.

    Attributes

    AttributeTypeDefaultDescription
    enabledBooleantrue Whether this element is enabled - if true, then the Virtual Cube is realized otherwise it is ignored.
    nameStringnone
    defaultMeasureStringnone The name of the measure that would be taken as the default measure of the cube.
    captionStringnone A string being displayed instead of the cube's name. Can be localized from Properties file using #{propertyname}.
    visibleBooleantrue Whether this cube is visible in the user-interface. Default true.
    descriptionStringnone Description of this virtual cube. Can be localized from Properties file using #{propertyname}.

    Content

    ElementJava NameConstraintsDescription
    AnnotationsannotationsOptional Contains values of user-defined properties.
    CubeUsagescubeUsageOptional
    VirtualCubeDimensiondimensionsArray
    VirtualCubeMeasuremeasuresArray
    CalculatedMembercalculatedMembersArray Calculated members that belong to this virtual cube. (Calculated members inherited from other cubes should not be in this list.)
    NamedSetnamedSetsArray Named sets in this cube.

    ElementCubeUsages

    List of base cubes used by the virtual cube.

    Attributes

    none

    Content

    ElementJava NameConstraintsDescription
    CubeUsagecubeUsagesArray [1 .. ]

    ElementCubeUsage

    Attributes

    AttributeTypeDefaultDescription
    cubeNameStringnone Name of the cube which the virtualCube uses.
    ignoreUnrelatedDimensionsBooleanfalse Unrelated dimensions to measures in this cube will be pushed to top level member.

    Content

    empty

    ElementVirtualCubeDimension

    A VirtualCubeDimension is a usage of a Dimension in a VirtualCube.

    Class

    CubeDimension

    Attributes

    AttributeTypeDefaultDescription
    cubeNameStringnone Name of the cube which the dimension belongs to, or unspecified if the dimension is shared.
    nameStringnone Name of the dimension.

    Content

    empty

    ElementVirtualCubeMeasure

    A VirtualCubeMeasure is a usage of a Measure in a VirtualCube.

    Attributes

    AttributeTypeDefaultDescription
    cubeNameStringnone Name of the cube which the measure belongs to.
    nameStringnone Unique name of the measure within its cube.
    visibleBooleannone Whether this member is visible in the user-interface. Default true.

    Content

    ElementJava NameConstraintsDescription
    AnnotationsannotationsOptional Contains values of user-defined properties.

    ElementDimensionUsage

    A DimensionUsage is usage of a shared Dimension within the context of a cube.

    Class

    CubeDimension

    Attributes

    AttributeTypeDefaultDescription
    sourceStringnone Name of the source dimension. Must be a dimension in this schema. Case-sensitive.
    levelStringnone Name of the level to join to. If not specified, joins to the lowest level of the dimension.
    usagePrefixStringnone If present, then this is prepended to the Dimension column names during the building of collapse dimension aggregates allowing 1) different dimension usages to be disambiguated during aggregate table recognition and 2) multiple shared dimensions that have common column names to be disambiguated.

    Content

    empty

    ElementDimension

    A Dimension is a collection of hierarchies. There are two kinds: a public dimension belongs to a Schema, and be used by several cubes; a private dimension belongs to a Cube. The foreignKey field is only applicable to private dimensions.

    Class

    CubeDimension

    Attributes

    AttributeTypeDefaultDescription
    nameStringnone
    typeStringnone The dimension's type may be one of "Standard" or "Time". A time dimension will allow the use of the MDX time functions (WTD, YTD, QTD, etc.). Use a standard dimension if the dimension is not a time-related dimension. The default value is "Standard".
    captionStringnone A string being displayed instead of the dimensions's name. Can be localized from Properties file using #{propertyname}.
    descriptionStringnone Description of this dimension. Can be localized from Properties file using #{propertyname}.
    usagePrefixStringnone If present, then this is prepended to the Dimension column names during the building of collapse dimension aggregates allowing 1) different dimensions to be disambiguated during aggregate table recognition. This should only be set for private dimensions.

    Content

    ElementJava NameConstraintsDescription
    HierarchyhierarchiesArray

    ElementHierarchy

    Defines a hierarchy.

    You must specify at most one <Relation> or memberReaderClass. If you specify none, the hierarchy is assumed to come from the same fact table of the current cube.

    Attributes

    AttributeTypeDefaultDescription
    nameStringnone Name of the hierarchy. If this is not specified, the hierarchy has the same name as its dimension.
    visibleBooleantrue Whether this hierarchy is visible in the user-interface. Default true.
    hasAllBooleannone Whether this hierarchy has an 'all' member.
    allMemberNameStringnone Name of the 'all' member. If this attribute is not specified, the all member is named 'All hierarchyName', for example, 'All Store'.
    allMemberCaptionStringnone A string being displayed instead as the all member's name. Can be localized from Properties file using #{propertyname}.
    allLevelNameStringnone Name of the 'all' level. If this attribute is not specified, the all member is named '(All)'. Can be localized from Properties file using #{propertyname}.
    primaryKeyStringnone The name of the column which identifies members, and which is referenced by rows in the fact table. If not specified, the key of the lowest level is used. See also CubeDimension.foreignKey.
    primaryKeyTableStringnone The name of the table which contains primaryKey. If the hierarchy has only one table, defaults to that; it is required.
    defaultMemberStringnone
    memberReaderClassStringnone Name of the custom member reader class. Must implement the mondrian.rolap.MemberReader interface.
    captionStringnone A string to be displayed in the user interface. If not specified, the hierarchy's name is used. Can be localized from Properties file using #{propertyname}.
    descriptionStringnone Description of this hierarchy. Can be localized from Properties file using #{propertyname}.
    uniqueKeyLevelNameStringnone Should be set to the level (if such a level exists) at which depth it is known that all members have entirely unique rows, allowing SQL GROUP BY clauses to be completely eliminated from the query.

    Content

    ElementJava NameConstraintsDescription
    AnnotationsannotationsOptional Contains values of user-defined properties.
    RelationOrJoinrelationOptional The {@link MondrianDef.Table table}, {@link MondrianDef.Join set of tables}, {@link MondrianDef.View SQL statement}, or {@link MondrianDef.InlineTable inline table} which populates this hierarchy.
    LevellevelsArray
    MemberReaderParametermemberReaderParametersArraynone

    ElementLevel

    Attributes

    AttributeTypeDefaultDescription
    approxRowCountStringnone The estimated number of members in this level. Setting this property improves the performance of MDSCHEMA_LEVELS, MDSCHEMA_HIERARCHIES and MDSCHEMA_DIMENSIONS XMLA requests
    nameStringnone
    visibleBooleantrue Whether this level is visible in the user-interface. Default true.
    tableStringnone The name of the table that the column comes from. If this hierarchy is based upon just one table, defaults to the name of that table; otherwise, it is required. Can be localized from Properties file using #{propertyname}.
    columnStringnone The name of the column which holds the unique identifier of this level.
    nameColumnStringnone The name of the column which holds the user identifier of this level.
    ordinalColumnStringnone The name of the column which holds member ordinals. If this column is not specified, the key column is used for ordering.
    parentColumnStringnone The name of the column which references the parent member in a parent-child hierarchy.
    nullParentValueStringnone Value which identifies null parents in a parent-child hierarchy. Typical values are 'NULL' and '0'.
    typeStringString Indicates the type of this level's key column: String, Numeric, Integer, Boolean, Date, Time or Timestamp. When generating SQL statements, Mondrian encloses values for String columns in quotation marks, but leaves values for Integer and Numeric columns un-quoted.

    Date, Time, and Timestamp values are quoted according to the SQL dialect. For a SQL-compliant dialect, the values appear prefixed by their typename, for example, "DATE '2006-06-01'".
    internalTypeStringnone Indicates the Java type that Mondrian uses to store this level's key column. It also determines the JDBC method that Mondrian will call to retrieve the column; for example, if the Java type is 'int', Mondrian will call 'ResultSet.getInt(int)'.

    Usually this attribute is not needed, because Mondrian can choose a sensible type based on the type of the database column.

    Allowable values are: 'int', 'long', 'Object', 'String'.
    uniqueMembersBooleanfalse Whether members are unique across all parents. For example, zipcodes are unique across all states. The first level's members are always unique.
    levelTypeStringRegular Whether this is a regular or a time-related level. The value makes a difference to time-related functions such as YTD (year-to-date).

    The "TimeHalfYear" value is deprecated and will be removed in mondrian-4.0; use "TimeHalfYears" instead.

    hideMemberIfStringNever Condition which determines whether a member of this level is hidden. If a hierarchy has one or more levels with hidden members, then it is possible that not all leaf members are the same distance from the root, and it is termed a ragged hierarchy.

    Allowable values are: Never (a member always appears; the default); IfBlankName (a member doesn't appear if its name is null, empty or all whitespace); and IfParentsName (a member appears unless its name matches the parent's.

    formatterStringnone Name of a formatter class for the member labels being displayed. The class must implement the mondrian.spi.MemberFormatter interface.

    This attribute is deprecated. Please use a nested MemberFormatter element.

    captionStringnone A string being displayed instead of the level's name. Can be localized from Properties file using #{propertyname}.
    descriptionStringnone Description of this level. Can be localized from Properties file using #{propertyname}.
    captionColumnStringnone The name of the column which holds the caption for members.

    Content

    ElementJava NameConstraintsDescription
    AnnotationsannotationsOptional Contains values of user-defined properties.
    KeyExpressionkeyExpOptional The SQL expression used to populate this level's key.
    NameExpressionnameExpOptional The SQL expression used to populate this level's name. If not specified, the level's key is used.
    CaptionExpressioncaptionExpOptional The SQL expression used to populate this level's caption. If not specified, the level's name is used.
    OrdinalExpressionordinalExpOptional The SQL expression used to populate this level's ordinal.
    ParentExpressionparentExpOptional The SQL expression used to join to the parent member in a parent-child hierarchy.
    MemberFormattermemberFormatterOptional Member formatter.
    ClosureclosureOptionalnone
    PropertypropertiesArray [0 .. ]none

    ElementClosure

    Specifies the transitive closure of a parent-child hierarchy. Optional, but recommended for better performance. The closure is provided as a set of (parent/child) pairs: since it is the transitive closure these are actually (ancestor/descendant) pairs.

    Attributes

    AttributeTypeDefaultDescription
    parentColumnStringnonenone
    childColumnStringnonenone

    Content

    ElementJava NameConstraintsDescription
    TabletableRequirednone

    ElementProperty

    Member property.

    Attributes

    AttributeTypeDefaultDescription
    nameStringnone
    columnStringnone
    typeStringString Data type of this property: String, Numeric, Integer, Boolean, Date, Time or Timestamp.
    formatterStringnone

    Name of a formatter class for the appropriate property value being displayed.

    The class must implement the mondrian.spi.PropertyFormatter interface.

    This attribute is deprecated. Please use a nested PropertyFormatter element.

    captionStringnone A string being displayed instead of the name. Can be localized from Properties file using #{propertyname}.
    descriptionStringnone Description of this member property. Can be localized from Properties file using #{propertyname}.
    dependsOnLevelValueBooleannone Should be set to true if the value of the property is functionally dependent on the level value. This permits the associated property column to be omitted from the GROUP BY clause (if the database permits columns in the SELECT that are not in the GROUP BY). This can be a significant performance enhancement on some databases, such as MySQL.

    Content

    ElementJava NameConstraintsDescription
    PropertyFormatterpropertyFormatterOptional Property formatter.

    ElementMeasure

    Attributes

    AttributeTypeDefaultDescription
    nameStringnone Name of this measure.
    columnStringnone Column which is source of this measure's values. If not specified, a measure expression must be specified.
    datatypeStringnone The datatype of this measure: String, Numeric, Integer, Boolean, Date, Time or Timestamp.

    The default datatype of a measure is 'Integer' if the measure's aggregator is 'Count', otherwise it is 'Numeric'.
    formatStringStringnone Format string with which to format cells of this measure. For more details, see the mondrian.util.Format class.
    aggregatorStringnone Aggregation function. Allowed values are "sum", "count", "min", "max", "avg", and "distinct-count". ("distinct count" is allowed for backwards compatibility, but is deprecated because XML enumerated attributes in a DTD cannot legally contain spaces.)
    formatterStringnone

    Name of a formatter class for the appropriate cell being displayed.

    The class must implement the mondrian.spi.CellFormatter interface.

    This attribute is deprecated. Please use a nested CellFormatter element.

    captionStringnone A string being displayed instead of the name. Can be localized from Properties file using #{propertyname}.
    descriptionStringnone Description of this measure. Can be localized from Properties file using #{propertyname}.
    visibleBooleannone Whether this member is visible in the user-interface. Default true.

    Content

    ElementJava NameConstraintsDescription
    AnnotationsannotationsOptional Contains values of user-defined properties.
    MeasureExpressionmeasureExpOptional The SQL expression used to calculate a measure. Must be specified if a source column is not specified.
    CellFormattercellFormatterOptional Cell formatter.
    CalculatedMemberPropertymemberPropertiesArray [0 .. ]none

    ElementCalculatedMember

    Attributes

    AttributeTypeDefaultDescription
    nameStringnone Name of this calculated member.
    formatStringStringnone Format string with which to format cells of this member. For more details, see {@link mondrian.util.Format}.
    captionStringnone A string being displayed instead of the name. Can be localized from Properties file using #{propertyname}.
    descriptionStringnone Description of this calculated member. Can be localized from Properties file using #{propertyname}.
    formulaStringnone MDX expression which gives the value of this member. Equivalent to the Formula sub-element.
    dimensionStringnone

    Name of the dimension that this member belongs to.

    Deprecated: use {@code hierarchy} attribute instead.

    hierarchyStringnone

    Name of the hierarchy that this member belongs to.

    parentStringnone Fully-qualified name of the parent member. If not specified, the member will be at the lowest level (besides the 'all' level) in the hierarchy.
    visibleBooleannone Whether this member is visible in the user-interface. Default true.

    Content

    ElementJava NameConstraintsDescription
    AnnotationsannotationsOptional Contains values of user-defined properties.
    FormulaformulaElementOptional MDX expression which gives the value of this member.
    CellFormattercellFormatterOptional Cell formatter.
    CalculatedMemberPropertymemberPropertiesArray [0 .. ]none

    ElementCalculatedMemberProperty

    Property of a calculated member defined against a cube. It must have either an expression or a value.

    Attributes

    AttributeTypeDefaultDescription
    nameStringnone Name of this member property.
    captionStringnone A string being displayed instead of the name of this calculated member property. Can be localized from Properties file using #{propertyname}.
    descriptionStringnone Description of this calculated member property. Can be localized from Properties file using #{propertyname}.
    expressionStringnone MDX expression which defines the value of this property. If the expression is a constant string, you could enclose it in quotes, or just specify the 'value' attribute instead.
    valueStringnone Value of this property. If the value is not constant, specify the 'expression' attribute instead.

    Content

    empty

    ElementNamedSet

    <p>Defines a named set which can be used in queries in the same way as a set defined using a WITH SET clause.</p> <p>A named set can be defined against a particular cube, or can be global to a schema. If it is defined against a cube, it is only available to queries which use that cube.</p> <p>A named set defined against a cube is not inherited by a virtual cubes defined against that cube. (But you can define a named set against a virtual cube.)</p> <p>A named set defined against a schema is available in all cubes and virtual cubes in that schema. However, it is only valid if the cube contains dimensions with the names required to make the formula valid.</p>

    Attributes

    AttributeTypeDefaultDescription
    nameStringnone Name of this named set.
    captionStringnone Caption of this named set. Can be localized from Properties file using #{propertyname}.
    descriptionStringnone Description of this named set. Can be localized from Properties file using #{propertyname}.
    formulaStringnone MDX expression which gives the value of this set. Equivalent to the Formula sub-element.

    Content

    ElementJava NameConstraintsDescription
    AnnotationsannotationsOptional Contains values of user-defined properties.
    FormulaformulaElementOptional MDX expression which gives the value of this set.

    ElementFormula

    Attributes

    none

    Content

    Text

    ElementMemberReaderParameter

    Not used

    Attributes

    AttributeTypeDefaultDescription
    nameStringnonenone
    valueStringnonenone

    Content

    empty

    ElementRelationOrJoin

    A table or a join

    Attributes

    none

    Content

    empty

    ElementRelation

    A table, inline table or view

    Class

    RelationOrJoin

    Attributes

    none

    Content

    empty

    ElementView

    A collection of SQL statements, one per dialect.

    Class

    Relation

    Attributes

    AttributeTypeDefaultDescription
    aliasStringnonenone

    Content

    ElementJava NameConstraintsDescription
    SQLselectsArray [1 .. ]none

    ElementSQL

    Attributes

    AttributeTypeDefaultDescription
    dialectStringgeneric Dialect of SQL the view is intended for. Valid values include, but are not limited to:
    • generic
    • access
    • db2
    • derby
    • firebird
    • hsqldb
    • mssql
    • mysql
    • oracle
    • postgres
    • sybase
    • teradata
    • ingres
    • infobright
    • luciddb
    • vertica
    • neoview

    Content

    Text

    ElementJoin

    Class

    RelationOrJoin

    Attributes

    AttributeTypeDefaultDescription
    leftAliasStringnone Defaults to left's alias if left is a table, otherwise required.
    leftKeyStringnonenone
    rightAliasStringnone Defaults to right's alias if right is a table, otherwise required.
    rightKeyStringnonenone

    Content

    ElementJava NameConstraintsDescription
    RelationOrJoinleftRequirednone
    RelationOrJoinrightRequirednone

    ElementTable

    Class

    Relation

    Attributes

    AttributeTypeDefaultDescription
    nameStringnonenone
    schemaStringnone Optional qualifier for table.
    aliasStringnone Alias to be used with this table when it is used to form queries. If not specified, defaults to the table name, but in any case, must be unique within the schema. (You can use the same table in different hierarchies, but it must have different aliases.)

    Content

    ElementJava NameConstraintsDescription
    SQLfilterOptional The SQL WHERE clause expression to be appended to any select statement
    AggExcludeaggExcludesArraynone
    AggTableaggTablesArraynone
    HinttableHintsArray Table optimization hints; may be ignored by dialect.

    ElementHint

    Dialect-specific table optimization hints.

    Attributes

    AttributeTypeDefaultDescription
    typeStringnone Type of hint, interpreted and applied on a per-dialect basis.

    Content

    Text

    ElementInlineTable

    Class

    Relation

    Attributes

    AttributeTypeDefaultDescription
    aliasStringnone Alias to be used with this table when it is used to form queries. If not specified, defaults to the table name, but in any case, must be unique within the schema. (You can use the same table in different hierarchies, but it must have different aliases.)

    Content

    ElementJava NameConstraintsDescription
    ColumnDefscolumnDefsRequirednone
    RowsrowsRequirednone

    ElementColumnDefs

    Holder for an array of ColumnDef elements

    Attributes

    none

    Content

    ElementJava NameConstraintsDescription
    ColumnDefarrayArraynone

    ElementColumnDef

    Column definition for an inline table.

    Attributes

    AttributeTypeDefaultDescription
    nameStringnone Name of the column.
    typeStringnone Type of the column: String, Numeric, Integer, Boolean, Date, Time or Timestamp.

    Content

    empty

    ElementRows

    Holder for an array of Row elements

    Attributes

    none

    Content

    ElementJava NameConstraintsDescription
    RowarrayArraynone

    ElementRow

    Row definition for an inline table. Must have one Column for each ColumnDef in the InlineTable.

    Attributes

    none

    Content

    ElementJava NameConstraintsDescription
    ValuevaluesArraynone

    ElementValue

    Column value for an inline table. The CDATA holds the value of the column.

    Attributes

    AttributeTypeDefaultDescription
    columnStringnone Name of the column.

    Content

    Text

    ElementAggTable

    A definition of an aggregate table for a base fact table. This aggregate table must be in the same schema as the base fact table.

    Attributes

    AttributeTypeDefaultDescription
    ignorecaseBooleantrue Whether or not the match should ignore case.

    Content

    ElementJava NameConstraintsDescription
    AggFactCountfactcountRequired What does the fact_count column look like.
    AggIgnoreColumnignoreColumnsArraynone
    AggForeignKeyforeignKeysArraynone
    AggMeasuremeasuresArraynone
    AggLevellevelsArraynone

    ElementAggName

    Class

    AggTable

    Attributes

    AttributeTypeDefaultDescription
    nameStringnone The Table name of a Specific aggregate table.
    approxRowCountStringnone The estimated number of rows in this aggregation table. Setting this property improves the performance of the aggregation optimizer and prevents it from issuing a 'select count(*)' query over the aggregation table.

    Content

    empty

    ElementAggPattern

    Class

    AggTable

    Attributes

    AttributeTypeDefaultDescription
    patternStringnone A Table pattern used to define a set of aggregate tables.

    Content

    ElementJava NameConstraintsDescription
    AggExcludeexcludesArraynone

    ElementAggExclude

    Attributes

    AttributeTypeDefaultDescription
    patternStringnone A Table pattern not to be matched.
    nameStringnone The Table name not to be matched.
    ignorecaseBooleantrue Whether or not the match should ignore case.

    Content

    empty

    ElementAggColumnName

    Attributes

    AttributeTypeDefaultDescription
    columnStringnone The name of the fact count column.

    Content

    empty

    ElementAggFactCount

    Class

    AggColumnName

    Attributes

    none

    Content

    empty

    ElementAggIgnoreColumn

    Class

    AggColumnName

    Attributes

    none

    Content

    empty

    ElementAggForeignKey

    The name of the column mapping from base fact table foreign key to aggregate table foreign key.

    Attributes

    AttributeTypeDefaultDescription
    factColumnStringnone The name of the base fact table foreign key.
    aggColumnStringnone The name of the aggregate table foreign key.

    Content

    empty

    ElementAggLevel

    Attributes

    AttributeTypeDefaultDescription
    columnStringnone The name of the column mapping to the level name.
    nameStringnone The name of the Dimension Hierarchy level.
    collapsedBooleantrue Whether this is a collapsed level. The parents of that level are also present in the aggregation table.

    Content

    empty

    ElementAggMeasure

    Attributes

    AttributeTypeDefaultDescription
    columnStringnone The name of the column mapping to the measure name.
    nameStringnone The name of the Cube measure.

    Content

    empty

    ElementColumn

    Class

    Expression

    Attributes

    AttributeTypeDefaultDescription
    tableStringnone Alias of the table which contains this column. Not required if the query only has one table.
    nameStringnone Name of the column.

    Content

    empty

    ElementExpressionView

    A collection of SQL expressions, one per dialect.

    Class

    Expression

    Attributes

    none

    Content

    ElementJava NameConstraintsDescription
    SQLexpressionsArray [1 .. ]none

    ElementKeyExpression

    Class

    ExpressionView

    Attributes

    none

    Content

    empty

    ElementParentExpression

    Class

    ExpressionView

    Attributes

    none

    Content

    empty

    ElementOrdinalExpression

    Class

    ExpressionView

    Attributes

    none

    Content

    empty

    ElementNameExpression

    Class

    ExpressionView

    Attributes

    none

    Content

    empty

    ElementCaptionExpression

    Class

    ExpressionView

    Attributes

    none

    Content

    empty

    ElementMeasureExpression

    Class

    ExpressionView

    Attributes

    none

    Content

    empty

    ElementRole

    A role defines an access-control profile. It has a series of grants (or denials) for schema elements.

    Attributes

    AttributeTypeDefaultDescription
    nameStringnonenone

    Content

    ElementJava NameConstraintsDescription
    AnnotationsannotationsOptional Contains values of user-defined properties.
    SchemaGrantschemaGrantsArraynone
    UnionunionOptionalnone

    ElementSchemaGrant

    Grants (or denies) this role access to this schema. access may be "all", "all_dimensions", "custom" or "none". If access is "all_dimensions", the role has access to all dimensions but still needs explicit access to cubes. If access is "custom", no access will be inherited by cubes for which no explicit rule is set. If access is "all_dimensions", an implicut access is given to all dimensions of the schema's cubes, provided the cube's access attribute is either "custom" or "all". See mondrian.olap.Role#grant(mondrian.olap.Schema,int).

    Class

    Grant

    Attributes

    none

    Content

    ElementJava NameConstraintsDescription
    CubeGrantcubeGrantsArraynone

    ElementCubeGrant

    Grants (or denies) this role access to a cube. access may be "all", "custom", or "none". If access is "custom", no access will be inherited by the dimensions of this cube, unless the parent SchemaGrant is set to "ALL_DIMENSIONS". See mondrian.olap.Role#grant(mondrian.olap.Cube,int).

    Class

    Grant

    Attributes

    AttributeTypeDefaultDescription
    cubeStringnone The unique name of the cube

    Content

    ElementJava NameConstraintsDescription
    DimensionGrantdimensionGrantsArraynone
    HierarchyGranthierarchyGrantsArraynone

    ElementDimensionGrant

    Grants (or denies) this role access to a dimension. access may be "all", "custom" or "none". Note that a role is implicitly given access to a dimension when it is given "ALL" acess to a cube. If access is "custom", no access will be inherited by the hierarchies of this dimension. If the parent schema access is "ALL_DIMENSIONS", this timension will inherit access "ALL". See also the "all_dimensions" option of the "SchemaGrant" element. See mondrian.olap.Role#grant(mondrian.olap.Dimension,int).

    Class

    Grant

    Attributes

    AttributeTypeDefaultDescription
    dimensionStringnone The unique name of the dimension

    Content

    empty

    ElementHierarchyGrant

    Grants (or denies) this role access to a hierarchy. access may be "all", "custom" or "none". If access is "custom", you may also specify the attributes topLevel, bottomLevel, and the member grants. If access is "custom", the child levels of this hierarchy will not inherit access rights from this hierarchy, should there be no explicit rules defined for the said child level. See mondrian.olap.Role#grant(mondrian.olap.Hierarchy, int, mondrian.olap.Level).

    Class

    Grant

    Attributes

    AttributeTypeDefaultDescription
    hierarchyStringnone The unique name of the hierarchy
    topLevelStringnone Unique name of the highest level of the hierarchy from which this role is allowed to see members. May only be specified if the HierarchyGrant.access is "custom". If not specified, role can see members up to the top level.
    bottomLevelStringnone Unique name of the lowest level of the hierarchy from which this role is allowed to see members. May only be specified if the HierarchyGrant.access is "custom". If not specified, role can see members down to the leaf level.
    rollupPolicyStringnone Policy which determines how cell values are calculated if not all of the children of the current cell are visible to the current role. Allowable values are 'full' (the default), 'partial', and 'hidden'.

    Content

    ElementJava NameConstraintsDescription
    MemberGrantmemberGrantsArraynone

    ElementMemberGrant

    Grants (or denies) this role access to a member. The children of this member inherit that access. You can implicitly see a member if you can see any of its children. See mondrian.olap.Role#grant(mondrian.olap.Member,int).

    Attributes

    AttributeTypeDefaultDescription
    memberStringnone The unique name of the member
    accessStringnonenone

    Content

    empty

    ElementUnion

    Body of a Role definition which defines a Role to be the union of several Roles. The RoleUsage elements must refer to Roles that have been declared earlier in this schema file.

    Attributes

    none

    Content

    ElementJava NameConstraintsDescription
    RoleUsageroleUsagesRequirednone

    ElementRoleUsage

    Usage of a Role in a union Role.

    Attributes

    AttributeTypeDefaultDescription
    roleNameStringnonenone

    Content

    empty

    ElementUserDefinedFunction

    A UserDefinedFunction is a function which extends the MDX language. It must be implemented by a Java class which implements the interface mondrian.spi.UserDefinedFunction.

    Attributes

    AttributeTypeDefaultDescription
    nameStringnone Name with which the user-defined function will be referenced in MDX expressions.
    classNameStringnone Name of the class which implemenets this user-defined function. Must implement the mondrian.spi.UserDefinedFunction interface.

    Content

    ElementJava NameConstraintsDescription
    ScriptscriptOptional Script to implement this user-defined function.

    Either the "Script" element or the "className" attribute must be specified.

    ElementParameter

    A Parameter defines a schema parameter. It can be referenced from an MDX statement using the ParamRef function and, if not final, its value can be overridden.

    Attributes

    AttributeTypeDefaultDescription
    nameStringnone Name of this parameter.
    descriptionStringnone Description of this parameter.
    typeStringString Indicates the type of this parameter: String, Numeric, Integer, Boolean, Date, Time, Timestamp, or Member.
    modifiableBooleantrue If false, statement cannot change the value of this parameter; the parameter becomes effectively constant (provided that its default value expression always returns the same value). Default is true.
    defaultValueStringnone Expression for the default value of this parameter.

    Content

    empty

    ElementAnnotations

    Holder for an array of Annotation elements

    Attributes

    none

    Content

    ElementJava NameConstraintsDescription
    AnnotationarrayArraynone

    ElementAnnotation

    User-defined property value.

    Attributes

    AttributeTypeDefaultDescription
    nameStringnone Name of the annotation.

    Content

    Text

    ElementScript

    Script fragment to implement an SPI such as user-defined function, member formatter, cell formatter.

    Attributes

    AttributeTypeDefaultDescription
    languageStringJavaScript The language of the script. Must be a supported scripting language in the current JVM. See {@link javax.script.ScriptEngineManager}. Default value is 'JavaScript'.

    Content

    Text

    ElementCellFormatter

    Plugin that formats the values of cells. It must be implemented by a Java class which implements the interface mondrian.spi.CellFormatter, or by a script.

    Attributes

    AttributeTypeDefaultDescription
    classNameStringnone Name of the class which implemenets this cell formatter. Must implement the mondrian.spi.CellFormatter interface.

    Either the "Script" element or the "className" attribute must be specified.

    Content

    ElementJava NameConstraintsDescription
    ScriptscriptOptional Script to implement this cell formatter.

    Either the "Script" element or the "className" attribute must be specified.

    ElementMemberFormatter

    Plugin that formats members. It must be implemented by a Java class which implements the interface mondrian.spi.MemberFormatter, or by a script.

    Attributes

    AttributeTypeDefaultDescription
    classNameStringnone Name of the class which implemenets this member formatter. Must implement the mondrian.spi.MemberFormatter interface.

    Either the "Script" element or the "className" attribute must be specified.

    Content

    ElementJava NameConstraintsDescription
    ScriptscriptOptional Script to implement this member formatter.

    Either the "Script" element or the "className" attribute must be specified.

    ElementPropertyFormatter

    Plugin that formats properties. It must be implemented by a Java class which implements the interface mondrian.spi.PropertyFormatter, or by a script.

    Attributes

    AttributeTypeDefaultDescription
    classNameStringnone Name of the class which implemenets this property formatter. Must implement the mondrian.spi.PropertyFormatter interface.

    Either the "Script" element or the "className" attribute must be specified.

    Content

    ElementJava NameConstraintsDescription
    ScriptscriptOptional Script to implement this property formatter.

    Either the "Script" element or the "className" attribute must be specified.

    ClassExpression

    Attributes

    none

    Content

    empty

    ClassGrant

    Attributes

    AttributeTypeDefaultDescription
    accessStringnone Values correspond to Access.

    Content

    empty