Package mondrian.olap

Class SetBase

    • Constructor Detail

      • SetBase

        SetBase​(java.lang.String name,
                java.lang.String caption,
                java.lang.String description,
                Exp exp,
                boolean validated,
                java.util.Map<java.lang.String,​Annotation> annotationMap)
        Creates a SetBase.
        Parameters:
        name - Name
        caption - Caption
        description - Description
        exp - Expression
        validated - Whether has been validated
        annotationMap - Annotations
    • Method Detail

      • getAnnotationMap

        public java.util.Map<java.lang.String,​Annotation> getAnnotationMap()
        Description copied from interface: Annotated
        Returns a list of annotations.

        The map may be empty, never null.

        Specified by:
        getAnnotationMap in interface Annotated
        Returns:
        Map from annotation name to annotations.
      • getNameUniqueWithinQuery

        public java.lang.String getNameUniqueWithinQuery()
        Description copied from interface: NamedSet
        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.

        Specified by:
        getNameUniqueWithinQuery in interface NamedSet
      • isDynamic

        public boolean isDynamic()
        Description copied from interface: NamedSet
        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.
        Specified by:
        isDynamic in interface NamedSet
        Returns:
        Whether this named set is dynamic
      • getName

        public java.lang.String getName()
        Specified by:
        getName in interface OlapElement
      • getQualifiedName

        public java.lang.String getQualifiedName()
        Description copied from interface: OlapElement
        Returns the name of this element qualified by its class, for example "hierarchy 'Customers'".
        Specified by:
        getQualifiedName in interface OlapElement
      • getDimension

        public Dimension getDimension()
        Description copied from interface: OlapElement
        Returns the dimension of a this expression, or null if no dimension is defined. Applicable only to set expressions.

        Example 1:

         [Sales].children
         
        has dimension [Sales].

        Example 2:

         order(except([Promotion Media].[Media Type].members,
                      {[Promotion Media].[Media Type].[No Media]}),
               [Measures].[Unit Sales], DESC)
         
        has dimension [Promotion Media].

        Example 3:

         CrossJoin([Product].[Product Department].members,
                   [Gender].members)
         
        has no dimension (well, actually it is [Product] x [Gender], but we can't represent that, so we return null);

        Specified by:
        getDimension in interface OlapElement
      • setName

        public void setName​(java.lang.String name)
        Description copied from interface: NamedSet
        Sets the name of this named set.
        Specified by:
        setName in interface NamedSet
      • setDescription

        public void setDescription​(java.lang.String description)
      • setAnnotationMap

        public void setAnnotationMap​(java.util.Map<java.lang.String,​Annotation> annotationMap)
      • getExp

        public Exp getExp()
        Description copied from interface: NamedSet
        Returns the expression used to derive this named set.
        Specified by:
        getExp in interface NamedSet
      • getType

        public Type getType()
        Description copied from interface: NamedSet
        Returns the type of this named set.
        Specified by:
        getType in interface NamedSet