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
Propertyis 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 classProperty.Datatype
-
Field Summary
Fields Modifier and Type Field Description static PropertyACTION_TYPEDefinition of the property which holds the format string.static intACTION_TYPE_ORDINALstatic PropertyAGGREGATION_TYPEDefinition of the internal property which holds the aggregation type.static intAGGREGATION_TYPE_ORDINALstatic PropertyBACK_COLORstatic intBACK_COLOR_ORDINALstatic PropertyCAPTIONDefinition of the internal property which holds a member's caption.static intCAPTION_ORDINALstatic PropertyCATALOG_NAMEDefinition of the property which holds the name of the current catalog.static intCATALOG_NAME_ORDINALstatic PropertyCELL_EVALUATION_LISTstatic intCELL_EVALUATION_LIST_ORDINALstatic PropertyCELL_FORMATTERDefinition of the property which holds the name of the class which formats cell values of this member.static intCELL_FORMATTER_ORDINALstatic PropertyCELL_FORMATTER_SCRIPTDefinition of the property which holds the script with which to format cell values of this member.static PropertyCELL_FORMATTER_SCRIPT_LANGUAGEDefinition of the property which holds the name of the scripting language in which a scripted cell formatter is implemented, e.g.static intCELL_FORMATTER_SCRIPT_LANGUAGE_ORDINALstatic intCELL_FORMATTER_SCRIPT_ORDINALstatic PropertyCELL_ORDINALstatic intCELL_ORDINAL_ORDINALstatic PropertyCHILDREN_CARDINALITYDefinition of the property which holds the number of children this member has.static intCHILDREN_CARDINALITY_ORDINALstatic PropertyCONTRIBUTING_CHILDRENDeprecated.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 intCONTRIBUTING_CHILDREN_ORDINALstatic PropertyCUBE_NAMEDefinition of the property which holds the name of the current cube.static intCUBE_NAME_ORDINALstatic PropertyDATATYPEDefinition of the property which holds the datatype of a cell.static intDATATYPE_ORDINALstatic PropertyDEPTHDefinition of the property which holds the level depth of a member.static intDEPTH_ORDINALstatic PropertyDESCRIPTIONDefinition of the property which holds the description of this member.static intDESCRIPTION_ORDINALstatic PropertyDIMENSION_UNIQUE_NAMEDefinition of the property which holds the unique name of the current dimension.static intDIMENSION_UNIQUE_NAME_ORDINALstatic PropertyDISPLAY_FOLDERDefinition of the property which holds the DISPLAY_FOLDER.static intDISPLAY_FOLDER_ORDINALstatic PropertyDISPLAY_INFODefinition of the property which holds the DISPLAY_INFO required by XML/A.static intDISPLAY_INFO_ORDINALstatic PropertyDRILLTHROUGH_COUNTDefinition of the property that holds the number of fact rows that contributed to this cell.static intDRILLTHROUGH_COUNT_ORDINALstatic EnumeratedValues<Property>enumerationstatic PropertyFONT_FLAGSstatic intFONT_FLAGS_ORDINALstatic PropertyFONT_NAMEstatic intFONT_NAME_ORDINALstatic PropertyFONT_SIZEstatic intFONT_SIZE_ORDINALstatic PropertyFORE_COLORstatic intFORE_COLOR_ORDINALstatic PropertyFORMAT_EXPDefinition of the property which holds the format string.static intFORMAT_EXP_ORDINALstatic PropertyFORMAT_EXP_PARSEDDefinition of the internal property which holds the parsed format string (an object of typeExp).static intFORMAT_EXP_PARSED_ORDINALstatic PropertyFORMAT_STRINGDefinition of the property which holds the format string used to format cell values.static intFORMAT_STRING_ORDINALstatic PropertyFORMATTED_VALUEDefinition of the property which holds the formatted value of a cell.static intFORMATTED_VALUE_ORDINALstatic PropertyFORMULADefinition of the internal property which returns a calculated member'sFormulaobject.static intFORMULA_ORDINALstatic PropertyHIERARCHY_UNIQUE_NAMEDefinition of the property which holds the unique name of the current hierarchy.static intHIERARCHY_UNIQUE_NAME_ORDINALstatic PropertyKEYDefinition of the property which holds the key of the current member.static intKEY_ORDINALstatic PropertyLANGUAGEDefinition of the property which holds the translation expressed as an LCID.static intLANGUAGE_ORDINALstatic PropertyLEVEL_NUMBERDefinition of the property which holds the ordinal of the current level.static intLEVEL_NUMBER_ORDINALstatic PropertyLEVEL_UNIQUE_NAMEDefinition of the property which holds the unique name of the current level.static intLEVEL_UNIQUE_NAME_ORDINALstatic Map<String,Property>mapUpperNameToPropertiesMap of upper-case names to property definitions, for case-insensitive match.static PropertyMEMBER_CAPTIONDefinition of the property which holds the label or caption associated with the member, or the member's name if no caption is defined.static intMEMBER_CAPTION_ORDINALstatic PropertyMEMBER_GUIDDefinition of the property which holds the GUID of the memberstatic intMEMBER_GUID_ORDINALstatic PropertyMEMBER_KEYDefinition of the property which holds the member key of the current member.static intMEMBER_KEY_ORDINALstatic PropertyMEMBER_NAMEDefinition of the property which holds the name of the current member.static intMEMBER_NAME_ORDINALstatic PropertyMEMBER_ORDINALDefinition of the property which holds the ordinal of the current member.static intMEMBER_ORDINAL_ORDINALstatic PropertyMEMBER_SCOPEDefinition of the internal property which describes whether a calculated member belongs to a query or a cube.static intMEMBER_SCOPE_ORDINALstatic PropertyMEMBER_TYPEDefinition of the property which holds the type of the member.static intMEMBER_TYPE_ORDINALstatic PropertyMEMBER_UNIQUE_NAMEDefinition of the property which holds the unique name of the current member.static intMEMBER_UNIQUE_NAME_ORDINALstatic PropertyNAMEDefinition of the internal property which holds a member's name.static intNAME_ORDINALstatic PropertyNON_EMPTY_BEHAVIORstatic intNON_EMPTY_BEHAVIOR_ORDINALstatic PropertyPARENT_COUNTDefinition of the property which holds the number of parents that this member has.static intPARENT_COUNT_ORDINALstatic PropertyPARENT_LEVELDefinition of the property which holds the distance from the root of the hierarchy of this member's parent.static intPARENT_LEVEL_ORDINALstatic PropertyPARENT_UNIQUE_NAMEDefinition of the property which holds the Name of the current catalog.static intPARENT_UNIQUE_NAME_ORDINALstatic PropertySCENARIODefinition of the internal property which holds the scenario object underlying a member of the scenario hierarchy.static intSCENARIO_ORDINALstatic PropertySCHEMA_NAMEDefinition of the property which holds the name of the current schema.static intSCHEMA_NAME_ORDINALstatic PropertySOLVE_ORDERDefinition of the property which determines the solve order of a calculated member with respect to other calculated members.static intSOLVE_ORDER_ORDINALstatic PropertyVALUEDefinition of the property which holds the value of a cell.static intVALUE_ORDINALstatic PropertyVISIBLEDefinition 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 intVISIBLE_ORDINAL-
Fields inherited from class mondrian.olap.EnumeratedValues.BasicValue
description, name, ordinal
-
-
Constructor Summary
Constructors Modifier Constructor Description protectedProperty(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 StringgetCaption()Returns the caption of this property.PropertyFormattergetFormatter()Property.DatatypegetType()Returns the datatype of the property.booleanisCellProperty()Returns whether this property is a standard cell property.booleanisInternal()Returns whether this property is for system use only.booleanisMemberProperty()Returns whether this property is a standard member property.booleanisStandard()Returns whether this property is standard.static Propertylookup(int ordinal)Looks up a Property with a given ordinal.static Propertylookup(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, aListcontaining 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'sFormulaobject.
-
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
CellFormatterinterface.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.
-
-