Package mondrian.olap

Interface SchemaReader

    • Method Detail

      • getSchema

        RolapSchema getSchema()
        Returns the schema.
        Returns:
        Schema, never null

      • getRole

        Role getRole()
        Returns the access-control profile that this SchemaReader is implementing.

      • getCubeDimensions

        List<Dimension> getCubeDimensions​(Cube cube)
        Returns the accessible dimensions of a cube.

      • getDimensionHierarchies

        List<Hierarchy> getDimensionHierarchies​(Dimension dimension)
        Returns the accessible hierarchies of a dimension.

      • getChildrenCountFromCache

        int getChildrenCountFromCache​(Member member)
        Returns number of children parent of a member, if the information can be retrieved from cache, otherwise -1.

      • getLevelCardinality

        int getLevelCardinality​(Level level,
                        boolean approximate,
                        boolean materialize)
        Returns the number of members in a level, returning an approximation if acceptable.
        Parameters:
        level - Level
        approximate - Whether an approximation is acceptable
        materialize - Whether to go to disk if no approximation for the count is available and the members are not in cache. If false, returns Integer.MIN_VALUE if value is not in cache.

      • substitute

        Member substitute​(Member member)
        Substitutes a member with an equivalent member which enforces the access control policy of this SchemaReader.

      • getMemberChildren

        List<Member> getMemberChildren​(Member member)
        Returns direct children of member.

      • getMemberChildren

        List<Member> getMemberChildren​(Member member,
                               Evaluator context)
        Returns direct children of member, optimized for NON EMPTY.

        If context == null then there is no context and all members are returned - then its identical to getMemberChildren(Member). If context is not null, the resulting members may be restricted to those members that have a non empty row in the fact table for context. Wether or not optimization is possible depends on the SchemaReader implementation.

      • getMemberChildren

        List<Member> getMemberChildren​(List<Member> members)
        Returns direct children of each element of members.
        Parameters:
        members - Array of members
        Returns:
        array of child members

      • getMemberChildren

        List<Member> getMemberChildren​(List<Member> members,
                               Evaluator context)
        Returns direct children of each element of members which is not empty in context.
        Parameters:
        members - Array of members
        context - Evaluation context
        Returns:
        array of child members

      • getParentChildContributingChildren

        void getParentChildContributingChildren​(Member dataMember,
                                        Hierarchy hierarchy,
                                        List<Member> list)
        Returns a list of contributing children of a member of a parent-child hierarchy.
        Parameters:
        dataMember - Data member for a member of the parent-child hierarcy
        hierarchy - Hierarchy
        list - List of members to populate

      • getMemberParent

        Member getMemberParent​(Member member)
        Returns the parent of member.
        Parameters:
        member - Member
        Returns:
        null if member is a root member

      • getMemberAncestors

        void getMemberAncestors​(Member member,
                        List<Member> ancestorList)
        Returns a list of ancestors of member, in depth order.

        For example, for [Store].[USA].[CA], returns {[Store].[USA], [Store].[All Stores]}.

        Parameters:
        member - Member
        ancestorList - List of ancestors

      • getMemberDepth

        int getMemberDepth​(Member member)
        Returns the depth of a member.

        This may not be the same as member.getLevel(). getDepth() for three reasons:

        1. Access control. The most senior visible member has level 0. If the client is not allowed to see the "All" and "Nation" levels of the "Store" hierarchy, then members of the "State" level will have depth 0.
        2. Parent-child hierarchies. Suppose Fred reports to Wilma, and Wilma reports to no one. "All Employees" has depth 0, Wilma has depth 1, and Fred has depth 2. Fred and Wilma are both in the "Employees" level, which has depth 1.
        3. Ragged hierarchies. If Israel has only one, hidden, province then the depth of Tel Aviv, Israel is 2, whereas the depth of another city, San Francisco, CA, USA is 3.

      • getMemberByUniqueName

        Member getMemberByUniqueName​(List<Id.Segment> uniqueNameParts,
                             boolean failIfNotFound,
                             MatchType matchType)
        Finds a member based upon its unique name.
        Parameters:
        uniqueNameParts - Unique name of member
        failIfNotFound - Whether to throw an error, as opposed to returning null, if there is no such member.
        matchType - indicates the match mode; if not specified, EXACT
        Returns:
        The member, or null if not found

      • getMemberByUniqueName

        Member getMemberByUniqueName​(List<Id.Segment> uniqueNameParts,
                             boolean failIfNotFound)
        Finds a member based upon its unique name, requiring an exact match.

        This method is equivalent to calling getMemberByUniqueName(java.util.List, boolean, MatchType) with MatchType.EXACT.

        Parameters:
        uniqueNameParts - Unique name of member
        failIfNotFound - Whether to throw an error, as opposed to returning null, if there is no such member.
        Returns:
        The member, or null if not found

      • lookupCompound

        OlapElement lookupCompound​(OlapElement parent,
                           List<Id.Segment> names,
                           boolean failIfNotFound,
                           int category,
                           MatchType matchType)
        Looks up an MDX object by name, specifying how to match if no object exactly matches the name.

        Resolves a name such as '[Products].[Product Department].[Produce]' by resolving the components ('Products', and so forth) one at a time.

        Parameters:
        parent - Parent element to search in
        names - Exploded compound name, such as {"Products", "Product Department", "Produce"}
        failIfNotFound - If the element is not found, determines whether to return null or throw an error
        category - Type of returned element, a Category value; Category.Unknown if it doesn't matter.
        matchType - indicates the match mode; if not specified, EXACT

      • lookupCompound

        OlapElement lookupCompound​(OlapElement parent,
                           List<Id.Segment> names,
                           boolean failIfNotFound,
                           int category)
        Looks up an MDX object by name.

        Resolves a name such as '[Products].[Product Department].[Produce]' by resolving the components ('Products', and so forth) one at a time.

        Parameters:
        parent - Parent element to search in
        names - Exploded compound name, such as {"Products", "Product Department", "Produce"}
        failIfNotFound - If the element is not found, determines whether to return null or throw an error
        category - Type of returned element, a Category value; Category.Unknown if it doesn't matter.

      • getCalculatedMember

        Member getCalculatedMember​(List<Id.Segment> nameParts)
        Looks up a calculated member by name. If the name is not found in the current scope, returns null.

      • getNamedSet

        NamedSet getNamedSet​(List<Id.Segment> nameParts)
        Looks up a set by name. If the name is not found in the current scope, returns null.

      • getMemberRange

        void getMemberRange​(Level level,
                    Member startMember,
                    Member endMember,
                    List<Member> list)
        Appends to list all members between startMember and endMember (inclusive) which belong to level.

      • getLeadMember

        Member getLeadMember​(Member member,
                     int n)
        Returns a member n further along in the same level from member.

      • compareMembersHierarchically

        int compareMembersHierarchically​(Member m1,
                                 Member m2)
        Compares a pair of Members according to their order in a prefix traversal. (that is, it is an ancestor or a earlier), is a sibling, or comes later in a prefix traversal.
        Returns:
        A negative integer if m1 is an ancestor, an earlier sibling of an ancestor, or a descendent of an earlier sibling, of m2; zero if m1 is a sibling of m2; a positive integer if m1 comes later in the prefix traversal then m2.

      • getElementChild

        OlapElement getElementChild​(OlapElement parent,
                            Id.Segment name,
                            MatchType matchType)
        Looks up the child of parent called name, or an approximation according to matchType, returning null if no element is found.
        Parameters:
        parent - Parent element to search in
        name - Compound in compound name, such as "[Product]" or "&[1]"
        matchType - Match type
        Returns:
        Element with given name, or null

      • getElementChild

        OlapElement getElementChild​(OlapElement parent,
                            Id.Segment name)
        Looks up the child of parent name, returning null if no element is found.

        Always equivalent to getElementChild(parent, name, MatchType.EXACT).

        Parameters:
        parent - Parent element to search in
        name - Compound in compound name, such as "[Product]" or "&[1]"
        Returns:
        Element with given name, or null

      • getLevelMembers

        List<Member> getLevelMembers​(Level level,
                             boolean includeCalculated)
        Returns the members of a level, optionally including calculated members.

      • getLevelMembers

        List<Member> getLevelMembers​(Level level,
                             Evaluator context)
        Returns the members of a level, optionally filtering out members which are empty.
        Parameters:
        level - Level
        context - Context for filtering
        Returns:
        Members of this level

      • getHierarchyLevels

        List<Level> getHierarchyLevels​(Hierarchy hierarchy)
        Returns the accessible levels of a hierarchy.
        Parameters:
        hierarchy - Hierarchy

      • getHierarchyDefaultMember

        Member getHierarchyDefaultMember​(Hierarchy hierarchy)
        Returns the default member of a hierarchy. If the default member is in an inaccessible level, returns the nearest ascendant/descendant member.
        Parameters:
        hierarchy - Hierarchy
        Returns:
        Default member of hierarchy

      • isDrillable

        boolean isDrillable​(Member member)
        Returns whether a member has visible children.

      • isVisible

        boolean isVisible​(Member member)
        Returns whether a member is visible.

      • getCubes

        Cube[] getCubes()
        Returns the list of accessible cubes.

      • getCalculatedMembers

        List<Member> getCalculatedMembers​(Hierarchy hierarchy)
        Returns a list of calculated members in a given hierarchy.

      • getCalculatedMembers

        List<Member> getCalculatedMembers​(Level level)
        Returns a list of calculated members in a given level.

      • getCalculatedMembers

        List<Member> getCalculatedMembers()
        Returns the list of calculated members.

      • lookupMemberChildByName

        Member lookupMemberChildByName​(Member parent,
                               Id.Segment childName,
                               MatchType matchType)
        Finds a child of a member with a given name.

      • getNativeSetEvaluator

        NativeEvaluator getNativeSetEvaluator​(FunDef fun,
                                      Exp[] args,
                                      Evaluator evaluator,
                                      Calc calc)
        Returns an object which can evaluate an expression in native SQL, or null if this is not possible.
        Parameters:
        fun - Function
        args - Arguments to the function
        evaluator - Evaluator, provides context
        calc - the calc to be natively evaluated

      • getParameter

        Parameter getParameter​(String name)
        Returns the definition of a parameter with a given name, or null if not found.

      • getDataSource

        DataSource getDataSource()
        Returns the data source.
        Returns:
        data source

      • withoutAccessControl

        SchemaReader withoutAccessControl()
        Returns a similar schema reader that has no access control.
        Returns:
        Schema reader that has a similar perspective (e.g. cube) but no access control

      • getCube

        Cube getCube()
        Returns the default cube in which to look for dimensions etc.
        Returns:
        Default cube

      • withLocus

        SchemaReader withLocus()
        Returns a schema reader that automatically assigns a locus to each operation.

        It is less efficient; use this only if the operation is occurring outside the context of a statement. If you get the internal error "no locus", that's a sign you should use this method.

        Returns:
        Schema reader that assigns a locus to each operation

      • getNamespaces

        List<NameResolver.Namespace> getNamespaces()
        Returns a list of namespaces to search when resolving elements by name.

        For example, a schema reader from the perspective of a cube will return cube and schema namespaces.

        Returns:
        List of namespaces

      • countMemberChildren

        int countMemberChildren​(Member parentMember)