Package mondrian.olap
Class Property
- java.lang.Object
-
- mondrian.olap.EnumeratedValues.BasicValue
-
- mondrian.olap.Property
-
- All Implemented Interfaces:
EnumeratedValues.Value
public class Property extends EnumeratedValues.BasicValue
Property
is the definition of a member property.The following properties are mandatory for members:
The following propertiess are mandatory for cells:- Author:
- jhyde
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
Property.Datatype
-
Field Summary
Fields Modifier and Type Field Description static Property
ACTION_TYPE
Definition of the property which holds the format string.static int
ACTION_TYPE_ORDINAL
static Property
AGGREGATION_TYPE
Definition of the internal property which holds the aggregation type.static int
AGGREGATION_TYPE_ORDINAL
static Property
BACK_COLOR
static int
BACK_COLOR_ORDINAL
static Property
CAPTION
Definition of the internal property which holds a member's caption.static int
CAPTION_ORDINAL
static Property
CATALOG_NAME
Definition of the property which holds the name of the current catalog.static int
CATALOG_NAME_ORDINAL
static Property
CELL_EVALUATION_LIST
static int
CELL_EVALUATION_LIST_ORDINAL
static Property
CELL_FORMATTER
Definition of the property which holds the name of the class which formats cell values of this member.static int
CELL_FORMATTER_ORDINAL
static Property
CELL_FORMATTER_SCRIPT
Definition of the property which holds the script with which to format cell values of this member.static Property
CELL_FORMATTER_SCRIPT_LANGUAGE
Definition of the property which holds the name of the scripting language in which a scripted cell formatter is implemented, e.g.static int
CELL_FORMATTER_SCRIPT_LANGUAGE_ORDINAL
static int
CELL_FORMATTER_SCRIPT_ORDINAL
static Property
CELL_ORDINAL
static int
CELL_ORDINAL_ORDINAL
static Property
CHILDREN_CARDINALITY
Definition of the property which holds the number of children this member has.static int
CHILDREN_CARDINALITY_ORDINAL
static Property
CONTRIBUTING_CHILDREN
Deprecated.Property is not used and will be removed in mondrian-4.0; useSchemaReader.getParentChildContributingChildren(mondrian.olap.Member, mondrian.olap.Hierarchy, java.util.List<mondrian.olap.Member>)
static int
CONTRIBUTING_CHILDREN_ORDINAL
static Property
CUBE_NAME
Definition of the property which holds the name of the current cube.static int
CUBE_NAME_ORDINAL
static Property
DATATYPE
Definition of the property which holds the datatype of a cell.static int
DATATYPE_ORDINAL
static Property
DEPTH
Definition of the property which holds the level depth of a member.static int
DEPTH_ORDINAL
static Property
DESCRIPTION
Definition of the property which holds the description of this member.static int
DESCRIPTION_ORDINAL
static Property
DIMENSION_UNIQUE_NAME
Definition of the property which holds the unique name of the current dimension.static int
DIMENSION_UNIQUE_NAME_ORDINAL
static Property
DISPLAY_FOLDER
Definition of the property which holds the DISPLAY_FOLDER.static int
DISPLAY_FOLDER_ORDINAL
static Property
DISPLAY_INFO
Definition of the property which holds the DISPLAY_INFO required by XML/A.static int
DISPLAY_INFO_ORDINAL
static Property
DRILLTHROUGH_COUNT
Definition of the property that holds the number of fact rows that contributed to this cell.static int
DRILLTHROUGH_COUNT_ORDINAL
static EnumeratedValues<Property>
enumeration
static Property
FONT_FLAGS
static int
FONT_FLAGS_ORDINAL
static Property
FONT_NAME
static int
FONT_NAME_ORDINAL
static Property
FONT_SIZE
static int
FONT_SIZE_ORDINAL
static Property
FORE_COLOR
static int
FORE_COLOR_ORDINAL
static Property
FORMAT_EXP
Definition of the property which holds the format string.static int
FORMAT_EXP_ORDINAL
static Property
FORMAT_EXP_PARSED
Definition of the internal property which holds the parsed format string (an object of typeExp
).static int
FORMAT_EXP_PARSED_ORDINAL
static Property
FORMAT_STRING
Definition of the property which holds the format string used to format cell values.static int
FORMAT_STRING_ORDINAL
static Property
FORMATTED_VALUE
Definition of the property which holds the formatted value of a cell.static int
FORMATTED_VALUE_ORDINAL
static Property
FORMULA
Definition of the internal property which returns a calculated member'sFormula
object.static int
FORMULA_ORDINAL
static Property
HIERARCHY_UNIQUE_NAME
Definition of the property which holds the unique name of the current hierarchy.static int
HIERARCHY_UNIQUE_NAME_ORDINAL
static Property
KEY
Definition of the property which holds the key of the current member.static int
KEY_ORDINAL
static Property
LANGUAGE
Definition of the property which holds the translation expressed as an LCID.static int
LANGUAGE_ORDINAL
static Property
LEVEL_NUMBER
Definition of the property which holds the ordinal of the current level.static int
LEVEL_NUMBER_ORDINAL
static Property
LEVEL_UNIQUE_NAME
Definition of the property which holds the unique name of the current level.static int
LEVEL_UNIQUE_NAME_ORDINAL
static Map<String,Property>
mapUpperNameToProperties
Map of upper-case names to property definitions, for case-insensitive match.static Property
MEMBER_CAPTION
Definition of the property which holds the label or caption associated with the member, or the member's name if no caption is defined.static int
MEMBER_CAPTION_ORDINAL
static Property
MEMBER_GUID
Definition of the property which holds the GUID of the memberstatic int
MEMBER_GUID_ORDINAL
static Property
MEMBER_KEY
Definition of the property which holds the member key of the current member.static int
MEMBER_KEY_ORDINAL
static Property
MEMBER_NAME
Definition of the property which holds the name of the current member.static int
MEMBER_NAME_ORDINAL
static Property
MEMBER_ORDINAL
Definition of the property which holds the ordinal of the current member.static int
MEMBER_ORDINAL_ORDINAL
static Property
MEMBER_SCOPE
Definition of the internal property which describes whether a calculated member belongs to a query or a cube.static int
MEMBER_SCOPE_ORDINAL
static Property
MEMBER_TYPE
Definition of the property which holds the type of the member.static int
MEMBER_TYPE_ORDINAL
static Property
MEMBER_UNIQUE_NAME
Definition of the property which holds the unique name of the current member.static int
MEMBER_UNIQUE_NAME_ORDINAL
static Property
NAME
Definition of the internal property which holds a member's name.static int
NAME_ORDINAL
static Property
NON_EMPTY_BEHAVIOR
static int
NON_EMPTY_BEHAVIOR_ORDINAL
static Property
PARENT_COUNT
Definition of the property which holds the number of parents that this member has.static int
PARENT_COUNT_ORDINAL
static Property
PARENT_LEVEL
Definition of the property which holds the distance from the root of the hierarchy of this member's parent.static int
PARENT_LEVEL_ORDINAL
static Property
PARENT_UNIQUE_NAME
Definition of the property which holds the Name of the current catalog.static int
PARENT_UNIQUE_NAME_ORDINAL
static Property
SCENARIO
Definition of the internal property which holds the scenario object underlying a member of the scenario hierarchy.static int
SCENARIO_ORDINAL
static Property
SCHEMA_NAME
Definition of the property which holds the name of the current schema.static int
SCHEMA_NAME_ORDINAL
static Property
SOLVE_ORDER
Definition of the property which determines the solve order of a calculated member with respect to other calculated members.static int
SOLVE_ORDER_ORDINAL
static Property
VALUE
Definition of the property which holds the value of a cell.static int
VALUE_ORDINAL
static Property
VISIBLE
Definition of the internal property which holds the name of the system property which determines whether to show a member (especially a measure or calculated member) in a user interface such as JPivot.static int
VISIBLE_ORDINAL
-
Fields inherited from class mondrian.olap.EnumeratedValues.BasicValue
description, name, ordinal
-
-
Constructor Summary
Constructors Modifier Constructor Description protected
Property(String name, Property.Datatype type, int ordinal, boolean internal, boolean member, boolean cell, String description)
Creates a property definition.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description String
getCaption()
Returns the caption of this property.PropertyFormatter
getFormatter()
Property.Datatype
getType()
Returns the datatype of the property.boolean
isCellProperty()
Returns whether this property is a standard cell property.boolean
isInternal()
Returns whether this property is for system use only.boolean
isMemberProperty()
Returns whether this property is a standard member property.boolean
isStandard()
Returns whether this property is standard.static Property
lookup(int ordinal)
Looks up a Property with a given ordinal.static Property
lookup(String name, boolean matchCase)
Looks up a Property with a given name.-
Methods inherited from class mondrian.olap.EnumeratedValues.BasicValue
equals, getDescription, getName, getOrdinal, toString, unexpected
-
-
-
-
Field Detail
-
mapUpperNameToProperties
public static final Map<String,Property> mapUpperNameToProperties
Map of upper-case names to property definitions, for case-insensitive match. Also contains synonyms.
-
FORMAT_EXP_PARSED_ORDINAL
public static final int FORMAT_EXP_PARSED_ORDINAL
- See Also:
- Constant Field Values
-
FORMAT_EXP_PARSED
public static final Property FORMAT_EXP_PARSED
Definition of the internal property which holds the parsed format string (an object of typeExp
).
-
AGGREGATION_TYPE_ORDINAL
public static final int AGGREGATION_TYPE_ORDINAL
- See Also:
- Constant Field Values
-
AGGREGATION_TYPE
public static final Property AGGREGATION_TYPE
Definition of the internal property which holds the aggregation type. This is automatically set for stored measures, based upon their SQL aggregation.
-
NAME_ORDINAL
public static final int NAME_ORDINAL
- See Also:
- Constant Field Values
-
NAME
public static final Property NAME
Definition of the internal property which holds a member's name.
-
CAPTION_ORDINAL
public static final int CAPTION_ORDINAL
- See Also:
- Constant Field Values
-
CAPTION
public static final Property CAPTION
Definition of the internal property which holds a member's caption.
-
CONTRIBUTING_CHILDREN_ORDINAL
public static final int CONTRIBUTING_CHILDREN_ORDINAL
- See Also:
- Constant Field Values
-
CONTRIBUTING_CHILDREN
public static final Property CONTRIBUTING_CHILDREN
Deprecated.Property is not used and will be removed in mondrian-4.0; useSchemaReader.getParentChildContributingChildren(mondrian.olap.Member, mondrian.olap.Hierarchy, java.util.List<mondrian.olap.Member>)
Definition of the internal property which holds, for a member of a parent-child hierarchy, aList
containing the member's data member and all of its children (including non-visible children).
-
FORMULA_ORDINAL
public static final int FORMULA_ORDINAL
- See Also:
- Constant Field Values
-
FORMULA
public static final Property FORMULA
Definition of the internal property which returns a calculated member'sFormula
object.
-
MEMBER_SCOPE_ORDINAL
public static final int MEMBER_SCOPE_ORDINAL
- See Also:
- Constant Field Values
-
MEMBER_SCOPE
public static final Property MEMBER_SCOPE
Definition of the internal property which describes whether a calculated member belongs to a query or a cube.
-
CATALOG_NAME_ORDINAL
public static final int CATALOG_NAME_ORDINAL
- See Also:
- Constant Field Values
-
CATALOG_NAME
public static final Property CATALOG_NAME
Definition of the property which holds the name of the current catalog.
-
SCHEMA_NAME_ORDINAL
public static final int SCHEMA_NAME_ORDINAL
- See Also:
- Constant Field Values
-
SCHEMA_NAME
public static final Property SCHEMA_NAME
Definition of the property which holds the name of the current schema.
-
CUBE_NAME_ORDINAL
public static final int CUBE_NAME_ORDINAL
- See Also:
- Constant Field Values
-
CUBE_NAME
public static final Property CUBE_NAME
Definition of the property which holds the name of the current cube.
-
DIMENSION_UNIQUE_NAME_ORDINAL
public static final int DIMENSION_UNIQUE_NAME_ORDINAL
- See Also:
- Constant Field Values
-
DIMENSION_UNIQUE_NAME
public static final Property DIMENSION_UNIQUE_NAME
Definition of the property which holds the unique name of the current dimension.
-
HIERARCHY_UNIQUE_NAME_ORDINAL
public static final int HIERARCHY_UNIQUE_NAME_ORDINAL
- See Also:
- Constant Field Values
-
HIERARCHY_UNIQUE_NAME
public static final Property HIERARCHY_UNIQUE_NAME
Definition of the property which holds the unique name of the current hierarchy.
-
LEVEL_UNIQUE_NAME_ORDINAL
public static final int LEVEL_UNIQUE_NAME_ORDINAL
- See Also:
- Constant Field Values
-
LEVEL_UNIQUE_NAME
public static final Property LEVEL_UNIQUE_NAME
Definition of the property which holds the unique name of the current level.
-
LEVEL_NUMBER_ORDINAL
public static final int LEVEL_NUMBER_ORDINAL
- See Also:
- Constant Field Values
-
LEVEL_NUMBER
public static final Property LEVEL_NUMBER
Definition of the property which holds the ordinal of the current level.
-
MEMBER_ORDINAL_ORDINAL
public static final int MEMBER_ORDINAL_ORDINAL
- See Also:
- Constant Field Values
-
MEMBER_ORDINAL
public static final Property MEMBER_ORDINAL
Definition of the property which holds the ordinal of the current member.
-
MEMBER_NAME_ORDINAL
public static final int MEMBER_NAME_ORDINAL
- See Also:
- Constant Field Values
-
MEMBER_NAME
public static final Property MEMBER_NAME
Definition of the property which holds the name of the current member.
-
MEMBER_UNIQUE_NAME_ORDINAL
public static final int MEMBER_UNIQUE_NAME_ORDINAL
- See Also:
- Constant Field Values
-
MEMBER_UNIQUE_NAME
public static final Property MEMBER_UNIQUE_NAME
Definition of the property which holds the unique name of the current member.
-
MEMBER_TYPE_ORDINAL
public static final int MEMBER_TYPE_ORDINAL
- See Also:
- Constant Field Values
-
MEMBER_TYPE
public static final Property MEMBER_TYPE
Definition of the property which holds the type of the member.
-
MEMBER_GUID_ORDINAL
public static final int MEMBER_GUID_ORDINAL
- See Also:
- Constant Field Values
-
MEMBER_GUID
public static final Property MEMBER_GUID
Definition of the property which holds the GUID of the member
-
MEMBER_CAPTION_ORDINAL
public static final int MEMBER_CAPTION_ORDINAL
- See Also:
- Constant Field Values
-
MEMBER_CAPTION
public static final Property MEMBER_CAPTION
Definition of the property which holds the label or caption associated with the member, or the member's name if no caption is defined."CAPTION" is a synonym for this property.
-
CHILDREN_CARDINALITY_ORDINAL
public static final int CHILDREN_CARDINALITY_ORDINAL
- See Also:
- Constant Field Values
-
CHILDREN_CARDINALITY
public static final Property CHILDREN_CARDINALITY
Definition of the property which holds the number of children this member has.
-
PARENT_LEVEL_ORDINAL
public static final int PARENT_LEVEL_ORDINAL
- See Also:
- Constant Field Values
-
PARENT_LEVEL
public static final Property PARENT_LEVEL
Definition of the property which holds the distance from the root of the hierarchy of this member's parent.
-
PARENT_UNIQUE_NAME_ORDINAL
public static final int PARENT_UNIQUE_NAME_ORDINAL
- See Also:
- Constant Field Values
-
PARENT_UNIQUE_NAME
public static final Property PARENT_UNIQUE_NAME
Definition of the property which holds the Name of the current catalog.
-
PARENT_COUNT_ORDINAL
public static final int PARENT_COUNT_ORDINAL
- See Also:
- Constant Field Values
-
PARENT_COUNT
public static final Property PARENT_COUNT
Definition of the property which holds the number of parents that this member has. Generally 1, or 0 for root members.
-
DESCRIPTION_ORDINAL
public static final int DESCRIPTION_ORDINAL
- See Also:
- Constant Field Values
-
DESCRIPTION
public static final Property DESCRIPTION
Definition of the property which holds the description of this member.
-
VISIBLE_ORDINAL
public static final int VISIBLE_ORDINAL
- See Also:
- Constant Field Values
-
VISIBLE
public static final Property VISIBLE
Definition of the internal property which holds the name of the system property which determines whether to show a member (especially a measure or calculated member) in a user interface such as JPivot.
-
CELL_FORMATTER_ORDINAL
public static final int CELL_FORMATTER_ORDINAL
- See Also:
- Constant Field Values
-
CELL_FORMATTER
public static final Property CELL_FORMATTER
Definition of the property which holds the name of the class which formats cell values of this member.The class must implement the
CellFormatter
interface.Despite its name, this is a member property.
-
CELL_FORMATTER_SCRIPT_LANGUAGE_ORDINAL
public static final int CELL_FORMATTER_SCRIPT_LANGUAGE_ORDINAL
- See Also:
- Constant Field Values
-
CELL_FORMATTER_SCRIPT_LANGUAGE
public static final Property CELL_FORMATTER_SCRIPT_LANGUAGE
Definition of the property which holds the name of the scripting language in which a scripted cell formatter is implemented, e.g. 'JavaScript'.Despite its name, this is a member property.
-
CELL_FORMATTER_SCRIPT_ORDINAL
public static final int CELL_FORMATTER_SCRIPT_ORDINAL
- See Also:
- Constant Field Values
-
CELL_FORMATTER_SCRIPT
public static final Property CELL_FORMATTER_SCRIPT
Definition of the property which holds the script with which to format cell values of this member.Despite its name, this is a member property.
-
BACK_COLOR_ORDINAL
public static final int BACK_COLOR_ORDINAL
- See Also:
- Constant Field Values
-
BACK_COLOR
public static final Property BACK_COLOR
-
CELL_EVALUATION_LIST_ORDINAL
public static final int CELL_EVALUATION_LIST_ORDINAL
- See Also:
- Constant Field Values
-
CELL_EVALUATION_LIST
public static final Property CELL_EVALUATION_LIST
-
CELL_ORDINAL_ORDINAL
public static final int CELL_ORDINAL_ORDINAL
- See Also:
- Constant Field Values
-
CELL_ORDINAL
public static final Property CELL_ORDINAL
-
FORE_COLOR_ORDINAL
public static final int FORE_COLOR_ORDINAL
- See Also:
- Constant Field Values
-
FORE_COLOR
public static final Property FORE_COLOR
-
FONT_NAME_ORDINAL
public static final int FONT_NAME_ORDINAL
- See Also:
- Constant Field Values
-
FONT_NAME
public static final Property FONT_NAME
-
FONT_SIZE_ORDINAL
public static final int FONT_SIZE_ORDINAL
- See Also:
- Constant Field Values
-
FONT_SIZE
public static final Property FONT_SIZE
-
FONT_FLAGS_ORDINAL
public static final int FONT_FLAGS_ORDINAL
- See Also:
- Constant Field Values
-
FONT_FLAGS
public static final Property FONT_FLAGS
-
FORMATTED_VALUE_ORDINAL
public static final int FORMATTED_VALUE_ORDINAL
- See Also:
- Constant Field Values
-
FORMATTED_VALUE
public static final Property FORMATTED_VALUE
Definition of the property which holds the formatted value of a cell.
-
FORMAT_STRING_ORDINAL
public static final int FORMAT_STRING_ORDINAL
- See Also:
- Constant Field Values
-
FORMAT_STRING
public static final Property FORMAT_STRING
Definition of the property which holds the format string used to format cell values.
-
NON_EMPTY_BEHAVIOR_ORDINAL
public static final int NON_EMPTY_BEHAVIOR_ORDINAL
- See Also:
- Constant Field Values
-
NON_EMPTY_BEHAVIOR
public static final Property NON_EMPTY_BEHAVIOR
-
SOLVE_ORDER_ORDINAL
public static final int SOLVE_ORDER_ORDINAL
- See Also:
- Constant Field Values
-
SOLVE_ORDER
public static final Property SOLVE_ORDER
Definition of the property which determines the solve order of a calculated member with respect to other calculated members.
-
VALUE_ORDINAL
public static final int VALUE_ORDINAL
- See Also:
- Constant Field Values
-
VALUE
public static final Property VALUE
Definition of the property which holds the value of a cell. Is usually numeric (since most measures are numeric) but is occasionally another type.It is also applicable to members.
-
DATATYPE_ORDINAL
public static final int DATATYPE_ORDINAL
- See Also:
- Constant Field Values
-
DATATYPE
public static final Property DATATYPE
Definition of the property which holds the datatype of a cell. Valid values are "String", "Numeric", "Integer". The property's value derives from the "datatype" attribute of the "Measure" element; if the datatype attribute is not specified, the datatype is "Numeric" by default, except measures whose aggregator is "Count", whose datatype is "Integer".
-
DEPTH_ORDINAL
public static final int DEPTH_ORDINAL
- See Also:
- Constant Field Values
-
DEPTH
public static final Property DEPTH
Definition of the property which holds the level depth of a member.Caution: Level depth of members in parent-child hierarchy isn't from their levels. It's calculated from the underlying data dynamically.
-
DISPLAY_INFO_ORDINAL
public static final int DISPLAY_INFO_ORDINAL
- See Also:
- Constant Field Values
-
DISPLAY_INFO
public static final Property DISPLAY_INFO
Definition of the property which holds the DISPLAY_INFO required by XML/A. Caution: This property's value is calculated based on a specified MDX query, so it's value is dynamic at runtime.
-
MEMBER_KEY_ORDINAL
public static final int MEMBER_KEY_ORDINAL
- See Also:
- Constant Field Values
-
MEMBER_KEY
public static final Property MEMBER_KEY
Definition of the property which holds the member key of the current member.
-
KEY_ORDINAL
public static final int KEY_ORDINAL
- See Also:
- Constant Field Values
-
KEY
public static final Property KEY
Definition of the property which holds the key of the current member.
-
SCENARIO_ORDINAL
public static final int SCENARIO_ORDINAL
- See Also:
- Constant Field Values
-
SCENARIO
public static final Property SCENARIO
Definition of the internal property which holds the scenario object underlying a member of the scenario hierarchy.
-
DISPLAY_FOLDER_ORDINAL
public static final int DISPLAY_FOLDER_ORDINAL
- See Also:
- Constant Field Values
-
DISPLAY_FOLDER
public static final Property DISPLAY_FOLDER
Definition of the property which holds the DISPLAY_FOLDER. For measures, a client tool may use this folder to display measures in groups. This property has no meaning for other members.
-
LANGUAGE_ORDINAL
public static final int LANGUAGE_ORDINAL
- See Also:
- Constant Field Values
-
LANGUAGE
public static final Property LANGUAGE
Definition of the property which holds the translation expressed as an LCID. Only valid for property translations.
-
FORMAT_EXP_ORDINAL
public static final int FORMAT_EXP_ORDINAL
- See Also:
- Constant Field Values
-
FORMAT_EXP
public static final Property FORMAT_EXP
Definition of the property which holds the format string.
-
ACTION_TYPE_ORDINAL
public static final int ACTION_TYPE_ORDINAL
- See Also:
- Constant Field Values
-
ACTION_TYPE
public static final Property ACTION_TYPE
Definition of the property which holds the format string.
-
DRILLTHROUGH_COUNT_ORDINAL
public static final int DRILLTHROUGH_COUNT_ORDINAL
- See Also:
- Constant Field Values
-
DRILLTHROUGH_COUNT
public static final Property DRILLTHROUGH_COUNT
Definition of the property that holds the number of fact rows that contributed to this cell. If the cell is not drillable, returns -1.Note that this property may be expensive to compute for some cubes.
-
enumeration
public static final EnumeratedValues<Property> enumeration
-
-
Constructor Detail
-
Property
protected Property(String name, Property.Datatype type, int ordinal, boolean internal, boolean member, boolean cell, String description)
Creates a property definition. If ordinal is negative, generates a unique positive ordinal.
-
-
Method Detail
-
getType
public Property.Datatype getType()
Returns the datatype of the property.
-
getFormatter
public PropertyFormatter getFormatter()
-
getCaption
public String getCaption()
Returns the caption of this property.
-
isInternal
public boolean isInternal()
Returns whether this property is for system use only.
-
isMemberProperty
public boolean isMemberProperty()
Returns whether this property is a standard member property.
-
isCellProperty
public boolean isCellProperty()
Returns whether this property is a standard cell property.
-
isStandard
public boolean isStandard()
Returns whether this property is standard.
-
lookup
public static Property lookup(int ordinal)
Looks up a Property with a given ordinal. Returns null if not found.
-
-