|
Mining Meta Model Instance mondrian
DTD Name:mondrian.dtd
Class Name:MondrianDef
Root Element:Schema
Version:1.0
This is the XML model for Mondrian schemas.
Revision is $Id$
Imports
Element Summary
Classes
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
Attribute | Type | Default | Description |
name | String | none |
Name of this schema
|
description | String | none |
Description of this schema.
|
measuresCaption | String | none |
Label for the measures dimension.
Can be localized from Properties file using #{propertyname}.
|
defaultRole | String | none |
The name of the default role for connections to this schema
|
Content
Element | Java Name | Constraints | Description |
Annotations | annotations | Optional |
Contains values of user-defined properties.
|
Parameter | parameters | Array |
This schema's parameter definitions.
|
Dimension | dimensions | Array |
Shared dimensions in this schema.
|
Cube | cubes | Array |
Cubes in this schema.
|
VirtualCube | virtualCubes | Array |
Virtual cubes in this schema.
|
NamedSet | namedSets | Array |
Named sets in this schema.
|
Role | roles | Array |
Roles in this schema.
|
UserDefinedFunction | userDefinedFunctions | Array |
Declarations of user-defined functions in this schema.
|
A CubeDimension is either a usage of a Dimension ('shared
dimension', in MSOLAP parlance), or a 'private dimension'.
Attributes
Attribute | Type | Default | Description |
name | String | none | none |
caption | String | none |
A string being displayed instead of the Dimension's name.
Can be localized from Properties file using #{propertyname}.
|
visible | Boolean | true |
Whether this dimension is visible in the user-interface.
Default true.
|
description | String | none |
Description of this dimension.
Can be localized from Properties file using #{propertyname}.
|
foreignKey | String | none |
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.
|
highCardinality | Boolean | false |
Flag to mark this dimension as a high cardinality one
and avoid caching.
|
Content
Element | Java Name | Constraints | Description |
Annotations | annotations | Optional |
Contains values of user-defined properties.
|
Definition of a cube.
Attributes
Attribute | Type | Default | Description |
name | String | none |
Name of this cube.
|
caption | String | none |
A string being displayed instead of the cube's name.
Can be localized from Properties file using #{propertyname}.
|
visible | Boolean | true |
Whether this cube is visible in the user-interface.
Default true.
|
description | String | none |
Description of this cube.
Can be localized from Properties file using #{propertyname}.
|
defaultMeasure | String | none |
The name of the measure that would be taken as the default
measure of the cube.
|
cache | Boolean | true |
Should the Fact table data for this Cube be cached
by Mondrian or not. The default action is to cache
the data.
|
enabled | Boolean | true |
Whether element is enabled - if true, then the Cube is
realized otherwise it is ignored.
|
Content
Element | Java Name | Constraints | Description |
Annotations | annotations | Optional |
Contains values of user-defined properties.
|
Relation | fact | Required |
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.
|
CubeDimension | dimensions | Array |
|
Measure | measures | Array |
|
CalculatedMember | calculatedMembers | Array |
Calculated members in this cube.
|
NamedSet | namedSets | Array |
Named sets in this cube.
|
A VirtualCube is a set of dimensions and
measures gleaned from other cubes.
Attributes
Attribute | Type | Default | Description |
enabled | Boolean | true |
Whether this element is enabled - if true, then the Virtual
Cube is realized otherwise it is ignored.
|
name | String | none |
|
defaultMeasure | String | none |
The name of the measure that would be taken as the default
measure of the cube.
|
caption | String | none |
A string being displayed instead of the cube's name.
Can be localized from Properties file using #{propertyname}.
|
visible | Boolean | true |
Whether this cube is visible in the user-interface.
Default true.
|
description | String | none |
Description of this virtual cube.
Can be localized from Properties file using #{propertyname}.
|
Content
Element | Java Name | Constraints | Description |
Annotations | annotations | Optional |
Contains values of user-defined properties.
|
CubeUsages | cubeUsage | Optional |
|
VirtualCubeDimension | dimensions | Array |
|
VirtualCubeMeasure | measures | Array |
|
CalculatedMember | calculatedMembers | Array |
Calculated members that belong to this virtual cube.
(Calculated members inherited from other cubes should not be
in this list.)
|
NamedSet | namedSets | Array |
Named sets in this cube.
|
List of base cubes used by the virtual cube.
Attributes
none
Content
Element | Java Name | Constraints | Description |
CubeUsage | cubeUsages | Array [1 ..
] |
|
Attributes
Attribute | Type | Default | Description |
cubeName | String | none |
Name of the cube which the virtualCube uses.
|
ignoreUnrelatedDimensions | Boolean | false |
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
Attribute | Type | Default | Description |
cubeName | String | none |
Name of the cube which the dimension belongs to, or
unspecified if the dimension is shared.
|
name | String | none |
Name of the dimension.
|
Content
empty
ElementVirtualCubeMeasure
|
A VirtualCubeMeasure is a usage of a Measure in a VirtualCube.
Attributes
Attribute | Type | Default | Description |
cubeName | String | none |
Name of the cube which the measure belongs to.
|
name | String | none |
Unique name of the measure within its cube.
|
visible | Boolean | none |
Whether this member is visible in the user-interface.
Default true.
|
Content
Element | Java Name | Constraints | Description |
Annotations | annotations | Optional |
Contains values of user-defined properties.
|
A DimensionUsage is usage of a shared
Dimension within the context of a cube.
Class
CubeDimension
Attributes
Attribute | Type | Default | Description |
source | String | none |
Name of the source dimension. Must be a dimension in
this schema. Case-sensitive.
|
level | String | none |
Name of the level to join to. If not specified, joins to the
lowest level of the dimension.
|
usagePrefix | String | none |
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
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
Attribute | Type | Default | Description |
name | String | none |
|
type | String | none |
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" .
|
caption | String | none |
A string being displayed instead of the dimensions's name.
Can be localized from Properties file using #{propertyname}.
|
description | String | none |
Description of this dimension.
Can be localized from Properties file using #{propertyname}.
|
usagePrefix | String | none |
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
Element | Java Name | Constraints | Description |
Hierarchy | hierarchies | Array |
|
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
Attribute | Type | Default | Description |
name | String | none |
Name of the hierarchy. If this is not specified, the hierarchy
has the same name as its dimension.
|
visible | Boolean | true |
Whether this hierarchy is visible in the user-interface.
Default true.
|
hasAll | Boolean | none |
Whether this hierarchy has an 'all' member.
|
allMemberName | String | none |
Name of the 'all' member. If this attribute is not specified,
the all member is named 'All hierarchyName', for
example, 'All Store'.
|
allMemberCaption | String | none |
A string being displayed instead as the all member's name.
Can be localized from Properties file using #{propertyname}.
|
allLevelName | String | none |
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}.
|
primaryKey | String | none |
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 .
|
primaryKeyTable | String | none |
The name of the table which contains primaryKey .
If the hierarchy has only one table, defaults to that;
it is required.
|
defaultMember | String | none |
|
memberReaderClass | String | none |
Name of the custom member reader class. Must implement
the mondrian.rolap.MemberReader interface.
|
caption | String | none |
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}.
|
description | String | none |
Description of this hierarchy.
Can be localized from Properties file using #{propertyname}.
|
uniqueKeyLevelName | String | none |
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
Element | Java Name | Constraints | Description |
Annotations | annotations | Optional |
Contains values of user-defined properties.
|
RelationOrJoin | relation | Optional |
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.
|
Level | levels | Array |
|
MemberReaderParameter | memberReaderParameters | Array | none |
Attributes
Attribute | Type | Default | Description |
approxRowCount | String | none |
The estimated number of members in this level.
Setting this property improves the performance of
MDSCHEMA_LEVELS, MDSCHEMA_HIERARCHIES and
MDSCHEMA_DIMENSIONS XMLA requests
|
name | String | none |
|
visible | Boolean | true |
Whether this level is visible in the user-interface.
Default true.
|
table | String | none |
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}.
|
column | String | none |
The name of the column which holds the unique identifier of
this level.
|
nameColumn | String | none |
The name of the column which holds the user identifier of
this level.
|
ordinalColumn | String | none |
The name of the column which holds member
ordinals. If this column is not specified, the
key column is used for ordering.
|
parentColumn | String | none |
The name of the column which references the parent member in
a parent-child hierarchy.
|
nullParentValue | String | none |
Value which identifies null parents in a parent-child
hierarchy. Typical values are 'NULL' and '0'.
|
type | String | String |
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'".
|
internalType | String | none |
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'.
|
uniqueMembers | Boolean | false |
Whether members are unique across all parents. For
example, zipcodes are unique across all states. The
first level's members are always unique.
|
levelType | String | Regular |
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.
|
hideMemberIf | String | Never |
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.
|
formatter | String | none |
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.
|
caption | String | none |
A string being displayed instead of the level's name.
Can be localized from Properties file using #{propertyname}.
|
description | String | none |
Description of this level.
Can be localized from Properties file using #{propertyname}.
|
captionColumn | String | none |
The name of the column which holds the caption for
members.
|
Content
Element | Java Name | Constraints | Description |
Annotations | annotations | Optional |
Contains values of user-defined properties.
|
KeyExpression | keyExp | Optional |
The SQL expression used to populate this level's key.
|
NameExpression | nameExp | Optional |
The SQL expression used to populate this level's name. If not
specified, the level's key is used.
|
CaptionExpression | captionExp | Optional |
The SQL expression used to populate this level's caption. If not
specified, the level's name is used.
|
OrdinalExpression | ordinalExp | Optional |
The SQL expression used to populate this level's ordinal.
|
ParentExpression | parentExp | Optional |
The SQL expression used to join to the parent member in a
parent-child hierarchy.
|
MemberFormatter | memberFormatter | Optional |
Member formatter.
|
Closure | closure | Optional | none |
Property | properties | Array [0 ..
] | none |
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
Attribute | Type | Default | Description |
parentColumn | String | none | none |
childColumn | String | none | none |
Content
Element | Java Name | Constraints | Description |
Table | table | Required | none |
Member property.
Attributes
Attribute | Type | Default | Description |
name | String | none |
|
column | String | none |
|
type | String | String |
Data type of this property:
String, Numeric, Integer, Boolean, Date, Time or Timestamp.
|
formatter | String | none |
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.
|
caption | String | none |
A string being displayed instead of the name.
Can be localized from Properties file using #{propertyname}.
|
description | String | none |
Description of this member property.
Can be localized from Properties file using #{propertyname}.
|
dependsOnLevelValue | Boolean | none |
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
Element | Java Name | Constraints | Description |
PropertyFormatter | propertyFormatter | Optional |
Property formatter.
|
Attributes
Attribute | Type | Default | Description |
name | String | none |
Name of this measure.
|
column | String | none |
Column which is source of this measure's values.
If not specified, a measure expression must be specified.
|
datatype | String | none |
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'.
|
formatString | String | none |
Format string with which to format cells of this measure. For
more details, see the mondrian.util.Format class.
|
aggregator | String | none |
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.)
|
formatter | String | none |
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.
|
caption | String | none |
A string being displayed instead of the name.
Can be localized from Properties file using #{propertyname}.
|
description | String | none |
Description of this measure.
Can be localized from Properties file using #{propertyname}.
|
visible | Boolean | none |
Whether this member is visible in the user-interface.
Default true.
|
Content
Element | Java Name | Constraints | Description |
Annotations | annotations | Optional |
Contains values of user-defined properties.
|
MeasureExpression | measureExp | Optional |
The SQL expression used to calculate a measure.
Must be specified if a source column is not specified.
|
CellFormatter | cellFormatter | Optional |
Cell formatter.
|
CalculatedMemberProperty | memberProperties | Array [0 ..
] | none |
Attributes
Attribute | Type | Default | Description |
name | String | none |
Name of this calculated member.
|
formatString | String | none |
Format string with which to format cells of this member. For
more details, see {@link mondrian.util.Format}.
|
caption | String | none |
A string being displayed instead of the name.
Can be localized from Properties file using #{propertyname}.
|
description | String | none |
Description of this calculated member.
Can be localized from Properties file using #{propertyname}.
|
formula | String | none |
MDX expression which gives the value of this member.
Equivalent to the Formula sub-element.
|
dimension | String | none |
Name of the dimension that this member belongs to.
Deprecated: use {@code hierarchy} attribute instead.
|
hierarchy | String | none |
Name of the hierarchy that this member belongs to.
|
parent | String | none |
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.
|
visible | Boolean | none |
Whether this member is visible in the user-interface.
Default true.
|
Content
Element | Java Name | Constraints | Description |
Annotations | annotations | Optional |
Contains values of user-defined properties.
|
Formula | formulaElement | Optional |
MDX expression which gives the value of this member.
|
CellFormatter | cellFormatter | Optional |
Cell formatter.
|
CalculatedMemberProperty | memberProperties | Array [0 ..
] | none |
ElementCalculatedMemberProperty
|
Property of a calculated member defined against a cube.
It must have either an expression or a value.
Attributes
Attribute | Type | Default | Description |
name | String | none |
Name of this member property.
|
caption | String | none |
A string being displayed instead of the name of this calculated
member property.
Can be localized from Properties file using #{propertyname}.
|
description | String | none |
Description of this calculated member property.
Can be localized from Properties file using #{propertyname}.
|
expression | String | none |
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.
|
value | String | none |
Value of this property.
If the value is not constant, specify the 'expression' attribute
instead.
|
Content
empty
<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
Attribute | Type | Default | Description |
name | String | none |
Name of this named set.
|
caption | String | none |
Caption of this named set.
Can be localized from Properties file using #{propertyname}.
|
description | String | none |
Description of this named set.
Can be localized from Properties file using #{propertyname}.
|
formula | String | none |
MDX expression which gives the value of this set.
Equivalent to the Formula sub-element.
|
Content
Element | Java Name | Constraints | Description |
Annotations | annotations | Optional |
Contains values of user-defined properties.
|
Formula | formulaElement | Optional |
MDX expression which gives the value of this set.
|
Attributes
none
Content
Text
ElementMemberReaderParameter
|
Not used
Attributes
Attribute | Type | Default | Description |
name | String | none | none |
value | String | none | none |
Content
empty
A table or a join
Attributes
none
Content
empty
A table, inline table or view
Class
RelationOrJoin
Attributes
none
Content
empty
A collection of SQL statements, one per dialect.
Class
Relation
Attributes
Attribute | Type | Default | Description |
alias | String | none | none |
Content
Element | Java Name | Constraints | Description |
SQL | selects | Array [1 ..
] | none |
Attributes
Attribute | Type | Default | Description |
dialect | String | generic |
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
Class
RelationOrJoin
Attributes
Attribute | Type | Default | Description |
leftAlias | String | none |
Defaults to left's alias if left is a table, otherwise
required.
|
leftKey | String | none | none |
rightAlias | String | none |
Defaults to right's alias if right is a table, otherwise
required.
|
rightKey | String | none | none |
Content
Class
Relation
Attributes
Attribute | Type | Default | Description |
name | String | none | none |
schema | String | none |
Optional qualifier for table .
|
alias | String | none |
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
Element | Java Name | Constraints | Description |
SQL | filter | Optional |
The SQL WHERE clause expression to be appended to any select statement
|
AggExclude | aggExcludes | Array | none |
AggTable | aggTables | Array | none |
Hint | tableHints | Array |
Table optimization hints; may be ignored by dialect.
|
Dialect-specific table optimization hints.
Attributes
Attribute | Type | Default | Description |
type | String | none |
Type of hint, interpreted and applied on a per-dialect basis.
|
Content
Text
Class
Relation
Attributes
Attribute | Type | Default | Description |
alias | String | none |
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
Element | Java Name | Constraints | Description |
ColumnDefs | columnDefs | Required | none |
Rows | rows | Required | none |
Holder for an array of ColumnDef elements
Attributes
none
Content
Element | Java Name | Constraints | Description |
ColumnDef | array | Array | none |
Column definition for an inline table.
Attributes
Attribute | Type | Default | Description |
name | String | none |
Name of the column.
|
type | String | none |
Type of the column:
String, Numeric, Integer, Boolean, Date, Time or Timestamp.
|
Content
empty
Holder for an array of Row elements
Attributes
none
Content
Element | Java Name | Constraints | Description |
Row | array | Array | none |
Row definition for an inline table.
Must have one Column for each ColumnDef in the InlineTable.
Attributes
none
Content
Element | Java Name | Constraints | Description |
Value | values | Array | none |
Column value for an inline table.
The CDATA holds the value of the column.
Attributes
Attribute | Type | Default | Description |
column | String | none |
Name of the column.
|
Content
Text
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
Attribute | Type | Default | Description |
ignorecase | Boolean | true |
Whether or not the match should ignore case.
|
Content
Class
AggTable
Attributes
Attribute | Type | Default | Description |
name | String | none |
The Table name of a Specific aggregate table.
|
approxRowCount | String | none |
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
Class
AggTable
Attributes
Attribute | Type | Default | Description |
pattern | String | none |
A Table pattern used to define a set of aggregate tables.
|
Content
Element | Java Name | Constraints | Description |
AggExclude | excludes | Array | none |
Attributes
Attribute | Type | Default | Description |
pattern | String | none |
A Table pattern not to be matched.
|
name | String | none |
The Table name not to be matched.
|
ignorecase | Boolean | true |
Whether or not the match should ignore case.
|
Content
empty
Attributes
Attribute | Type | Default | Description |
column | String | none |
The name of the fact count column.
|
Content
empty
Class
AggColumnName
Attributes
none
Content
empty
Class
AggColumnName
Attributes
none
Content
empty
The name of the column mapping from base fact table foreign key
to aggregate table foreign key.
Attributes
Attribute | Type | Default | Description |
factColumn | String | none |
The name of the base fact table foreign key.
|
aggColumn | String | none |
The name of the aggregate table foreign key.
|
Content
empty
Attributes
Attribute | Type | Default | Description |
column | String | none |
The name of the column mapping to the level name.
|
name | String | none |
The name of the Dimension Hierarchy level.
|
collapsed | Boolean | true |
Whether this is a collapsed level. The parents of that level
are also present in the aggregation table.
|
Content
empty
Attributes
Attribute | Type | Default | Description |
column | String | none |
The name of the column mapping to the measure name.
|
name | String | none |
The name of the Cube measure.
|
Content
empty
Class
Expression
Attributes
Attribute | Type | Default | Description |
table | String | none |
Alias of the table which contains this column. Not required if
the query only has one table.
|
name | String | none |
Name of the column.
|
Content
empty
A collection of SQL expressions, one per dialect.
Class
Expression
Attributes
none
Content
Element | Java Name | Constraints | Description |
SQL | expressions | Array [1 ..
] | none |
Class
ExpressionView
Attributes
none
Content
empty
Class
ExpressionView
Attributes
none
Content
empty
Class
ExpressionView
Attributes
none
Content
empty
Class
ExpressionView
Attributes
none
Content
empty
Class
ExpressionView
Attributes
none
Content
empty
Class
ExpressionView
Attributes
none
Content
empty
A role defines an access-control profile. It has a series of grants
(or denials) for schema elements.
Attributes
Attribute | Type | Default | Description |
name | String | none | none |
Content
Element | Java Name | Constraints | Description |
Annotations | annotations | Optional |
Contains values of user-defined properties.
|
SchemaGrant | schemaGrants | Array | none |
Union | union | Optional | none |
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
Element | Java Name | Constraints | Description |
CubeGrant | cubeGrants | Array | none |
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
Attribute | Type | Default | Description |
cube | String | none |
The unique name of the cube
|
Content
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
Attribute | Type | Default | Description |
dimension | String | none |
The unique name of the dimension
|
Content
empty
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
Attribute | Type | Default | Description |
hierarchy | String | none |
The unique name of the hierarchy
|
topLevel | String | none |
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.
|
bottomLevel | String | none |
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.
|
rollupPolicy | String | none |
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
Element | Java Name | Constraints | Description |
MemberGrant | memberGrants | Array | none |
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
Attribute | Type | Default | Description |
member | String | none |
The unique name of the member
|
access | String | none | none |
Content
empty
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
Element | Java Name | Constraints | Description |
RoleUsage | roleUsages | Required | none |
Usage of a Role in a union Role.
Attributes
Attribute | Type | Default | Description |
roleName | String | none | none |
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
Attribute | Type | Default | Description |
name | String | none |
Name with which the user-defined function will be referenced in MDX expressions.
|
className | String | none |
Name of the class which implemenets this user-defined function.
Must implement the mondrian.spi.UserDefinedFunction
interface.
|
Content
Element | Java Name | Constraints | Description |
Script | script | Optional |
Script to implement this user-defined function.
Either the "Script" element or the "className" attribute
must be specified.
|
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
Attribute | Type | Default | Description |
name | String | none |
Name of this parameter.
|
description | String | none |
Description of this parameter.
|
type | String | String |
Indicates the type of this parameter:
String, Numeric, Integer, Boolean, Date, Time, Timestamp, or Member.
|
modifiable | Boolean | true |
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.
|
defaultValue | String | none |
Expression for the default value of this parameter.
|
Content
empty
Holder for an array of Annotation elements
Attributes
none
Content
Element | Java Name | Constraints | Description |
Annotation | array | Array | none |
User-defined property value.
Attributes
Attribute | Type | Default | Description |
name | String | none |
Name of the annotation.
|
Content
Text
Script fragment to implement an SPI such as user-defined function,
member formatter, cell formatter.
Attributes
Attribute | Type | Default | Description |
language | String | JavaScript |
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
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
Attribute | Type | Default | Description |
className | String | none |
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
Element | Java Name | Constraints | Description |
Script | script | Optional |
Script to implement this cell formatter.
Either the "Script" element or the "className" attribute
must be specified.
|
Plugin that formats members.
It must be implemented by a Java
class which implements the interface
mondrian.spi.MemberFormatter,
or by a script.
Attributes
Attribute | Type | Default | Description |
className | String | none |
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
Element | Java Name | Constraints | Description |
Script | script | Optional |
Script to implement this member formatter.
Either the "Script" element or the "className" attribute
must be specified.
|
Plugin that formats properties.
It must be implemented by a Java
class which implements the interface
mondrian.spi.PropertyFormatter,
or by a script.
Attributes
Attribute | Type | Default | Description |
className | String | none |
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
Element | Java Name | Constraints | Description |
Script | script | Optional |
Script to implement this property formatter.
Either the "Script" element or the "className" attribute
must be specified.
|
Attributes
none
Content
empty
Attributes
Attribute | Type | Default | Description |
access | String | none |
Values correspond to Access .
|
Content
empty
|