Package com.microstrategy.web.objects

Interface WebRelationship

  • public interface WebRelationship
    A WebRelationship object records schema information about how two entities are related. This interface is used in building relationship nodes within filter expressions.
    Since:
    MicroStrategy Web 7.3.1 or earlier

    • Method Detail

      • getERType

        int getERType()
        Returns the entity-relationship type set on the relationship. If this relationship is being used to describe the relationship between attributes then this records whether each element of the parent attribute corresponds to one or to more than one element of the child attribute, and vice versa.
        Returns:
        The current entity-relationship type, from EnumDSSXMLERType.
        See Also:
        setERType(int)

      • setERType

        void setERType​(int erType)
        Sets the entity-relationship type set on the relationship. If this relationship is being used to describe the relationship between attributes then this records whether each element of the parent attribute corresponds to one or to more than one element of the child attribute, and vice versa.
        Parameters:
        erType - The desired entity-relationship type, from EnumDSSXMLERType.
        See Also:
        getERType()

      • getJoinType

        int getJoinType()
        Returns the join type set on the relationship. This property tells the engine which of several possible methods it should use to make any table join that it needs to make to find the value of the fact at the extended table level.
        Returns:
        The join type, from EnumDSSXMLJoinType.
        See Also:
        setJoinType(int)

      • setJoinType

        void setJoinType​(int joinType)
        Sets the join type set on the relationship. This property tells the engine which of several possible methods it should use to make any table join that it needs to make to find the value of the fact at the extended table level.
        Parameters:
        joinType - The desired join type, from EnumDSSXMLJoinType.
        See Also:
        getJoinType()

      • getPartialType

        int getPartialType()
        Returns the partial type of the relationship. This property records if the relationship is a full relationship or a partial relationship.
        Returns:
        The current setting for partial type, from EnumDSSXMLPartialType.
        See Also:
        setPartialType(int)

      • setPartialType

        void setPartialType​(int partialType)
        Sets the partial type of the relationship. This property records if the relationship is a full relationship or a partial relationship.
        Parameters:
        partialType - The new setting for partial type, from EnumDSSXMLPartialType.
        See Also:
        getPartialType()

      • getRelationshipType

        int getRelationshipType()
        Returns the relationship type. This property determines the type of relationship, and also determines the type, if any, of the guide object.
        Returns:
        The current relationship type, from EnumDSSXMLExtnType.
        See Also:
        setRelationshipType(int)

      • setRelationshipType

        void setRelationshipType​(int relationshipType)
                  throws java.lang.IllegalArgumentException
        Sets the relationship type. This property determines the type of relationship, and also determines the type, if any, of the guide object. Note that this method cannot be used to change to types attribute, fact, or table; in order to change to those types, simply set the appropriate guide object.
        Parameters:
        relationshipType - The new relationship type, from EnumDSSXMLExtnType.
        Throws:
        java.lang.IllegalArgumentException - Thrown if a relationship type is given which cannot be set without a guide object.
        See Also:
        getRelationshipType()

      • setGuide

        void setGuide​(WebObjectInfo guide)
       throws java.lang.IllegalArgumentException
        Sets the guide object, which is used to guide the relationship. Guide objects can be either an attrubte, fact, or table. Setting this object will cause the relationship type to change to the appropriate type for the given object.
        Parameters:
        guide - A WebObjectInfo object representing the guide object.
        Throws:
        java.lang.IllegalArgumentException - Thrown if the given object is not an attribute, fact, or table object.
        See Also:
        getGuide()

      • getJoinAttributes

        WebDirectedAttributes getJoinAttributes()
        Returns the join attributes set on the relationship. The join attributes collection is a collection of directed attributes. If the engine makes a table join to extend the fact as described in this Relationship, then it joins the attributes listed in this set.
        Returns:
        A WebDirectedAttributes collection containing the join attributes of the relationship.

      • getExpression

        WebExpression getExpression()
        Returns the expression used in the pseudo-dimensionality context when the fact is extended to the new table using an allocation expression.
        Returns:
        A WebExpression object associated with the relationship.