| com.microstrategy.web.objects.WebRelationship |
A WebRelationship object records schema information about how two entities are related. This interface is used in building relationship nodes within filter expressions.
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| abstract int |
getERType()
Returns the entity-relationship type set on the relationship.
| ||||||||||
| abstract WebExpression |
getExpression()
Returns the expression used in the pseudo-dimensionality context when the
fact is extended to the new table using an allocation expression.
| ||||||||||
| abstract WebObjectInfo |
getGuide()
Returns the guide object, which is an object used to guide the relationship.
| ||||||||||
| abstract WebDirectedAttributes |
getJoinAttributes()
Returns the join attributes set on the relationship.
| ||||||||||
| abstract int |
getJoinType()
Returns the join type set on the relationship.
| ||||||||||
| abstract int |
getPartialType()
Returns the partial type of the relationship.
| ||||||||||
| abstract int |
getRelationshipType()
Returns the relationship type.
| ||||||||||
| abstract void |
setERType(int erType)
Sets the entity-relationship type set on the relationship.
| ||||||||||
| abstract void |
setGuide(WebObjectInfo guide)
Sets the guide object, which is used to guide the relationship.
| ||||||||||
| abstract void |
setJoinType(int joinType)
Sets the join type set on the relationship.
| ||||||||||
| abstract void |
setPartialType(int partialType)
Sets the partial type of the relationship.
| ||||||||||
| abstract void |
setRelationshipType(int relationshipType)
Sets the relationship type.
| ||||||||||
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.
EnumDSSXMLERType.Returns the expression used in the pseudo-dimensionality context when the fact is extended to the new table using an allocation expression.
WebExpression object associated with the relationship.
Returns the guide object, which is an object used to guide the relationship. Guide objects can be either an attribute, fact, table, or the object can be null.
WebObjectInfo object.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.
WebDirectedAttributes collection containing the join attributes
of the relationship.
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.
EnumDSSXMLJoinType.Returns the partial type of the relationship. This property records if the relationship is a full relationship or a partial relationship.
EnumDSSXMLPartialType.Returns the relationship type. This property determines the type of relationship, and also determines the type, if any, of the guide object.
EnumDSSXMLExtnType.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.
| erType | The desired entity-relationship type, from EnumDSSXMLERType. |
|---|
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.
| guide | A WebObjectInfo object representing the guide object. |
|---|
| IllegalArgumentException | Thrown if the given object is not an attribute, fact, or table object. |
|---|
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.
| joinType | The desired join type, from EnumDSSXMLJoinType. |
|---|
Sets the partial type of the relationship. This property records if the relationship is a full relationship or a partial relationship.
| partialType | The new setting for partial type, from EnumDSSXMLPartialType. |
|---|
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.
| relationshipType | The new relationship type, from EnumDSSXMLExtnType. |
|---|
| IllegalArgumentException | Thrown if a relationship type is given which cannot be set without a guide object. |
|---|