schemas.mondrian.xsd Maven / Gradle / Ivy
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.
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.
Name of this parameter.
Description of this parameter.
Indicates the type of this parameter: String, Numeric, Integer,
Boolean, Date, Time, Timestamp, or Member.
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.
Expression for the default value of this parameter.
Definition of a cube.
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.
The SQL expression used to calculate a measure.
Must be specified if a source column is not specified.
Name of this measure.
Column which is source of this measure's values. If not specified,
a measure expression must be specified.
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'.
Format string with which to format cells of this measure.
For more details, see the mondrian.util.Format class.
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.)
Name of a formatter class for the appropriate cell being displayed.
The class must implement the mondrian.olap.CellFormatter interface.
A string being displayed instead of the name.
Can be localized from Properties file using #{propertyname}.
Description of this measure. Can be localized from Properties file using #{propertyname}.
Whether this member is visible in the user-interface. Default true.
Calculated members in this cube.
Named sets in this virtual cube.
Name of this cube.
A string being displayed instead of the cube's name. Can be localized from Properties
file using #{propertyname}.
Description of this cube. Can be localized from Properties file using #{propertyname}.
The name of the measure that would be taken as the default measure of the cube.
Should the Fact table data for this Cube be cached by Mondrian or not.
The default action is to cache the data.
Whether element is enabled - if true, then the Cube is realized
otherwise it is ignored.
Virtual cubes in this schema.
A VirtualCube is a set of dimensions and measures gleaned from other cubes.
List of base cubes used by the virtual cube.
Name of the cube which the virtualCube uses.
Unrelated dimensions to measures in this cube will be pushed to top level member.
A VirtualCubeDimension is a usage of a Dimension in a VirtualCube.
Name of the cube which the dimension belongs to, or unspecified if the dimension is shared.
Name of the dimension.
A VirtualCubeMeasure is a usage of a Measure in a VirtualCube.
Name of the cube which the measure belongs to.
Unique name of the measure within its cube.
Whether this member is visible in the user-interface. Default true.
Calculated members that belong to this virtual cube.
(Calculated members inherited from other cubes should not be in this list).
Named sets in this virtual cube.
Whether this element is enabled - if true, then the Virtual Cube is realized otherwise it is ignored.
The name of the measure that would be taken as the default measure of the cube.
A string being displayed instead of the cube's name. Can be localized from Properties file using #{propertyname}.
Description of this virtual cube. Can be localized from Properties file using #{propertyname}.
Named sets in this schema.
A role defines an access-control profile. It has a series of grants (or denials) for schema elements.
Grants (or denies) this role access to this schema. access may be "all", "all_dimensions", or "none".
If access is "all_dimensions", the role has access to all dimensions but still needs explicit access to cubes.
See mondrian.olap.Role#grant(mondrian.olap.Schema,int).
Grants (or denies) this role access to a cube. access may be "all" or "none".
Grants (or denies) this role access to a dimension. access may be "all" or "none".
Note that a role is implicitly given access to a dimension when it is given acess to a cube.
See also the "all_dimensions" option of the "SchemaGrant" element.
The unique name of the dimension
Values correspond to Access.
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.
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.
The unique name of the member
Values correspond to Access.
The unique name of the hierarchy
Values correspond to Access.
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.
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.
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'.
The unique name of the cube
Values correspond to Access.
Values correspond to Access.
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.
Usage of a Role in a union Role.
Declarations of user-defined functions in this schema.
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.
Name with which the user-defined function will be referenced in MDX expressions.
Name of the class which implemenets this user-defined function.
Must implement the mondrian.spi.UserDefinedFunction interface.
Name of this schema
Description of this schema.
Label for the measures dimension.
Can be localized from Properties file using #{propertyname}.
The name of the default role for connections to this schema
Contains values of user-defined properties.
Shared dimensions in this schema.
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.
Name of this dimension
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".
A string being displayed instead of the dimensions's name.
Can be localized from Properties file using #{propertyname}.
Description of this dimension. Can be localized from Properties file using #{propertyname}.
Private dimensions in the cube.
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.
Name of this dimension
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".
A string being displayed instead of the dimensions's name.
Can be localized from Properties file using #{propertyname}.
Description of this dimension. Can be localized from Properties file using #{propertyname}.
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.
Flag to mark this dimension as a high cardinality one and avoid caching.
A DimensionUsage is usage of a shared Dimension within the context of a cube.
Name of the dimension. Must be a dimension in this schema. Case-sensitive.
Name of the source dimension. Must be a dimension in this schema. Case-sensitive.
Name of the level to join to. If not specified, joins to the lowest level of the dimension.
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.
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.
Flag to mark this dimension as a high cardinality one and avoid caching.
or memberReaderClass.
If you specify none, the hierarchy is assumed to come from the same
fact table of the current cube.
]]>
The Table, Join (set of tables), View (SQL statement), or InlineTable which populates this hierarchy.
The SQL expression used to populate this level's key.
The SQL expression used to populate this level's name.
If not specified, the level's key is used.
Expression which forms the caption of members.
If not specified, the level name is used.
The SQL expression used to populate this level's ordinal.
The SQL expression used to join to the parent member in a parent-child hierarchy.
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.
Member property.
Data type of this property: String, Numeric, Integer, Boolean, Date, Time or Timestamp.
Name of a formatter class for the appropriate property value being displayed.
The class must implement the mondrian.olap.PropertyFormatter interface.
A string being displayed instead of the name. Can be localized from Properties
file using #{propertyname}.
Description of this member property. Can be localized from Properties file using #{propertyname}.
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.
The estimated number of members in this level. Setting this property improves
the performance of MDSCHEMA_LEVELS, MDSCHEMA_HIERARCHIES
and MDSCHEMA_DIMENSIONS XMLA requests.
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}.
The name of the column which holds the unique identifier of this level.
The name of the column which holds the user identifier of this level.
The name of the column which holds member ordinals.
If this column is not specified, the key column is used for ordering.
The name of the column which references the parent member in a parent-child hierarchy.
Value which identifies null parents in a parent-child hierarchy. Typical values are 'NULL' and '0'.
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'".
Whether members are unique across all parents. For example, zipcodes are unique across all states.
The first level's members are always unique.
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).
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 or empty); and
IfParentsName (a member appears unless its name matches the parent's.
Name of a formatter class for the member labels being displayed.
The class must implement the mondrian.olap.MemberFormatter interface.
A string being displayed instead of the level's name. Can be localized from
Properties file using #{propertyname}.
Description of this level. Can be localized from Properties file using #{propertyname}.
The name of the column which holds the caption for members.
Not used
Name of the hierarchy. If this is not specified, the hierarchy
has the same name as its dimension.
Whether this hierarchy has an 'all' member.
Name of the 'all' member. If this attribute is not specified,
the all member is named 'All hierarchyName', for example, 'All Store'.
A string being displayed instead as the all member's name.
Can be localized from Properties file using #{propertyname}.
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}.
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.
The name of the table which contains primaryKey. If the hierarchy has only one table,
defaults to that; otherwise it is required.
Default member of this hierarchy.
Name of the custom member reader class. Must implement the
mondrian.rolap.MemberReader interface.
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 of this hierarchy. Can be localized from Properties file using #{propertyname}.
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.
Defaults to left's alias if left is a table, otherwise required.
Defaults to right's alias if right is a table, otherwise required.
Holder for an array of ColumnDef elements
Column definition for an inline table.
Name of the column.
Type of the column: String, Numeric, Integer, Boolean, Date, Time or Timestamp.
Holder for an array of Row elements
Row definition for an inline table. Must have one Column for each ColumnDef in the InlineTable.
Column value for an inline table. The CDATA holds the value of the column.
Name of the column.
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.
The name of the column mapping from base fact table foreign key to aggregate table foreign key.
The name of the base fact table foreign key.
The name of the aggregate table foreign key.
The name of the column mapping to the measure name.
The name of the Cube measure.
The name of the column mapping to the measure name.
The name of the Cube measure.
The Table name of a Specific aggregate table.
Whether or not the match should ignore case.
The estimated number of rows in this aggregate table.
The name of the column mapping from base fact table foreign key to aggregate table foreign key.
The name of the base fact table foreign key.
The name of the aggregate table foreign key.
The name of the column mapping to the measure name.
The name of the Cube measure.
The name of the column mapping to the measure name.
The name of the Cube measure.
A Table pattern not to be matched.
The Table name not to be matched.
Whether or not the match should ignore case.
A Table pattern used to define a set of aggregate tables.
Whether or not the match should ignore case.
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
The SQL WHERE clause expression to be appended to any select statement
A Table pattern not to be matched.
The Table name not to be matched.
Whether or not the match should ignore case.
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.
Dialect-specific table optimization hints.
Type of hint, interpreted and applied on a per-dialect basis.
Optional qualifier for table.
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.)
A collection of SQL statements, one per dialect.
MDX expression which gives the value of this member.
Name of this calculated member.
Format string with which to format cells of this member.
A string being displayed instead of the name. Can be localized from Properties file using #{propertyname}.
Description of this calculated member. Can be localized from Properties file using #{propertyname}.
Name of the dimension which this member belongs to.
Whether this member is visible in the user-interface. Default true.
Property of a calculated member defined against a cube. It must have either an expression or a value.
Name of this member property.
A string being displayed instead of the Properties's name.
Can be localized from Properties file using #{propertyname}.
Description of this calculated member property. Can be localized from Properties file using #{propertyname}.
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 of this property. If the value is not constant,
specify the 'expression' attribute instead.
Defines a named set which can be used in queries in the same way as a set
defined using a WITH SET clause. 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.
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). 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.
MDX expression which gives the value of this set.
Name of this named set.
Caption of this named set. Can be localized from Properties file using #{propertyname}.
Description of this named set. Can be localized from Properties file using #{propertyname}.
© 2015 - 2024 Weber Informatics LLC | Privacy Policy