*** This interface is subject to change. ***

com.sas.iquery.metadata.business
Interface BusinessGroup

All Superinterfaces:

Base, BusinessModelObject, BusinessModelResource, BusinessModelResourceReferencer, java.lang.Cloneable, java.util.EventListener, com.sas.iquery.metadata.business.ExtendedAttributes, ModelItem, ModelItemWithIdentity, NamedObjectInterface, PropertyChangeListenee, java.beans.PropertyChangeListener, UsabilityInterface

public interface BusinessGroup
extends BusinessModelObject

The purpose of this object to allow the ability to group certain IQ objects outside of our normal MapFolder structure. The Type value of Group is used to hint at the usage of the Group or have a defined internal meaning for a BusinessQuery.

The meaning of the following types are:

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

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

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

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

• Type.DIMENSION

  The function of this type allows a dimension to be defined in a CUBE group. The type is reserved for future use.

  • A Dimension Group can contain one or more "hierarchy" groups.
  • A "Dimension" group can only contain a "hierarchy" group type.

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

  • Each data element group within a HIEARCHY becomes the level definition for that hierarchy.
  • A order that data items are defined in a hierarchy is level order definition.
  • The data item order must be retained to insure correct aggregation within each level and hierarchy.
  • Each dataItem in a group represents a level in the hierarchy.
  • A data item can be a part of more than one hierarchy group.
  • Groups that contain the same elements can be applied to the same query, but not to the same axis.
  • A "hierarchy" group cannot be part of a "measure" group.
  • A "hierarchy" group must only reference "category" data item(s).

  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 
  

• 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

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

Type.USER_DEFINIED 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

Nested Class Summary

static class

BusinessGroup.Type

Field Summary

static java.lang.String	EVENT_BUSINESS_GROUP_ITEMS_CHANGED Indication that the data item's aggregation type that are supported are changed.
static java.lang.String	EVENT_BUSINESS_GROUP_NOTES_CHANGED Indication that the group's note value has changed.

Fields inherited from interface com.sas.iquery.metadata.business.ModelItemWithIdentity

EVENT_DESCRIPTION_CHANGED, EVENT_HIDDEN_CHANGED, EVENT_ID_CHANGED, EVENT_LABEL_CHANGED

Fields inherited from interface com.sas.iquery.metadata.business.ModelItem

EVENT_OBJECT_PROPERTY_CHANGED

Fields inherited from interface com.sas.iquery.metadata.business.Base

EVENT_OBJECT_DEFINITION_CHANGED

Method Summary

void	clear() Removes all of the items from this group.
boolean	contains(BusinessModelObject businessModelObject) Returns an indication of whether the given business model object is contained within this group.
boolean	contains(BusinessModelObject businessModelObject, boolean recursive) Returns an indication of whether the given business model object is contained within this group or subgroups.
java.util.List<BusinessGroup>	getContainedGroups() Returns all the contained group objects within this group.
java.util.List<BusinessModelObject>	getItems() Returns an	java.lang.String	getNote() Returns the notes string for this group
BusinessGroup.Type	getType() Returns the BusinessGroup.Type of this group
void	setItems(java.util.List<? extends BusinessModelObject> items) Sets the	void	setNote(java.lang.String note) Sets the user notes for this group
int	size() Returns the number of items in this group.

Methods inherited from interface com.sas.iquery.metadata.business.BusinessModelObject

getBusinessModel, isContainedInBusinessModel, isIDOK, isReadOnly

Methods inherited from interface com.sas.iquery.metadata.business.ModelItemWithIdentity

getID, getIdentityString, getIntraModelID, isHidden, isUnresolved, setDescription, setIntraModelID, setIsHidden, setLabel

Methods inherited from interface com.sas.iquery.metadata.PropertyChangeListenee

addListener, getListeners, removeListener

Methods inherited from interface com.sas.iquery.metadata.business.UsabilityInterface

getReasonsUnusable, isUsableInQuery

Methods inherited from interface com.sas.iquery.metadata.business.BusinessModelResource

isUnresolved

Methods inherited from interface com.sas.iquery.metadata.NamedObjectInterface

getDescription, getLabel

Methods inherited from interface com.sas.iquery.metadata.business.BusinessModelResourceReferencer

getResources

Field Detail

EVENT_BUSINESS_GROUP_NOTES_CHANGED

static final java.lang.String EVENT_BUSINESS_GROUP_NOTES_CHANGED

Indication that the group's note value has changed.

See Also:

Constant Field Values

EVENT_BUSINESS_GROUP_ITEMS_CHANGED

static final java.lang.String EVENT_BUSINESS_GROUP_ITEMS_CHANGED

Indication that the data item's aggregation type that are supported are changed.

See Also:

Constant Field Values

Method Detail

getType

BusinessGroup.Type getType()

Returns the BusinessGroup.Type of this group

Returns:

the Type of this group.

getItems

@Nonnull
java.util.List<BusinessModelObject> getItems()

Returns an List containing all of the items in this group in the order they were added. If the group contains no items an empty list is returned.

Returns:

an list containing all of the items in this group.

setItems

void setItems(@Nonnull
              java.util.List<? extends BusinessModelObject> items)

Sets the List of (@code BusinessModelObject} to be grouped.

The specified list will be copied into an internal ArrayList object.

getNote

java.lang.String getNote()

Returns the notes string for this group

Returns:

String

setNote

void setNote(java.lang.String note)

Sets the user notes for this group

Parameters:

note - String.

contains

boolean contains(BusinessModelObject businessModelObject)

Returns an indication of whether the given business model object is contained within this group.

Parameters:

businessModelObject - the object to search for.

Returns:

a boolean indication of whether the given object is contained within is group.

contains

boolean contains(BusinessModelObject businessModelObject,
                 boolean recursive)

Returns an indication of whether the given business model object is contained within this group or subgroups.

Parameters:

businessModelObject - the object to search for.

recursive - if true all subgroups are included in the search.

Returns:

a boolean indication of whether the given object is contained within is group.

getContainedGroups

@Nonnull
java.util.List<BusinessGroup> getContainedGroups()

Returns all the contained group objects within this group. Otherwise an empty list.

Returns:

a list of BusinessGroup objects or an empty list

clear

void clear()

Removes all of the items from this group. This group will be empty after this call returns.

size

int size()

Returns the number of items in this group.

Returns:

the number of items in this group.

*** This interface is subject to change. ***