oracle.olapi.data.source
Class RecursiveJoinDefinition

java.lang.Object
  |
  +--oracle.olapi.data.source.SourceDefinition
        |
        +--oracle.olapi.data.source.ImmutableDefinition
              |
              +--oracle.olapi.data.source.DerivedDefinition
                    |
                    +--oracle.olapi.data.source.RecursiveJoinDefinition

public final class RecursiveJoinDefinition

extends DerivedDefinition

A DerivedDefinition that contains information about a Source that was returned by the recursiveJoin method of a Source.

Method Summary

SourceDefinition	getComparison() Gets the SourceDefinition for the comparison parameter of the operation that created this RecursiveJoinDefinition.
int	getComparisonRule() Gets the constant for the comparisonRule parameter of the operation that created this RecursiveJoinDefinition.
SourceDefinition	getJoined() Gets the SourceDefinition for the joined parameter of the operation that created this RecursiveJoinDefinition.
int	getMaxRecursions() Gets the maximum number of recursions set for the Source associated with this RecursiveJoinDefinition.
SourceDefinition	getParent() Gets the SourceDefinition for the Source that was the parent parameter of the operation that created this RecursiveJoinDefinition.
boolean	isParentsFirst() Gets the boolean value that was the parentsFirst parameter of the operation that created this RecursiveJoinDefinition.
boolean	isParentsRestrictedToBase() Gets the boolean value that was the parentsRestrictedToBase parameter of the operation that created this RecursiveJoinDefinition.
boolean	isVisible() Gets the boolean value that was the visible parameter of the operation that created this RecursiveJoinDefinition.

Methods inherited from class oracle.olapi.data.source.DerivedDefinition

getBase

Methods inherited from class oracle.olapi.data.source.SourceDefinition

getDataProvider, getModel, getSource

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getComparison

public final SourceDefinition getComparison()

Gets the SourceDefinition for the comparison parameter of the operation that created this RecursiveJoinDefinition. From that SourceDefinition, you can get the Source for it.

Returns:

The SourceDefinition for the comparison parameter of the operation that created this RecursiveJoinDefinition.

getComparisonRule

public final int getComparisonRule()

Gets the constant for the comparisonRule parameter of the operation that created this RecursiveJoinDefinition. The Source class defines the COMPARISON_RULE constants.

Returns:

The COMPARISON_RULE of the operation that created this RecursiveJoinDefinition.

getJoined

public final SourceDefinition getJoined()

Gets the SourceDefinition for the joined parameter of the operation that created this RecursiveJoinDefinition. From that SourceDefinition, you can get the Source for it.

Returns:

The SourceDefinition for the joined parameter of the operation that created this RecursiveJoinDefinition.

isVisible

public final boolean isVisible()

Gets the boolean value that was the visible parameter of the operation that created this RecursiveJoinDefinition.

Returns:

The value of the visible parameter in the operation that created this RecursiveJoinDefinition.

getParent

public SourceDefinition getParent()

Gets the SourceDefinition for the Source that was the parent parameter of the operation that created this RecursiveJoinDefinition.

Returns:

The SourceDefinition for the parent parameter in the operation that created this RecursiveJoinDefinition.

isParentsFirst

public boolean isParentsFirst()

Gets the boolean value that was the parentsFirst parameter of the operation that created this RecursiveJoinDefinition.

Returns:

The value of the parentsFirst parameter in the operation that created this RecursiveJoinDefinition.

isParentsRestrictedToBase

public boolean isParentsRestrictedToBase()

Gets the boolean value that was the parentsRestrictedToBase parameter of the operation that created this RecursiveJoinDefinition.

Returns:

The value of the parentsRestrictedToBase parameter in the operation that created this RecursiveJoinDefinition.

getMaxRecursions

public int getMaxRecursions()

Gets the maximum number of recursions set for the Source associated with this RecursiveJoinDefinition. This value determines how many levels of a hierarchy the recursiveJoin method traverses in its search for parents.

Returns:

The maximum number of iterations set for the Source associated with this RecursiveJoinDefinition.