NamedSet (Pentaho Community Edition Project: mondrian 9.5.0.0-252 API)

All Superinterfaces:

Annotated, OlapElement

All Known Implementing Classes:

Query.ScopedNamedSet, SetBase
```
public interface NamedSet
extends OlapElement, Annotated
```
A named set of members or tuples.
A set can be defined in a query, using a WITH SET clause, or in a schema. Named sets in a schema can be defined against a particular cube or virtual cube, or shared between all cubes.

Since:

6 August, 2001

Author:

jhyde

Nested Class Summary
- Nested classes/interfaces inherited from interface mondrian.olap.OlapElement
  OlapElement.LocalizedProperty

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`Exp`	`getExp()`	Returns the expression used to derive this named set.
`String`	`getNameUniqueWithinQuery()`	Returns a name for this set that is unique within the query.
`Type`	`getType()`	Returns the type of this named set.
`boolean`	`isDynamic()`	Returns whether this named set is dynamic.
`void`	`setName(String newName)`	Sets the name of this named set.
`NamedSet`	`validate(Validator validator)`

Methods inherited from interface mondrian.olap.Annotated
getAnnotationMap

Methods inherited from interface mondrian.olap.OlapElement
getCaption, getDescription, getDimension, getHierarchy, getLocalized, getName, getQualifiedName, getUniqueName, isVisible, lookupChild

- Method Detail
  - setName
```
void setName(String newName)
```
    Sets the name of this named set.
  - getType
```
Type getType()
```
    Returns the type of this named set.
  - getExp
```
Exp getExp()
```
    Returns the expression used to derive this named set.
  - validate
```
NamedSet validate(Validator validator)
```
  - getNameUniqueWithinQuery
```
String getNameUniqueWithinQuery()
```
    Returns a name for this set that is unique within the query.
    This is necessary when there are several 'AS' expressions, or an 'AS' expression overrides a named set defined using 'WITH MEMBER' clause or against a cube.
  - isDynamic
```
boolean isDynamic()
```
    Returns whether this named set is dynamic.
    Evaluation rules:
    
    A dynamic set is evaluated each time it is used, and inherits the context in which it is evaluated.
    A static set is evaluated only on first use, in the base context of the cube.
    Returns:
    
    Whether this named set is dynamic