property.java

来自「数据仓库展示程序」· Java 代码 · 共 506 行 · 第 1/2 页

/*
// $Id: //open/mondrian/src/main/mondrian/olap/Property.java#16 $
// This software is subject to the terms of the Common Public License
// Agreement, available at the following URL:
// http://www.opensource.org/licenses/cpl.html.
// Copyright (C) 2001-2005 Kana Software, Inc. and others.
// All Rights Reserved.
// You must accept the terms of that agreement to use this software.
//
// jhyde, 12 September, 2002
*/

package mondrian.olap;

/**
 * <code>Property</code> is the definition of a member property.
 *
 * <p>The following properties are mandatory for members:<ul>
 * <li>{@link #CATALOG_NAME}</li>
 * <li>{@link #SCHEMA_NAME}</li>
 * <li>{@link #CUBE_NAME}</li>
 * <li>{@link #DIMENSION_UNIQUE_NAME}</li>
 * <li>{@link #HIERARCHY_UNIQUE_NAME}</li>
 * <li>{@link #LEVEL_UNIQUE_NAME}</li>
 * <li>{@link #LEVEL_NUMBER}</li>
 * <li>{@link #MEMBER_UNIQUE_NAME}</li>
 * <li>{@link #MEMBER_NAME}</li>
 * <li>{@link #MEMBER_TYPE}</li>
 * <li>{@link #MEMBER_GUID}</li>
 * <li>{@link #MEMBER_CAPTION}</li>
 * <li>{@link #MEMBER_ORDINAL}</li>
 * <li>{@link #CHILDREN_CARDINALITY}</li>
 * <li>{@link #PARENT_LEVEL}</li>
 * <li>{@link #PARENT_UNIQUE_NAME}</li>
 * <li>{@link #PARENT_COUNT}</li>
 * <li>{@link #DESCRIPTION}</li>
 * </ul>
 *
 * The following propertiess are mandatory for cells:<ul>
 * <li>{@link #BACK_COLOR}</li>
 * <li>{@link #CELL_EVALUATION_LIST}</li>
 * <li>{@link #CELL_ORDINAL}</li>
 * <li>{@link #FORE_COLOR}</li>
 * <li>{@link #FONT_NAME}</li>
 * <li>{@link #FONT_SIZE}</li>
 * <li>{@link #FONT_FLAGS}</li>
 * <li>{@link #FORMAT_STRING}</li>
 * <li>{@link #FORMATTED_VALUE}</li>
 * <li>{@link #NON_EMPTY_BEHAVIOR}</li>
 * <li>{@link #SOLVE_ORDER}</li>
 * <li>{@link #VALUE}</li>
 * </ul>
 */
public class Property extends EnumeratedValues.BasicValue {
    public static final int TYPE_STRING = 0;
    public static final int TYPE_NUMERIC = 1;
    public static final int TYPE_BOOLEAN = 2;
    public static final int TYPE_OTHER = 3;

    public static final int FORMAT_EXP_ORDINAL = 0;
    /**
     * Definition of the internal property which
     * holds the parsed format string (an object of type {@link Exp}).
     */
    public static final Property FORMAT_EXP =
            new Property("$format_exp", TYPE_OTHER, FORMAT_EXP_ORDINAL, true, false, false, null);

    public static final int AGGREGATION_TYPE_ORDINAL = 1;
    /**
     * Definition of the internal property which
     * holds the aggregation type. This is automatically set for stored
     * measures, based upon their SQL aggregation.
     */
    public static final Property AGGREGATION_TYPE =
            new Property("$aggregation_type", TYPE_OTHER, AGGREGATION_TYPE_ORDINAL, true, false, false, null);

    public static final int NAME_ORDINAL = 2;

    /**
     * Definition of the internal property which
     * holds a member's name.
     */
    public static final Property NAME =
            new Property("$name", TYPE_STRING, NAME_ORDINAL, true, false, false, null);

    public static final int CAPTION_ORDINAL = 3;
    /**
     * Definition of the internal property which
     * holds a member's caption.
     */
    public static final Property CAPTION =
            new Property("$caption", TYPE_STRING, CAPTION_ORDINAL, true, false, false, null);

    public static final int CONTRIBUTING_CHILDREN_ORDINAL = 4;
    /**
     * Definition of the internal property which
     * holds, for a member of a  parent-child hierarchy, a
     * {@link java.util.List} containing the member's data
     * member and all of its children (including non-visible children).
     */
    public static final Property CONTRIBUTING_CHILDREN =
            new Property("$contributingChildren", TYPE_OTHER, CONTRIBUTING_CHILDREN_ORDINAL, true, false, false, null);

    public static final int FORMULA_ORDINAL = 5;
    /**
     * Definition of the internal property which
     * returns a calculated member's {@link Formula} object.
     */
    public static final Property FORMULA =
            new Property("$formula", TYPE_OTHER, FORMULA_ORDINAL, true, false, false, null);

    public static final int CATALOG_NAME_ORDINAL = 10;
    /**
     * Definition of the property which
     * holds the name of the current catalog.
     */
    public static final Property CATALOG_NAME =
            new Property("CATALOG_NAME", TYPE_STRING, CATALOG_NAME_ORDINAL, false, true, false, "Optional. The name of the catalog to which this member belongs. NULL if the provider does not support catalogs.");

    public static final int SCHEMA_NAME_ORDINAL = 11;
    /**
     * Definition of the property which
     * holds the name of the current schema.
     */
    public static final Property SCHEMA_NAME =
            new Property("SCHEMA_NAME", TYPE_STRING, SCHEMA_NAME_ORDINAL, false, true, false, "Optional. The name of the schema to which this member belongs. NULL if the provider does not support schemas.");

    public static final int CUBE_NAME_ORDINAL = 12;
    /**
     * Definition of the property which
     * holds the name of the current cube.
     */
    public static final Property CUBE_NAME =
            new Property("CUBE_NAME", TYPE_STRING, CUBE_NAME_ORDINAL, false, true, false, "Required. Name of the cube to which this member belongs.");

    public static final int DIMENSION_UNIQUE_NAME_ORDINAL = 13;
    /**
     * Definition of the property which
     * holds the unique name of the current dimension.
     */
    public static final Property DIMENSION_UNIQUE_NAME =
            new Property("DIMENSION_UNIQUE_NAME", TYPE_STRING, DIMENSION_UNIQUE_NAME_ORDINAL, false, true, false, "Required. Unique name of the dimension to which this member belongs. For providers that generate unique names by qualification, each component of this name is delimited.");

    public static final int HIERARCHY_UNIQUE_NAME_ORDINAL = 14;
    /**
     * Definition of the property which
     * holds the unique name of the current hierarchy.
     */
    public static final Property HIERARCHY_UNIQUE_NAME =
            new Property("HIERARCHY_UNIQUE_NAME", TYPE_STRING, HIERARCHY_UNIQUE_NAME_ORDINAL, false, true, false, "Required. Unique name of the hierarchy. If the member belongs to more than one hierarchy, there is one row for each hierarchy to which it belongs. For providers that generate unique names by qualification, each component of this name is delimited.");

    public static final int LEVEL_UNIQUE_NAME_ORDINAL = 15;
    /**
     * Definition of the property which
     * holds the unique name of the current level.
     */
    public static final Property LEVEL_UNIQUE_NAME =
            new Property("LEVEL_UNIQUE_NAME", TYPE_STRING, LEVEL_UNIQUE_NAME_ORDINAL, false, true, false, "Required. Unique name of the level to which the member belongs. For providers that generate unique names by qualification, each component of this name is delimited.");

    public static final int LEVEL_NUMBER_ORDINAL = 16;
    /**
     * Definition of the property which
     * holds the ordinal of the current level.
     */
    public static final Property LEVEL_NUMBER =
            new Property("LEVEL_NUMBER", TYPE_STRING, LEVEL_NUMBER_ORDINAL, false, true, false, "Required. The distance of the member from the root of the hierarchy. The root level is zero.");

    public static final int MEMBER_ORDINAL_ORDINAL = 17;
    /**
     * Definition of the property which
     * holds the ordinal of the current member.
     */
    public static final Property MEMBER_ORDINAL =
            new Property("MEMBER_ORDINAL", TYPE_NUMERIC, MEMBER_ORDINAL_ORDINAL, false, true, false, "Required. Ordinal number of the member. Sort rank of the member when members of this dimension are sorted in their natural sort order. If providers do not have the concept of natural ordering, this should be the rank when sorted by MEMBER_NAME.");

    public static final int MEMBER_NAME_ORDINAL = 18;
    /**
     * Definition of the property which
     * holds the name of the current member.
     */
    public static final Property MEMBER_NAME =
            new Property("MEMBER_NAME", TYPE_STRING, MEMBER_NAME_ORDINAL, false, true, false, "Required. Name of the member.");

    public static final int MEMBER_UNIQUE_NAME_ORDINAL = 19;
    /**
     * Definition of the property which
     * holds the unique name of the current member.
     */
    public static final Property MEMBER_UNIQUE_NAME =
            new Property("MEMBER_UNIQUE_NAME", TYPE_STRING, MEMBER_UNIQUE_NAME_ORDINAL, false, true, false, "Required. Unique name of the member. For providers that generate unique names by qualification, each component of this name is delimited.");

    public static final int MEMBER_TYPE_ORDINAL = 20;
    /**
     * Definition of the property which
     * holds the type of the member.
     */
    public static final Property MEMBER_TYPE =
            new Property("MEMBER_TYPE", TYPE_STRING, MEMBER_TYPE_ORDINAL, false, true, false, "Required. Type of the member. Can be one of the following values: MDMEMBER_TYPE_REGULAR, MDMEMBER_TYPE_ALL, MDMEMBER_TYPE_FORMULA, MDMEMBER_TYPE_MEASURE, MDMEMBER_TYPE_UNKNOWN. MDMEMBER_TYPE_FORMULA takes precedence over MDMEMBER_TYPE_MEASURE. Therefore, if there is a formula (calculated) member on the Measures dimension, it is listed as MDMEMBER_TYPE_FORMULA.");

    public static final int MEMBER_GUID_ORDINAL = 21;
    /**
     * Definition of the property which
     * holds the GUID of the member
     */
    public static final Property MEMBER_GUID =
            new Property("MEMBER_GUID", TYPE_STRING, MEMBER_GUID_ORDINAL, false, true, false, "Optional. Member GUID. NULL if no GUID exists.");

    public static final int MEMBER_CAPTION_ORDINAL = 22;
    /**
     * Definition of the property which
     * holds the label or caption associated with the member, or the
     * member's name if no caption is defined.
     */
    public static final Property MEMBER_CAPTION =
            new Property("MEMBER_CAPTION", TYPE_STRING, MEMBER_CAPTION_ORDINAL, false, true, false, "Required. A label or caption associated with the member. Used primarily for display purposes. If a caption does not exist, MEMBER_NAME is returned.");

    public static final int CHILDREN_CARDINALITY_ORDINAL = 23;
    /**
     * Definition of the property which holds the
     * number of children this member has.
     */
    public static final Property CHILDREN_CARDINALITY =
            new Property("CHILDREN_CARDINALITY", TYPE_NUMERIC, CHILDREN_CARDINALITY_ORDINAL, false, true, false, "Required. Number of children that the member has. This can be an estimate, so consumers should not rely on this to be the exact count. Providers should return the best estimate possible.");

    public static final int PARENT_LEVEL_ORDINAL = 24;
    /**
     * Definition of the property which holds the
     * distance from the root of the hierarchy of this member's parent.
     */
    public static final Property PARENT_LEVEL =
            new Property("PARENT_LEVEL", TYPE_NUMERIC, PARENT_LEVEL_ORDINAL, false, true, false, "Required. The distance of the member's parent from the root level of the hierarchy. The root level is zero.");

    public static final int PARENT_UNIQUE_NAME_ORDINAL = 25;
    /**
     * Definition of the property which holds the
     * Name of the current catalog.
     */
    public static final Property PARENT_UNIQUE_NAME =
            new Property("PARENT_UNIQUE_NAME", TYPE_STRING, PARENT_UNIQUE_NAME_ORDINAL, false, true, false, "Required. Unique name of the member's parent. NULL is returned for any members at the root level. For providers that generate unique names by qualification, each component of this name is delimited.");

    public static final int PARENT_COUNT_ORDINAL = 26;
    /**
     * Definition of the property which holds the
     * number of parents that this member has. Generally 1, or 0 for root members.
     */
    public static final Property PARENT_COUNT =
            new Property("PARENT_COUNT", TYPE_NUMERIC, PARENT_COUNT_ORDINAL, false, true, false, "Required. Number of parents that this member has.");

    public static final int DESCRIPTION_ORDINAL = 27;
    /**
     * Definition of the property which holds the
     * description of this member.
     */