com.sas.iquery.metadata.business
Enum BusinessGroup.Type

com.sas.iquery.metadata.business.BusinessGroup.Type
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<BusinessGroup.Type>
Enclosing interface:
BusinessGroup

public static enum BusinessGroup.Type

Usage of the Group or have a defined internal meaning for a BusinessQuery


Enum Constant Summary
CATEGORY
          The function of this type is to allow category data items to be defined for special purpose with a business query.
CUBE
          A functional definition of this type allows for the definition of an in-memory data cube.
DIMENSION
          The function of this type allows a dimension to be defined in a CUBE group.
ELASTIC_FILTER
          The function of this type allows the functional association between filter elements in a bi-directional manner.
FILTER
          The function of this type allows functionally joined filter elements.
GROUPED_CATEGORIES
          The function of this type is to allow category data items to be functionally group together for a special purpose with a business query.
GROUPED_MEASURES
          The function of this type is to allow measure to be visually grouped under one label within the table viewer.
HIERARCHY
          The function of this type allows a hierarchy or hierarchies to be defined within a dimension that exists in a CUBE group.
MEASURE
          The function of this type is to allow measure(s) to be functionally defined in CUBE group.
TOTALS_DISABLED
          Disable Totals for the listed for the TotalingType value set in the Note field.
USER_DEFINED
          The function of this type is to allow business items or other groups to group for a client's own application purpose.
 
Method Summary
static BusinessGroup.Type valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static BusinessGroup.Type[] values()
          Returns an array containing the constants of this enum type, in the order they are declared.
 

Enum Constant Detail

GROUPED_MEASURES

public static final BusinessGroup.Type GROUPED_MEASURES
The function of this type is to allow measure to be visually grouped under one label within the table viewer. The following rules apply.
  • A Type.GROUPED_MEASURES group must reference a data item structure of "measure" defined in a data selection.
  • Cannot use nesting in GROUPED_MEASURES.
  • The same measure cannot exist in more than one applied GROUPED_MEASURE.

  • GROUPED_CATEGORIES

    public static final BusinessGroup.Type GROUPED_CATEGORIES
    The function of this type is to allow category data items to be functionally group together for a special purpose with a business query.
    The type is reserved for future use.


    CATEGORY

    public static final BusinessGroup.Type CATEGORY
    The function of this type is to allow category data items to be defined for special purpose with a business query.
    The type is reserved for future use.


    FILTER

    public static final BusinessGroup.Type FILTER
    The function of this type allows functionally joined filter elements. A functionally joined filter element can be defined with a CUBE group.
    The type is reserved for future use.


    ELASTIC_FILTER

    public static final BusinessGroup.Type ELASTIC_FILTER
    The function of this type allows the functional association between filter elements in a bi-directional manner. This grouping is required for the use with the ElasticFilterDataProvider.


    CUBE

    public static final BusinessGroup.Type CUBE
    A functional definition of this type allows for the definition of an in-memory data cube. The type is reserved for future use. A "Cube" group can only contain "Measure", "Dimension", "Hierarchy", "Grouped_Measures", "Filter" group type or nested "Cube" group type.


    DIMENSION

    public static final BusinessGroup.Type DIMENSION
    The function of this type allows a dimension to be defined in a CUBE group.
    The type is reserved for future use.


    HIERARCHY

    public static final BusinessGroup.Type HIERARCHY
    The function of this type allows a hierarchy or hierarchies to be defined within a dimension that exists in a CUBE group.
    The type is reserved for future use.

    For example:

                Group (Geo1 contains data items - country, state, city)
                Group (Geo2 contains data items - state, city)
    
                SELECT 
                   [MARKET].[GEOGRAPHICAL].MEMBERS       ON 0,
                   [MARKET].[POPULATION].[STATE].MEMBERS ON 1
                FROM SimbaOr 
    
                SELECT 
                   [MARKET].[GEOGRAPHICAL].MEMBERS ON 0,
                   [MARKET].[POPULATION].MEMBERS   ON 1
                FROM SimbaOr 
            


    USER_DEFINED

    public static final BusinessGroup.Type USER_DEFINED
    The function of this type is to allow business items or other groups to group for a client's own application purpose. In this type, IQ performs no function associated to this group. This type works similar to folders in the information map.
    The type is reserved for future use.


    MEASURE

    public static final BusinessGroup.Type MEASURE
    The function of this type is to allow measure(s) to be functionally defined in CUBE group.
    The type is reserved for future use.


    TOTALS_DISABLED

    public static final BusinessGroup.Type TOTALS_DISABLED
    Disable Totals for the listed for the TotalingType value set in the Note field.

    Method Detail

    values

    public static BusinessGroup.Type[] values()
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
    for (BusinessGroup.Type c : BusinessGroup.Type.values())
        System.out.println(c);
    

    Returns:
    an array containing the constants of this enum type, in the order they are declared

    valueOf

    public static BusinessGroup.Type valueOf(java.lang.String name)
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

    Parameters:
    name - the name of the enum constant to be returned.
    Returns:
    the enum constant with the specified name
    Throws:
    java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
    java.lang.NullPointerException - if the argument is null



    Copyright © 2009 SAS Institute Inc. All Rights Reserved.