Package mondrian.olap

Class Formula

  • All Implemented Interfaces:
    Walkable

    public class Formula
    extends QueryPart
    A Formula is a clause in an MDX query which defines a Set or a Member.
    • Constructor Detail

      • Formula

        public Formula​(Id id,
                       Exp exp)
        Constructs formula specifying a set.
      • Formula

        public Formula​(Id id,
                       Exp exp,
                       MemberProperty[] memberProperties)
        Constructs a formula specifying a member.
    • Method Detail

      • clone

        public java.lang.Object clone()
        Overrides:
        clone in class java.lang.Object
      • accept

        void accept​(Validator validator)
        Resolves identifiers into objects.
        Parameters:
        validator - Validation context to resolve the identifiers in this formula
      • createElement

        void createElement​(Query q)
        Creates the Member or NamedSet object which this formula defines.
      • getChildren

        public java.lang.Object[] getChildren()
        Description copied from interface: Walkable
        Returns an array of the object's children. Those which are not Walkable are ignored.
        Specified by:
        getChildren in interface Walkable
        Overrides:
        getChildren in class QueryPart
      • unparse

        public void unparse​(java.io.PrintWriter pw)
        Description copied from class: QueryPart
        Writes a string representation of this parse tree node to the given writer.
        Overrides:
        unparse in class QueryPart
        Parameters:
        pw - writer
      • isMember

        public boolean isMember()
      • getNamedSet

        public NamedSet getNamedSet()
      • getIdentifier

        public Id getIdentifier()
        Returns the Identifier of the set or member which is declared by this Formula.
        Returns:
        Identifier
      • getName

        public java.lang.String getName()
        Returns this formula's name.
      • getCaption

        public java.lang.String getCaption()
        Returns this formula's caption.
      • rename

        void rename​(java.lang.String newName)
        Changes the last part of the name to newName. For example, [Abc].[Def].[Ghi] becomes [Abc].[Def].[Xyz]; and the member or set is renamed from Ghi to Xyz.
      • getUniqueName

        java.lang.String getUniqueName()
        Returns the unique name of the member or set.
      • getExpression

        public Exp getExpression()
      • getMdxMember

        public Member getMdxMember()
        Returns the Member. (Not valid if this formula defines a set.)
        Pre-condition:
        isMember()
        Post-condition:
        return != null
      • getSolveOrder

        public java.lang.Number getSolveOrder()
        Returns the solve order. (Not valid if this formula defines a set.)
        Returns:
        Solve order, or null if SOLVE_ORDER property is not specified or is not a number or is not constant
        Pre-condition:
        isMember()
      • compile

        public void compile()
      • accept

        public java.lang.Object accept​(MdxVisitor visitor)
        Accepts a visitor to this Formula. The default implementation dispatches to the MdxVisitor.visit(Formula) method.
        Parameters:
        visitor - Visitor