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

  • Field Details

    • 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:

    • FORMAT_EXP_PARSED

      public static final Property FORMAT_EXP_PARSED
      Definition of the internal property which holds the parsed format string (an object of type Exp).

    • AGGREGATION_TYPE_ORDINAL

      public static final int AGGREGATION_TYPE_ORDINAL
      See Also:

    • 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:

    • 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:

    • 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:

    • CONTRIBUTING_CHILDREN

      public static final Property CONTRIBUTING_CHILDREN
      Deprecated.
      Property is not used and will be removed in mondrian-4.0; use SchemaReader.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, a List 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:

    • FORMULA

      public static final Property FORMULA
      Definition of the internal property which returns a calculated member's Formula object.

    • MEMBER_SCOPE_ORDINAL

      public static final int MEMBER_SCOPE_ORDINAL
      See Also:

    • 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:

    • 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:

    • 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:

    • 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:

    • 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:

    • 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:

    • 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:

    • 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:

    • 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:

    • 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:

    • 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:

    • 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:

    • 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:

    • 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:

    • 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:

    • 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:

    • 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:

    • 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:

    • 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:

    • 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:

    • 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:

    • 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:

    • 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:

    • BACK_COLOR

      public static final Property BACK_COLOR

    • CELL_EVALUATION_LIST_ORDINAL

      public static final int CELL_EVALUATION_LIST_ORDINAL
      See Also:

    • CELL_EVALUATION_LIST

      public static final Property CELL_EVALUATION_LIST

    • CELL_ORDINAL_ORDINAL

      public static final int CELL_ORDINAL_ORDINAL
      See Also:

    • CELL_ORDINAL

      public static final Property CELL_ORDINAL

    • FORE_COLOR_ORDINAL

      public static final int FORE_COLOR_ORDINAL
      See Also:

    • FORE_COLOR

      public static final Property FORE_COLOR

    • FONT_NAME_ORDINAL

      public static final int FONT_NAME_ORDINAL
      See Also:

    • FONT_NAME

      public static final Property FONT_NAME

    • FONT_SIZE_ORDINAL

      public static final int FONT_SIZE_ORDINAL
      See Also:

    • FONT_SIZE

      public static final Property FONT_SIZE

    • FONT_FLAGS_ORDINAL

      public static final int FONT_FLAGS_ORDINAL
      See Also:

    • FONT_FLAGS

      public static final Property FONT_FLAGS

    • FORMATTED_VALUE_ORDINAL

      public static final int FORMATTED_VALUE_ORDINAL
      See Also:

    • 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:

    • 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:

    • NON_EMPTY_BEHAVIOR

      public static final Property NON_EMPTY_BEHAVIOR

    • SOLVE_ORDER_ORDINAL

      public static final int SOLVE_ORDER_ORDINAL
      See Also:

    • 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:

    • 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:

    • 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:

    • 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:

    • 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:

    • 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:

    • 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:

    • 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:

    • 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:

    • 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:

    • 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:

    • 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:

    • 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 Details

    • 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 Details

    • 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.

    • lookup

      public static Property lookup(String name, boolean matchCase)
      Looks up a Property with a given name.
      Parameters:
      name - Name of property
      matchCase - Whether to perform case-sensitive match
      Returns:
      Property with given name, or null if not found.