|
Oracle OLAP Java API Reference 10g Release 1 (10.1) B10994-01 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--oracle.olapi.data.source.Source
An OLAP API query. You use Source
objects to specify the data that you want to retrieve from the data store and to specify any analytical or other operations that you want to perform on the data.
The kinds of Source
objects that you use to specify data and to perform analysis, and the ways that you get them, are the following:
Source
objects, which are returned by the getSource
method of an MdmSource
object such as an MdmDimension
or an MdmMeasure
. A primary Source
provides access to the data that the MdmSource
represents. Getting primary Source
objects is usually the first step in creating a query. You then use the other kinds of Source
objects to select data based on the primary Source
objects and to specify analytical operations on the selections.Source
objects, which you get by calling methods on a Source
object. Methods such as join
return a new Source
that is based on the Source
on which you call the method. All queries on the data store, other than a simple list of dimension values specified by a primary Source
, are derived Source
objects.Source
objects, which are returned by the getSource
method of a FundamentalMetadataObject
. These Source
objects represent theoretical sets of data that are intrinsic to the OLAP API. Typically, you use fundamental Source
objects to represent the OLAP API data types. For example, to get a NumberSource
that represents the set of all numerical values you call the getNumberDataType
method of a FundamentalMetadataProvider
and then call getSource
on the FundamentalMetadataObject
returned by getNumberDataType
. Because fundamental Source
objects represent theoretical sets of data, you can only use them for analytical purposes; you cannot retrieve and display the values of their elements.Source
objects that you get by calling methods such as createListSource
, createRangeSource
, or getVoidSource
on a DataProvider
. Typically, you use this kind of Source
as the joined
or comparison
parameter to the join
method.Source
objects, which are returned by the getSource
method of a DynamicDefinition
. A dynamic Source
is usually a derived Source
. It is generated by a Template
, which you use to create a dynamic query that interacts with an end user.You can use the Source
for an MdmDimension
object, such as an MdmPrimaryDimension
, an MdmLevelHierarchy
, or an MdmLevel
to create a Cursor
and retrieve the elements of the dimension, hierarchy, or level. To retrieve the data represented by an MdmMeasure
or an MdmAttribute
, which are subclasses of MdmDimensionedObject
, you must specify the data that you want by using the join
method of a Source
to produce a Source
that combines the Source
for the measure or the attribute with the Source
objects that represent the dimensions of the dimensioned object.
To understand how to use join
, and the other Source
methods, you should become familiar with the concepts of the type of a Source
and of the inputs and outputs of a Source
. For a detailed description of these concepts and how they are related to each other, and for examples that use some of the Source
methods, see Source Concepts and Examples.
Most of the Source
methods are shortcuts for operations that use one or more of the alias
, distinct
, extract
, join
, position
, or value(
methods.
A Source
has an associated SourceDefinition
that contains information about the Source
. For example, a Source
that results from a join operation has an associated JoinDefinition
. You can get the SourceDefinition
for a Source
by calling its getDefinition
method.
Field Summary | |
static int |
COMPARISON_RULE_ASCENDING A constant that specifies that the join method selects only the elements of the joined Source that are in the comparison Source and that the positions of those elements in the resulting Source are in the same order as they are in the comparison Source . |
static int |
COMPARISON_RULE_ASCENDING_NULLS_FIRST A constant that specifies that the join method selects only the elements of the joined Source that are in the comparison Source and that the positions of those elements are in the same order in the resulting Source as they are in the comparison Source except that any null elements appear last. |
static int |
COMPARISON_RULE_ASCENDING_NULLS_LAST A constant that specifies that the join method selects only the elements of the joined Source that are in the comparison Source and that the positions of those elements in the resulting Source are in the same order as they are in the comparison Source with any null elements appearing last. |
static int |
COMPARISON_RULE_DESCENDING A constant that specifies that the join method selects only the elements of the joined Source that are in the comparison Source and that the positions of those elements in the resulting Source are in the reverse order of what they are in the comparison Source . |
static int |
COMPARISON_RULE_DESCENDING_NULLS_FIRST A constant that specifies that the join method selects only the elements of the joined Source that are in the comparison Source and that the positions of those elements in the resulting Source are in the reverse order of what they are in the comparison Source with any null elements appearing first. |
static int |
COMPARISON_RULE_DESCENDING_NULLS_LAST A constant that specifies that the join method selects only the elements of the joined Source that are in the comparison Source and that the positions of those elements in the resulting Source are in the reverse order of what they are in the comparison Source except that any null elements appear last. |
static int |
COMPARISON_RULE_REMOVE A constant that specifies that the join method selects only the elements of the joined Source that are not in the comparison Source . |
static int |
COMPARISON_RULE_SELECT A constant that specifies that the join method selects only the elements of the joined Source that are in the comparison Source . |
Method Summary | |
Source |
alias() Returns a Source that has the same elements as this Source , but that has this Source as its type. |
Source |
appendValue(Source appendValue) Appends the element of the specified Source to the elements of this Source . |
Source |
appendValues(Source appendValues) Appends the elements of the specified Source to the elements of this Source . |
Source |
appendValues(Source[] appendValues) Appends the elements of the specified Source array to the elements of this Source . |
Source |
at(int position) Selects the element of this Source at the specified position. |
Source |
at(NumberSource position) Selects the elements of this Source at the positions specified by the position NumberSource . |
NumberSource |
count() Counts the elements in this Source that have values. |
NumberSource |
count(boolean includeNoValue) Counts the elements in this Source , including null values if includeNoValue is true and excluding null values if includeNoValue is false . |
Source |
cumulativeInterval() For each element of this Source , specifies the elements of this Source from position 1 to the position of the current element. |
Source |
cumulativeInterval(int offset) For each element of this Source , specifies the elements of this Source from position 1 to the position of the current element plus the value specified by offset . |
Source |
cumulativeInterval(NumberSource offset) For each element of this Source , specifies the elements of this Source from position 1 to the position of the current element plus the value specified by offset . |
Source |
distinct() Selects all of the elements of this Source but removes any duplicated elements. |
BooleanSource |
eq(Source rhs) Compares the values of the elements of this Source to the values of the elements of the specified Source , and determines if they are equal. |
Source |
extract() Produces a Source that has the elements of this Source and that has this Source as an extraction input. |
Source |
findMatchFor(Source input) Determines if this Source or any of its outputs matches the specified Source and returns the matching Source when there is a match, or null when there is not. |
Source |
first() Specifies the element at position 1 of this Source . |
BooleanSource |
ge(Source rhs) Compares each element of this Source to the corresponding element of another Source and determines if it has a greater or equal value. |
DataProvider |
getDataProvider() Gets the DataProvider that is associated with this Source . |
Source |
getDataType() Gets the Source that represents the OLAP API data type of this Source . |
SourceDefinition |
getDefinition() Gets the SourceDefinition for this Source . |
java.util.Set |
getExtractionInputs() Gets the extraction inputs of this Source object. |
java.lang.String |
getID() Gets a String that uniquely identifies this Source during this connection. |
java.util.Set |
getInputs() Gets all of the inputs of this Source , both the regular inputs and the extraction inputs, if any. |
MetadataProvider |
getMetadataProvider() Gets the MetadataProvider that provides the metadata objects for this primary Source object. |
java.lang.String |
getMetadataProviderID() Gets a String that uniquely identifies the MetadataProvider for this Source . |
java.util.List |
getOutputs() Gets the outputs of this Source . |
java.util.Set |
getRegularInputs() Gets the regular inputs of this Source . |
Source |
getType() Gets the Source that is the type of this Source . |
BooleanSource |
gt(Source rhs) Compares each element of this Source to the corresponding element of another Source and determines if the value of the element of this Source is greater than the value of the element of the other Source . |
BooleanSource |
hasValue() Identifies whether each element of this Source has a value and produces a BooleanSource that has an element with the value of true when the value of the corresponding element of this Source is not null or false when the value is null . |
BooleanSource |
in(Source list) Determines if any element in this Source is also an element in the specified Source . |
Source |
interval(int bottom, int top) Selects the elements of this Source from position bottom to position top . |
Source |
interval(NumberSource bottom, NumberSource top) Selects the elements of this Source from position bottom to position top . |
boolean |
isSubtypeOf(Source input) Indicates whether the specified Source is a subtype of this Source . |
Source |
join(Source joined) Selects the elements of this Source that are specified by the elements of joined and adds joined as an output of the resulting Source . |
Source |
join(Source joined, boolean comparison) Selects the elements of this Source that are determined by the elements of joined that are true or false as specified by the value of the comparison boolean and does not add joined as an output of the resulting Source . |
Source |
join(Source joined, boolean[] comparison) Selects the elements of this Source that are specified by the elements of joined that have a value equal to a value in the comparison boolean array and does not add joined as an output to the resulting Source . |
Source |
join(Source joined, java.util.Date comparison) Selects the elements of this Source that are specified by the elements of joined that have a value equal to the comparison Date and does not add joined as an output of the resulting Source . |
Source |
join(Source joined, java.util.Date[] comparison) Selects the elements of this Source that are specified by the elements of joined that have a value equal to a value in the comparison Date array and does not add joined as an output of the resulting Source . |
Source |
join(Source joined, double comparison) Selects the elements of this Source that are specified by the elements of joined that have a value equal to the comparison double and does not add joined as an output of the resulting Source . |
Source |
join(Source joined, double[] comparison) Selects the elements of this Source that are specified by the elements of joined that have a value equal to a value in the comparison double array and does not add joined as an output of the resulting Source . |
Source |
join(Source joined, float comparison) Selects the elements of this Source that are specified by the elements of joined that have a value equal to the comparison float and does not add joined as an output of the resulting Source . |
Source |
join(Source joined, float[] comparison) Selects the elements of this Source that are specified by the elements of joined that have a value equal to a value in the comparison float array and does not add joined as an output of the resulting Source . |
Source |
join(Source joined, int comparison) Selects the elements of this Source that are specified by the elements of joined that have a value equal to the comparison int and does not add joined as an output of the resulting Source . |
Source |
join(Source joined, int[] comparison) Selects the elements of this Source that are specified by the elements of joined that have a value equal to a value in the comparison int array and does not add joined as an output of the resulting Source . |
Source |
join(Source joined, short comparison) Selects the elements of this Source that are specified by the elements of joined that have a value equal to the comparison short and does not add joined as an output of the resulting Source . |
Source |
join(Source joined, short[] comparison) Selects the elements of this Source that are specified by the elements of joined that have a value equal to a value in the comparison short array and does not add joined as an output of the resulting Source . |
Source |
join(Source joined, Source comparison) Selects the elements of this Source that are specified by the elements of joined that appear in the comparison Source and does not add joined as an output of the resulting Source . |
Source |
join(Source joined, Source comparison, boolean visible) Selects the elements of this Source that are specified by the elements of joined that appear in comparison and that has or does not have joined as an output, depending on the value of visible . |
Source |
join(Source joined, Source comparison, int comparisonRule) Selects the elements of this Source that are specified by the elements of joined that appear in comparison and does not add joined as an output of the resulting Source . |
Source |
join(Source joined, Source comparison, int comparisonRule, boolean visible) Selects the elements of this Source that are specified by the elements of joined that are selected from joined by comparison to the elements of comparison as determined by comparisonRule , and returns a Source that has or does not have joined as an output as determined by visible . |
Source |
join(Source joined, java.lang.String comparison) Selects the elements of this Source that are specified by the elements of joined that have a value equal to the comparison String and does not add joined as an output of the resulting Source . |
Source |
join(Source joined, java.lang.String[] comparison) Selects the elements of this Source that are specified by the elements of joined that have a value equal to a value in the comparison String array and does not add joined as an output of the resulting Source . |
Source |
joinHidden(Source joined) Selects the elements of this Source that are specified by the elements of joined and does not add joined as an output of the resulting Source . |
Source |
last() Specifies the element at last position of this Source . |
BooleanSource |
le(Source rhs) Compares each element of this Source to the corresponding element of another Source and determines if it has a lesser or equal value. |
BooleanSource |
lt(Source rhs) Compares each element of this Source to the corresponding element of another Source and determines if it has a lesser value. |
Source |
movingInterval(int bottom, int top) For each element of this Source , selects the elements of this Source in the range of positions from the position of the current element plus the bottom value to the position of the current element plus the top value. |
Source |
movingInterval(NumberSource bottom, NumberSource top) For each element of this Source , selects the elements of this Source in the range of positions from the position of the current element plus the bottom value to the position of the current element plus the top value. |
BooleanSource |
ne(Source rhs) Compares the values of the elements of this Source to the values of the elements of the specified Source , and determines if they are not equal. |
Source |
offset(int offset) For each element of this Source , selects the element of this Source that is the specified number of positions away from it. |
Source |
offset(NumberSource offset) For each element of this Source , selects the element of this Source that is the specified number of positions away from it. |
NumberSource |
position() Produces a NumberSource that has an ordinal integer value for the position of each element of this Source and that has this Source as a regular input. |
NumberSource |
position(boolean zeroBased) Produces a NumberSource that has an ordinal integer value for the position of each element of this Source and that has this Source as a regular input. |
NumberSource |
positionOfValue(Source value) Produces a NumberSource that has the positions of the elements of this Source that have the value that is specified by value . |
NumberSource |
positionOfValues(Source values) Produces a NumberSource that has the positions of the elements of this Source that have the values that are specified by values . |
NumberSource |
positionOfValues(Source[] values) Produces a NumberSource that has the positions of the elements of this Source that have the Source objects that are specified by values . |
Source |
recursiveJoin(Source joined, Source comparison, Source parent, int comparisonRule) Selects the specified elements of this Source and orders them hierarchically by the parents and their children in the hierarchy that this Source represents. |
Source |
recursiveJoin(Source joined, Source comparison, Source parent, int comparisonRule, boolean parentsFirst, boolean parentsRestrictedToBase) Selects the specified elements of this Source and orders them hierarchically by the parents and their children in the hierarchy that this Source represents. |
Source |
recursiveJoin(Source joined, Source comparison, Source parent, int comparisonRule, boolean parentsFirst, boolean parentsRestrictedToBase, int maxIterations, boolean visible) Selects the specified elements of this Source and, if comparisonRule is one of the ascending or descending comparison rules, orders them hierarchically by the parents and their children in the hierarchy that this Source represents. |
Source |
recursiveJoin(Source joined, java.lang.String[] comparison, Source parent, int comparisonRule) Selects the specified elements of this Source and orders them hierarchically by the parents and their children in the hierarchy that this Source represents. |
Source |
recursiveJoin(Source joined, java.lang.String[] comparison, Source parent, int comparisonRule, boolean parentsFirst, boolean parentsRestrictedToBase) Selects the specified elements of this Source and orders them hierarchically by the parents and their children in the hierarchy that this Source represents. |
Source |
recursiveJoin(Source joined, java.lang.String comparison, Source parent, int comparisonRule) Selects the specified elements of this Source and orders them hierarchically by the parents and their children in the hierarchy that this Source represents. |
Source |
recursiveJoin(Source joined, java.lang.String comparison, Source parent, int comparisonRule, boolean parentsFirst, boolean parentsRestrictedToBase) Selects the specified elements of this Source and orders them hierarchically by the parents and their children in the hierarchy that this Source represents. |
Source |
remove(BooleanSource filter) Removes the elements of this Source for which the corresponding element of the specified BooleanSource has a value of true . |
Source |
removeValue(Source value) Removes the elements of this Source that have the specified value. |
Source |
removeValues(Source values) Removes the elements of this Source that have the specified values. |
Source |
removeValues(Source[] values) Removes the elements of this Source that have the specified Source objects. |
Source |
select(BooleanSource filter) Selects the elements of this Source for which the corresponding element of the specified BooleanSource has a value of true . |
Source |
selectDescendants(Source comparison, Source parent) Selects the elements of this Source that are specified by comparison and the descendants of those elements in the hierarchy that this Source represents. |
Source |
selectValue(Source value) Selects the elements of this Source that have the specified value. |
Source |
selectValues(Source values) Selects the elements of this Source that have the specified values. |
Source |
selectValues(Source[] values) Selects the elements of this Source that have the specified values. |
Source |
sortAscending() Sorts the elements of this Source in the ascending order of their data type. |
Source |
sortAscending(Source sortValue) Selects the elements of this Source that are specified by the elements of sortValue , and orders them in the ascending order of the sortValue data type. |
Source |
sortAscending(Source sortValue, boolean nullsFirst) Selects the elements of this Source that are specified by the elements of sortValue , and orders them in the ascending order of the sortValue data type. |
Source |
sortAscendingHierarchically(Source parent) Selects the elements of this Source and the descendants of those elements in the hierarchy that this Source represents and sorts the children of the parents in ascending order with the parents appearing before the children in the result. |
Source |
sortAscendingHierarchically(Source parent, boolean parentsFirst) Selects the elements of this Source and the descendants of those elements in the hierarchy that this Source represents and sorts the children of the parents in ascending order. |
Source |
sortAscendingHierarchically(Source joined, Source parent) Selects the elements of this Source that are specified by joined and the descendants of those elements in the hierarchy that this Source represents and sorts the children of the parents in ascending order with the parents appearing before their children. |
Source |
sortAscendingHierarchically(Source joined, Source parent, boolean parentsFirst, boolean parentsRestrictedToBase) Selects the elements of this Source that are specified by joined and the descendants of those elements in the hierarchy that this Source represents and sorts the children of the parents in ascending order. |
Source |
sortDescending() Sorts the elements of this Source in the descending order of their values. |
Source |
sortDescending(Source sortValue) Selects the elements of this Source that are specified by the elements of sortValue , and orders them in the descending order of the sortValue data type. |
Source |
sortDescending(Source sortValue, boolean nullsFirst) Selects the elements of this Source that are specified by the elements of sortValue , and orders them in the descending order of the sortValue data type. |
Source |
sortDescendingHierarchically(Source parent) Selects the elements of this Source and the descendants of those elements in the hierarchy that this Source represents and sorts the children of the parents in descending order with the parents appearing before the children in the result. |
Source |
sortDescendingHierarchically(Source parent, boolean parentsFirst) Selects the elements of this Source and the descendants of those elements in the hierarchy that this Source represents and sorts the children of the parents in descending order. |
Source |
sortDescendingHierarchically(Source joined, Source parent) Selects the elements of this Source that are specified by joined and the descendants of those elements in the hierarchy that this Source represents and sorts the children of the parents in descending order with the parents appearing before their children. |
Source |
sortDescendingHierarchically(Source joined, Source parent, boolean parentsFirst, boolean parentsRestrictedToBase) Selects the elements of this Source that are specified by joined and the descendants of those elements in the hierarchy that this Source represents and sorts the children of the parents in descending order. |
NumberSource |
toDoubleSource() Converts the values of the elements of this Source to the Java double data type. |
NumberSource |
toFloatSource() Converts the values of the elements of this Source to the Java float data type. |
NumberSource |
toIntegerSource() Converts the values of the elements of this Source to the Java int data type. |
NumberSource |
toShortSource() Converts the values of the elements of this Source to the Java short data type. |
StringSource |
toStringSource() Converts the values of the elements of this Source to Java String objects. |
Source |
value() Produces a Source that has the elements of this Source and that has this Source as an input. |
Source |
value(Source input) Produces a Source that has the same elements as this Source and that has the specified Source as an input. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final int COMPARISON_RULE_ASCENDING
join
method selects only the elements of the joined
Source
that are in the comparison
Source
and that the positions of those elements in the resulting Source
are in the same order as they are in the comparison
Source
.public static final int COMPARISON_RULE_ASCENDING_NULLS_FIRST
join
method selects only the elements of the joined
Source
that are in the comparison
Source
and that the positions of those elements are in the same order in the resulting Source
as they are in the comparison
Source
except that any null
elements appear last.public static final int COMPARISON_RULE_ASCENDING_NULLS_LAST
join
method selects only the elements of the joined
Source
that are in the comparison
Source
and that the positions of those elements in the resulting Source
are in the same order as they are in the comparison
Source
with any null
elements appearing last. This rule is the same as COMPARISON_RULE_ASCENDING
.public static final int COMPARISON_RULE_DESCENDING
join
method selects only the elements of the joined
Source
that are in the comparison
Source
and that the positions of those elements in the resulting Source
are in the reverse order of what they are in the comparison
Source
.public static final int COMPARISON_RULE_DESCENDING_NULLS_FIRST
join
method selects only the elements of the joined
Source
that are in the comparison
Source
and that the positions of those elements in the resulting Source
are in the reverse order of what they are in the comparison
Source
with any null
elements appearing first. This rule is the same as COMPARISON_RULE_DESCENDING
.public static final int COMPARISON_RULE_DESCENDING_NULLS_LAST
join
method selects only the elements of the joined
Source
that are in the comparison
Source
and that the positions of those elements in the resulting Source
are in the reverse order of what they are in the comparison
Source
except that any null
elements appear last.public static final int COMPARISON_RULE_REMOVE
join
method selects only the elements of the joined Source
that are not in the comparison Source
.public static final int COMPARISON_RULE_SELECT
join
method selects only the elements of the joined
Source
that are in the comparison
Source
.Method Detail |
public final Source alias()
Source
that has the same elements as this Source
, but that has this Source
as its type. Use this method when you want to control the match of a Source
to an input or to create a parameter to use as the input of a function.
A Source
object created by this method has a paired AliasDefinition
object that contains its definition.
Source
that has the same elements, inputs, and outputs as this Source
object, but that has this Source
as its type.public final Source appendValue(Source appendValue)
Source
to the elements of this Source
.
This method is equivalent to the following code where base
is this Source
, appendSource
is the Source
whose elements you want to append to this Source
, and dp
is the DataProvider
.
Source discriminator = dp.createListSource(new Source[] {base, appendSource}); Source result = discriminator.extract() .join(discriminator, dp.getEmptySource(), Source.COMPARISON_RULE_REMOVE, false);
appendValue
- A Source
whose element you want to append to this Source
.Source
that has the same elements as this Source
with the element of the specified Source
appended.public final Source appendValues(Source[] appendValues)
Source
array to the elements of this Source
.
This method is equivalent to the following code where base
is this Source
, appendSource
is the Source
array whose elements you want to append to this Source
, and dp
is the DataProvider
.
Source discriminator = dp.createListSource(new Source[] {base, appendSource}); Source result = discriminator.extract() .join(discriminator, dp.getEmptySource(), Source.COMPARISON_RULE_REMOVE, false);
appendValues
- An array of Source
objects whose elements you want to append to this Source
.Source
that has the same elements as this Source
with the elements of the specified Source
array appended.public final Source appendValues(Source appendValues)
Source
to the elements of this Source
.
This method is equivalent to the following code where base
is this Source
, appendSource
is the Source
whose elements you want to append to this Source
, and dp
is the DataProvider
.
Source discriminator = dp.createListSource(new Source[] {base, appendSource}); Source result = discriminator.extract() .join(discriminator, dp.getEmptySource(), Source.COMPARISON_RULE_REMOVE, false);
appendValues
- A Source
whose elements you want to append to this Source
.Source
that has the same elements as this Source
with the elements of the specified Source
appended.public final Source at(int position)
Source
at the specified position.
This method is equivalent to the following code where base
is this Source
and pos
specifies the position of the element that you want in the returned Source
.
Source result = base.join(base.position(), pos, Source.COMPARISON_RULE_SELECT, false);
position
- The one-based position of the element of this Source
that you want to have in the returned Source
.Source
that has the element of this Source
specified by position
.public final Source at(NumberSource position)
Source
at the positions specified by the position
NumberSource
.
This method is equivalent to the following code where base
is this Source
and pos
is the NumberSource
that specifies the positions of the elements that you want the returned Source
to have.
Source result = base.join(base.position(), pos, Source.COMPARISON_RULE_SELECT, false);In the following example,
dp
is the DataProvider
, and prodHier
is the Source
for the default hierarchy of a dimension of product values.
NumberSource positions = dp.createListSource(new int[] {3, 6, 9}); Source result = prodHier.at(positions);A
Cursor
for the result
Source
has the following unique values.
PRODUCT_ROLLUP::FAMILY::4 PRODUCT_ROLLUP::ITEM::15 PRODUCT_ROLLUP::ITEM::17
position
- A NumberSource
that has the one-based positions of the elements of this Source
that you want to have in the resulting Source
.Source
that has the elements of this Source
that are specified by position
.public final NumberSource count()
Source
that have values.NumberSource
that has an element whose value is the number of elements in this Source
that have a value that is not null
.public final NumberSource count(boolean includeNoValue)
Source
, including null
values if includeNoValue
is true
and excluding null
values if includeNoValue
is false
.includeNoValue
- Specifies whether this method counts elements with a null
value. Specify true
if you want the method to count elements with a null
value or false
if you do not.NumberSource
that has an element whose value is the number of elements in this Source
.public final Source cumulativeInterval()
Source
, specifies the elements of this Source
from position 1 to the position of the current element. This method is equivalent to the following code where base
is this Source
and dp
is the DataProvider
.
Source range = dp.createRangeSource(1, base.position()); Source cumInterval = base.join(base.position(), range, Source.COMPARISON_RULE_SELECT, false);Because
range
, the comparison
parameter of the join operation, has an input of base
, the resulting cumInterval
Source
also has base
as an input.
In the following example, shortDescMonths2002
is a Source
that specifies the short descriptions for the months for the year 2002. The Source
does not have any inputs or outputs. The first line produces the cumIntMonths
Source
, which has a type of shortDescMonths2002
and has shortDescMonths2002
as an input. The second line joins cumIntMonths
to shortDescMonths2002
. The input of cumIntMonths
is matched by the joined
parameter, shortDescMonths2002
.
Source cumIntMonths = shortDescMonths2002.cumulativeInterval(); Source result = cumIntMonths.join(shortDescMonths2002);A
Cursor
for result
has the following values, which are displayed with the positions of the elements of result
in the left column, the values of the shortDescMonths2002
output in the middle column, and the values of result
in the right column. The Cursor
has the 78 elements specified by the result
Source
but the values from element 7 to element 66 are not shown.
Cumulative Interval Months 2002 for Months 2002 ----------- ------------------- 1: Jan-02 Jan-02 2: Feb-02 Jan-02 3: Feb-02 Feb-02 4: Mar-02 Jan-02 5: Mar-02 Feb-02 6: Mar-02 Mar-02 . . . 67: Dec-02 Jan-02 68: Dec-02 Feb-02 69: Dec-02 Mar-02 70: Dec-02 Apr-02 71: Dec-02 May-02 72: Dec-02 Jun-02 73: Dec-02 Jul-02 74: Dec-02 Aug-02 75: Dec-02 Sep-02 76: Dec-02 Oct-02 77: Dec-02 Nov-02 78: Dec-02 Dec-02
Source
that, for each element of this Source
, specifies the positions of this Source
that are less than or equal to the position of that element.public final Source cumulativeInterval(int offset)
Source
, specifies the elements of this Source
from position 1 to the position of the current element plus the value specified by offset
. This method is equivalent to the following code where base
is this Source
, dp
is the DataProvider
, and offset
is an integer.
Source range = dp.createRangeSource(1, base.position().plus(offset)); Source cumInterval = base.join(base.position(), range, Source.COMPARISON_RULE_SELECT, false);Because
range
, the comparison
parameter of the join operation, has an input of base
, the resulting cumInterval
Source
also has base
as an input.
In the following example, shortDescMonths2002
is a Source
that specifies the short descriptions of the months for the year 2002. The Source
does not have any inputs or outputs. The first line produces the cumIntMonths
Source
, which has a type of shortDescMonths2002
and has shortDescMonths2002
as an input. The second line joins cumIntMonths
to shortDescMonths2002
. The input of cumIntMonths
is matched by the joined
parameter, shortDescMonths2002
.
Source cumIntMonths = shortDescMonths2002.cumulativeInterval(3); Source result = cumIntMonths.join(shortDescMonths2002);A
Cursor
for result
has the following values, which are displayed with the positions of the elements of result
in the left column, the values of the shortDescMonths2002
output in the middle column, and the values of result
in the right column. The Cursor
has the 108 elements specified by the result
Source
but the values from element 10 to element 98 are not shown. *
Cumulative Interval Months 2002 for Months 2002 ----------- ------------------- 1: Jan-02 Jan-02 2: Jan-02 Feb-02 3: Jan-02 Mar-02 4: Jan-02 Apr-02 5: Feb-02 Jan-02 6: Feb-02 Feb-02 7: Feb-02 Mar-02 8: Feb-02 Apr-02 9: Feb-02 May-02 . . . 98: Dec-02 Feb-02 99: Dec-02 Mar-02 100: Dec-02 Apr-02 101: Dec-02 May-02 102: Dec-02 Jun-02 103: Dec-02 Jul-02 104: Dec-02 Aug-02 105: Dec-02 Sep-02 106: Dec-02 Oct-02 107: Dec-02 Nov-02 108: Dec-02 Dec-02
offset
- The number of positions to add to the position of each element of this Source
.Source
that, for each element of this Source
, specifies the positions of this Source
that are less than or equal to the position of that element plus the offset.public final Source cumulativeInterval(NumberSource offset)
Source
, specifies the elements of this Source
from position 1 to the position of the current element plus the value specified by offset
. This method is equivalent to the following code where base
is this Source
, dp
is the DataProvider
, and offset
is a NumberSource
specifying a single value.
Source range = dp.createRangeSource(1, base.position().plus(offset)); Source cumInterval = base.join(base.position(), range, Source.COMPARISON_RULE_SELECT, false);Because
range
, the comparison
parameter of the join operation, has an input of base
, the resulting cumInterval
Source
also has base
as an input.
For an example, see the cumulativeInterval(int offset)
method, and substitute a NumberSource
specifying the number 3 for the offset
in the example of that method.
offset
- The number of positions to add to the position of each element of this Source
.Source
that, for each element of this Source
, specifies the positions of this Source
that are less than or equal to the position of that element plus the offset.public final Source distinct()
Source
but removes any duplicated elements. This method returns a Source
that has the same type as this Source
, but that has no duplicate elements.
Each Source
returned by this method has an associated DistinctDefinition
object that contains its definition.
Source
that has only the elements of this Source
that are distinct.public final BooleanSource eq(Source rhs)
Source
to the values of the elements of the specified Source
, and determines if they are equal. This method produces a BooleanSource
that has an element whose value is true
when the value of a given element of this Source
equals the value of the corresponding element in the specified Source
or false
when it does not.rhs
- The Source
whose elements you want to compare to the elements of this Source
.BooleanSource
that has an element with the value of true
when the value of a given element of this Source
equals the value of the corresponding element of the specified Source
, or false
when it does not.public final Source extract()
Source
that has the elements of this Source
and that has this Source
as an extraction input.
The following example creates a list Source
that has as its values the Source
objects for a measure that has the cost of product units and a measure that has the price of product units. Both measures are dimensioned by dimensions for times and products. In the second line of the example, the extract
method produces an unnamed Source
that has the measures
Source
as an extraction input. The following joinHidden
method matches that input to its joined
parameter, which is also the measures
Source
. The result of the joinHidden
method is an unnamed Source
that specifies the values of the unitCost
and unitPrice
Source
objects, which are the values of the elements of the measures
Source
.
The example joins prodSel
, which is a selection of the product values 1285
and 1448
, to the result of the joinHidden
method and then joins daySel
, which is the time value 09-JUL-99
.
Source measures = dp.createListSource(new Source[] {unitCost, unitPrice}); Source cube = measures.extract().joinHidden(measures) .join(prodSel) .join(daySel);The resulting
Source
, cube
, has as the values of its elements the values from the measures for the costs and the prices of products, and it has as outputs daySel
and prodSel
. The measures
Source
is not an output of cube
because it was the joined
parameter of the joinedHidden
method.
A Cursor
for cube
has daySel
and prodSel
as outputs and has the unit cost and unit price values for the specified products and days. The following crosstab display adds column headings and formatting to the values of the Cursor
and includes only the local values of the dimensions. The left column lists the products, the middle column lists the unit costs, and the right column lists the unit prices.
09-JUL-99 Product Cost Price ------- ----- ----- 1285 7.80 19.00 1448 12.60 42.00
A Source
returned by this method has a paired ExtractionDefinition
that contains its definition.
Source
that has the elements of this Source
and that has this Source
as an extraction input.public final Source findMatchFor(Source input)
Source
or any of its outputs matches the specified Source
and returns the matching Source
when there is a match, or null
when there is not. A match occurs when this Source
or any of its outputs is the same type as, or is a supertype of, the specified Source
.input
- The Source
that you want to match to this Source
or to any of its outputs.Source
when there is a match, or null
when there is not.public final Source first()
Source
. This method is equivalent to the following code where base
is this Source
and dp
is the DataProvider
.
Source firstBaseElement = base.join(base.position(), dp.createConstantSource(1), Source.COMPARISON_RULE_SELECT, false);
Source
that has the first element of this Source
.public final BooleanSource ge(Source rhs)
Source
to the corresponding element of another Source
and determines if it has a greater or equal value. This method produces a BooleanSource
that has an element with the value of true
for each element of this Source
that has a value that is greater than or equal to the value of the corresponding element in the specified Source
, and an element with the value of false
for each element of this Source
that does not.rhs
- The Source
whose elements you want to compare to the elements of this Source
.BooleanSource
that has an element with the value of true
for each element of this Source
that has a value that is greater than or equal to the value of the corresponding element in the specified Source
, and an element with the value of false
for each element of this Source
that does not.public final DataProvider getDataProvider()
DataProvider
that is associated with this Source
.DataProvider
that is associated with this Source
.public Source getDataType()
Source
that represents the OLAP API data type of this Source
. A Source
can have one of the following OLAP API data types:
Source
for an OLAP API data type by using the getSource
method of the FundamentalMetadataObject
for that data type. You get the FundamentalMetadataObject
by using a method of a FundamentalMetadataProvider
, such as the getBooleanDataType
method.Source
that represents the OLAP API data type of this Source
.public final SourceDefinition getDefinition()
SourceDefinition
for this Source
. The SourceDefinition
has information about the Source
.SourceDefinition
for this Source
.public final java.util.Set getExtractionInputs()
Source
object.Set
that contains the Source
objects that are the extraction inputs of this Source
.public final java.lang.String getID()
String
that uniquely identifies this Source
during this connection.String
that uniquely identifies this Source
during this connection.public final java.util.Set getInputs()
Source
, both the regular inputs and the extraction inputs, if any.Set
that contains the Source
objects that are the inputs of this Source
.public final MetadataProvider getMetadataProvider()
MetadataProvider
that provides the metadata objects for this primary Source
object. Returns null
for a Source
that is not a primary Source
.MetadataProvider
that provides the metadata objects for this Source
object.public final java.lang.String getMetadataProviderID()
String
that uniquely identifies the MetadataProvider
for this Source
.String
that uniquely identifies the MetadataProvider
for this Source
.public final java.util.List getOutputs()
Source
.List
that contains the Source
objects that are the outputs of this Source
.public final java.util.Set getRegularInputs()
Source
.Set
that contains the Source
objects that are the regular inputs of this Source
.public final Source getType()
Source
that is the type of this Source
. To retrieve the OLAP API data type of this Source
, use the getDataType
method.Source
.public final BooleanSource gt(Source rhs)
Source
to the corresponding element of another Source
and determines if the value of the element of this Source
is greater than the value of the element of the other Source
. This method produces a BooleanSource
that has an element with the value of true
for each element of this Source
that has a value that is greater than the value of the corresponding element in the specified Source
, and an element with the value of false
for each element of this Source
that does not.rhs
- The Source
whose elements you want to compare to the elements of this Source
.BooleanSource
that has an element with the value of true
for each element of this Source
that has a value that is greater than the value of the corresponding element in the specified Source
, and an element with the value of false
for each element of this Source
that does not.public final BooleanSource hasValue()
Source
has a value and produces a BooleanSource
that has an element with the value of true
when the value of the corresponding element of this Source
is not null
or false
when the value is null
.BooleanSource
that has an element with the value of true
when the value of the corresponding element of this Source
is not null
or false
when it is.public final BooleanSource in(Source list)
Source
is also an element in the specified Source
. This method returns a BooleanSource
that has an element with a value of true
when the value of any element of this Source
equals a value of an element in the specified Source
.
This method is equivalent to the following code where base
is this Source
.
BooleanSource result = base.eq(list).forAny();
list
- The Source
that you want to compare to this Source
.BooleanSource
that has an element with a value of true
when the value of any element in this Source
is equal to the value of an element in the specified Source
or false
when none of the values of the elements of this Source
equals the value of an element of the specified Source
.public final Source interval(int bottom, int top)
Source
from position bottom
to position top
. The positions of a Source
are one-based. This method is equivalent to the following code where base
is this Source
and dp
is the DataProvider
.
Source range = dataProvider.createRangeSource(bottom, top); Source result = base.join(base.position(), range, Source.COMPARISON_RULE_SELECT, false);
bottom
- The position of the first element in this Source
that you want to have in the result.top
- The position of the last element in this Source
that you want to have in the result.Source
that specifies the elements of this Source
from position bottom
to position top
.public final Source interval(NumberSource bottom, NumberSource top)
Source
from position bottom
to position top
. The positions of a Source
are one-based. This method is equivalent to the following code where base
is this Source
and dp
is the DataProvider
.
Source range = dataProvider.createRangeSource(bottom, top); Source result = base.join(base.position(), range, Source.COMPARISON_RULE_SELECT, false);
bottom
- The position of the first element in this Source
that you want to have in the result.top
- The position of the last element in this Source
that you want to have in the result.Source
that specifies the elements of this Source
from position bottom
to position top
.public final boolean isSubtypeOf(Source input)
Source
is a subtype of this Source
.input
- The Source
that you want to determine whether it is a subtype of this Source
.true
when the specified Source
is a subtype of this Source
or false
when it is not.public final Source join(Source joined)
Source
that are specified by the elements of joined
and adds joined
as an output of the resulting Source
. This method is equivalent to the following code where base
is this Source
and dp
is the DataProvider
.
Source result = base.join(joined, dp.getEmptySource(), Source.COMPARISON_RULE_REMOVE, true);
joined
- The Source
whose elements specify the elements of this Source
that appear in the resulting Source
.Source
that has the elements of this Source
that are specified by the elements of joined
and that has joined
as an output.join(Source joined, Source comparison, int comparisonRule, boolean visible)
public final Source join(Source joined, double[] comparison)
Source
that are specified by the elements of joined
that have a value equal to a value in the comparison
double
array and does not add joined
as an output of the resulting Source
. This method is equivalent to the following code where base
is this Source
, dp
is the DataProvider
, and doubleArray
is the double
array that you want to use to select elements of joined
.
Source result = base.join(joined, dp.createListSource(doubleArray), Source.COMPARISON_RULE_SELECT, false);
joined
- The Source
whose elements specify the elements of this Source
that appear in the resulting Source
.comparison
- An array of double
values that you want to use to select the elements of joined
.Source
that has the elements of this Source
that are specified by the elements of joined
that have a value equal to a value in comparison
and that does not have joined
as an output.join(Source joined, Source comparison, int comparisonRule, boolean visible)
public final Source join(Source joined, float[] comparison)
Source
that are specified by the elements of joined
that have a value equal to a value in the comparison
float
array and does not add joined
as an output of the resulting Source
. This method is equivalent to the following code where base
is this Source
, dp
is the DataProvider
, and floatArray
is the float
array that you want to use to select elements of joined
.
Source result = base.join(joined, dp.createListSource(floatArray), Source.COMPARISON_RULE_SELECT, false);
joined
- The Source
whose elements specify the elements of this Source
that appear in the resulting Source
.comparison
- An array of float
values that you want to use to select the elements of joined
.Source
that has the elements of this Source
that are specified by the elements of joined
that have a value equal to a value in comparison
and that does not have joined
as an output.join(Source joined, Source comparison, int comparisonRule, boolean visible)
public final Source join(Source joined, int[] comparison)
Source
that are specified by the elements of joined
that have a value equal to a value in the comparison
int
array and does not add joined
as an output of the resulting Source
. This method is equivalent to the following code where base
is this Source
, dp
is the DataProvider
, and intArray
is the int
array that you want to use to select elements of joined
.
Source result = base.join(joined, dp.createListSource(intArray), Source.COMPARISON_RULE_SELECT, false);
joined
- The Source
whose elements specify the elements of this Source
that appear in the resulting Source
.comparison
- An array of int
values that you want to use to select the elements of joined
.Source
that has the elements of this Source
that are specified by the elements of joined
that have a value equal to a value in comparison
and that does not have joined
as an output.join(Source joined, Source comparison, int comparisonRule, boolean visible)
public final Source join(Source joined, java.lang.String[] comparison)
Source
that are specified by the elements of joined
that have a value equal to a value in the comparison
String
array and does not add joined
as an output of the resulting Source
. This method is equivalent to the following code where base
is this Source
, dp
is the DataProvider
, and stringArray
is the String
array that you want to use to select elements of joined
.
Source result = base.join(joined, dp.createListSource(stringArray), Source.COMPARISON_RULE_SELECT, false);
joined
- The Source
whose elements specify the elements of this Source
that appear in the resulting Source
.comparison
- An array of String
values that you want to use to select the elements of joined
.Source
that has the elements of this Source
that are specified by the elements of joined
that have a value equal to a value in comparison
and that does not have joined
as an output.join(Source joined, Source comparison, int comparisonRule, boolean visible)
public final Source join(Source joined, java.util.Date[] comparison)
Source
that are specified by the elements of joined
that have a value equal to a value in the comparison
Date
array and does not add joined
as an output of the resulting Source
. This method is equivalent to the following code where base
is this Source
, dp
is the DataProvider
, and dateArray
is the Date
array that you want to use to select elements of joined
.
Source result = base.join(joined, dp.createListSource(dateArray), Source.COMPARISON_RULE_SELECT, false);
joined
- The Source
whose elements specify the elements of this Source
that appear in the resulting Source
.comparison
- An array of Date
values that you want to use to select the elements of joined
.Source
that has the elements of this Source
that are specified by the elements of joined
that have a value equal to a value in comparison
and that does not have joined
as an output.join(Source joined, Source comparison, int comparisonRule, boolean visible)
public final Source join(Source joined, short[] comparison)
Source
that are specified by the elements of joined
that have a value equal to a value in the comparison
short
array and does not add joined
as an output of the resulting Source
. This method is equivalent to the following code where base
is this Source
, dp
is the DataProvider
, and shortArray
is the short
array that you want to use to select elements of joined
.
Source result = base.join(joined, dp.createListSource(shortArray), Source.COMPARISON_RULE_SELECT, false);
joined
- The Source
whose elements specify the elements of this Source
that appear in the resulting Source
.comparison
- An array of short
values that you want to use to select the elements of joined
.Source
that has the elements of this Source
that are specified by the elements of joined
that have a value equal to a value in comparison
and that does not have joined
as an output.join(Source joined, Source comparison, int comparisonRule, boolean visible)
public final Source join(Source joined, boolean[] comparison)
Source
that are specified by the elements of joined
that have a value equal to a value in the comparison
boolean
array and does not add joined
as an output to the resulting Source
. This method is equivalent to the following code where base
is this Source
, dp
is the DataProvider
, and booleanArray
is the boolean
array that you want to use to select elements of joined
.
Source result = base.join(joined, dp.createListSource(booleanArray), Source.COMPARISON_RULE_SELECT, false);
joined
- The Source
whose elements specify the elements of this Source
that appear in the resulting Source
.comparison
- An array of boolean
values that you want to use to select the elements of joined
.Source
that has the elements of this Source
that are specified by the elements of joined
that have a value equal to a value in comparison
and that does not have joined
as an output.join(Source joined, Source comparison, int comparisonRule, boolean visible)
public final Source join(Source joined, double comparison)
Source
that are specified by the elements of joined
that have a value equal to the comparison
double
and does not add joined
as an output of the resulting Source
. This method is equivalent to the following code where base
is this Source
, dp
is the DataProvider
, and doubleValue
is the double
that you want to use to select elements of joined
.
Source result = base.join(joined, dp.createConstantSource(doubleValue), Source.COMPARISON_RULE_SELECT, false);
joined
- The Source
whose elements specify the elements of this Source
that appear in the resulting Source
.comparison
- A double
value that you want to use to select the elements of joined
.Source
that has the elements of this Source
that are specified by the elements of joined
that have a value equal to comparison
and that does not have joined
as an output.join(Source joined, Source comparison, int comparisonRule, boolean visible)
public final Source join(Source joined, float comparison)
Source
that are specified by the elements of joined
that have a value equal to the comparison
float
and does not add joined
as an output of the resulting Source
. This method is equivalent to the following code where base
is this Source
, dp
is the DataProvider
, and floatValue
is the float
that you want to use to select elements of joined
.
Source result = base.join(joined, dp.createConstantSource(floatValue), Source.COMPARISON_RULE_SELECT, false);
joined
- The Source
whose elements specify the elements of this Source
that appear in the resulting Source
.comparison
- A float
value that you want to use to select the elements of joined
.Source
that has the elements of this Source
that are specified by the elements of joined
that have a value equal to comparison
and that does not have joined
as an output.join(Source joined, Source comparison, int comparisonRule, boolean visible)
public final Source join(Source joined, int comparison)
Source
that are specified by the elements of joined
that have a value equal to the comparison
int
and does not add joined
as an output of the resulting Source
. This method is equivalent to the following code where base
is this Source
, dp
is the DataProvider
, and intValue
is the int
that you want to use to select elements of joined
.
Source result = base.join(joined, dp.createConstantSource(intValue), Source.COMPARISON_RULE_SELECT, false);
joined
- The Source
whose elements specify the elements of this Source
that appear in the resulting Source
.comparison
- An int
value that you want to use to select the elements of joined
.Source
that has the elements of this Source
that are specified by the elements of joined
that have a value equal to comparison
and that does not have joined
as an output.join(Source joined, Source comparison, int comparisonRule, boolean visible)
public final Source join(Source joined, java.lang.String comparison)
Source
that are specified by the elements of joined
that have a value equal to the comparison
String
and does not add joined
as an output of the resulting Source
. This method is equivalent to the following code where base
is this Source
, dp
is the DataProvider
, and stringValue
is the String
that you want to use to select elements of joined
.
Source result = base.join(joined, dp.createConstantSource(stringValue), Source.COMPARISON_RULE_SELECT, false);
joined
- The Source
whose elements specify the elements of this Source
that appear in the resulting Source
.comparison
- A String
value that you want to use to select the elements of joined
.Source
that has the elements of this Source
that are specified by the elements of joined
that have a value equal to comparison
and that does not have joined
as an output.join(Source joined, Source comparison, int comparisonRule, boolean visible)
public final Source join(Source joined, java.util.Date comparison)
Source
that are specified by the elements of joined
that have a value equal to the comparison
Date
and does not add joined
as an output of the resulting Source
. This method is equivalent to the following code where base
is this Source
, dp
is the DataProvider
, and dateValue
is the Date
that you want to use to select elements of joined
.
Source result = base.join(joined, dp.createConstantSource(dateValue), Source.COMPARISON_RULE_SELECT, false);
joined
- The Source
whose elements specify the elements of this Source
that appear in the resulting Source
.comparison
- A Date
value that you want to use to select the elements of joined
.Source
that has the elements of this Source
that are specified by the elements of joined
that have a value equal to comparison
and that does not have joined
as an output.join(Source joined, Source comparison, int comparisonRule, boolean visible)
public final Source join(Source joined, Source comparison)
Source
that are specified by the elements of joined
that appear in the comparison
Source
and does not add joined
as an output of the resulting Source
. This method is equivalent to the following code where base
is this Source
.
Source result = base.join(joined, comparison, Source.COMPARISON_RULE_SELECT, false);
joined
- The Source
whose elements specify the elements of this Source
that appear in the resulting Source
.comparison
- The Source
that has the element or elements that you want to select from joined
.Source
that specifies the elements of base
as determined by the elements of joined
that appear in comparison
and that does not have joined
as an output.join(Source joined, Source comparison, int comparisonRule, boolean visible)
public final Source join(Source joined, Source comparison, int comparisonRule)
Source
that are specified by the elements of joined
that appear in comparison
and does not add joined
as an output of the resulting Source
.
This method is equivalent to the following code where base
is this Source
.
Source result = base.join(joined, comparison, comparisonRule, false);
joined
- The Source
whose elements specify the elements of this Source
that appear in the resulting Source
.comparison
- The Source
that has the element or elements that you want to select or remove from joined
.comparisonRule
- The rule that specifies whether this method selects from joined
only the elements of joined
that are in comparison
or selects only the elements of joined
that are not in comparison
, and whether this method sorts the selected elements in the same order of positions as in comparison
or in the reverse order of those positions. Specify a value for this parameter using one of the Source.COMPARISON_RULE
fields.Source
that specifies the elements of base
as determined by the elements of joined
that appear in comparison
and are selected and ordered as specified by comparisonRule
, and that does not have joined
as an output.join(Source joined, Source comparison, int comparisonRule, boolean visible)
public final Source join(Source joined, Source comparison, int comparisonRule, boolean visible)
Source
that are specified by the elements of joined
that are selected from joined
by comparison to the elements of comparison
as determined by comparisonRule
, and returns a Source
that has or does not have joined
as an output as determined by visible
. With this method and its shortcuts, you incrementally join Source
objects to produce a query that specifies the data that you want to retrieve from the data store.
Because a Source
with an input does not fully specify the data to retrieve from the data store, you cannot create a Cursor
for a Source
with an input. To produce a Source
for which you can create a Cursor
, you must match to the input a Source
that has the elements that you want to specify.
You use this join
method, or one of its shortcuts, to match a Source
to an input. For a description of the concepts of type, data type, inputs, and outputs of a Source
, and for detailed information about matching a Source
to an input, see Source Concepts and Examples.
A Source
produced by the join
method has a paired JoinDefinition
that contains its definition.
joined
- The Source
whose elements specify the elements of this Source
that appear in the resulting Source
.comparison
- The Source
that has the element or elements that you want to select or remove from joined
or by which you want the elements of the joined
Source
ordered.comparisonRule
- The rule that specifies whether this method selects from joined
only the elements of joined
that are in comparison
or selects only the elements of joined
that are not in comparison
, and whether this method sorts the selected elements in the same order of positions as in comparison
or in the reverse order of those positions. Specify a value for this parameter using one of the Source.COMPARISON_RULE
fields.visible
- A flag that specifies whether you want joined
to be an output of the returned Source
. Specify true
when you want joined
to be an output of the returned Source
or false
when you do not.Source
that specifies the elements of base
as determined by the elements of joined
as compared to the elements of comparison
and selected and ordered as specified by comparisonRule
, and that has or does not have joined
as an output as determined by the value of visible
.public final Source join(Source joined, Source comparison, boolean visible)
Source
that are specified by the elements of joined
that appear in comparison
and that has or does not have joined
as an output, depending on the value of visible
. This method is equivalent to the following code where base
is this Source
.
Source result = base.join(joined, comparison, Source.COMPARISON_RULE_SELECT, visible);
joined
- The Source
whose elements specify the elements of this Source
that appear in the resulting Source
.comparison
- The Source
that has the element or elements that you want to select from joined
.visible
- A flag that specifies whether you want joined
to be an output of the returned Source
. Specify true
when you want joined
to be an output of the returned Source
, or false
when you do not.Source
that has the elements of this Source
as specified by the elements of joined
that appear in comparison
and that has or does not have joined
as an output as determined by the value of visible
.join(Source joined, Source comparison, int comparisonRule, boolean visible)
public final Source join(Source joined, short comparison)
Source
that are specified by the elements of joined
that have a value equal to the comparison
short
and does not add joined
as an output of the resulting Source
. This method is equivalent to the following code where base
is this Source
, dp
is the DataProvider
, and shortValue
is the short
that you want to use to select elements of joined
.
Source result = base.join(joined, dp.createConstantSource(shortValue), Source.COMPARISON_RULE_SELECT, false);
joined
- The Source
whose elements specify the elements of this Source
that appear in the resulting Source
.comparison
- A short
value that you want to use to select the elements of joined
.Source
that has the elements of this Source
that are specified by the elements of joined
that have a value equal to comparison
and that does not have joined
as an output.join(Source joined, Source comparison, int comparisonRule, boolean visible)
public final Source join(Source joined, boolean comparison)
Source
that are determined by the elements of joined
that are true
or false
as specified by the value of the comparison
boolean
and does not add joined
as an output of the resulting Source
.
This method is equivalent to the following code where base
is this Source
, dp
is the DataProvider
, and booleanValue
is the boolean
that you want to use to select elements of joined
.
Source result = base.join(joined, dp.createConstantSource(booleanValue), dp.Source.COMPARISON_RULE_SELECT, false);
joined
- The Source
whose elements specify the elements of this Source
that appear in the resulting Source
.comparison
- The boolean
value that you want to use to select the elements of joined
.Source
that specifies the elements of this Source
as determined by the elements of joined
that are specified by the value of comparison
and that does not have joined
as an output.join(Source joined, Source comparison, int comparisonRule, boolean visible)
public final Source joinHidden(Source joined)
Source
that are specified by the elements of joined
and does not add joined
as an output of the resulting Source
. This method is equivalent to the following code where base
is this Source
and dp
is the DataProvider
.
Source result = base.join(joined, dp.getEmptySource(), Source.COMPARISON_RULE_REMOVE, false);
joined
- The Source
whose elements specify the elements of this Source
that appear in the resulting Source
.Source
that has the elements of this Source
that are specified by the elements of joined
and that has joined
as an output.join(Source joined, Source comparison, int comparisonRule, boolean visible)
public final Source last()
Source
. This method is equivalent to the following code where base
is this Source
.
Source lastBaseElement = base.join(base.position(), base.count(), Source.COMPARISON_RULE_SELECT, false);
Source
that has the last element of this Source
.public final BooleanSource le(Source rhs)
Source
to the corresponding element of another Source
and determines if it has a lesser or equal value. This method produces a BooleanSource
that has an element with the value of true
for each element of this Source
that has a value that is less than or equal to the value of the corresponding element in the specified Source
, and an element with the value of false
for each element of this Source
that does not.rhs
- The Source
whose elements you want to compare to the elements of this Source
.BooleanSource
that has an element with the value of true
for each element of this Source
that has a value that is less than or equal to the value of the corresponding element in the specified Source
, and an element with the value of false
for each element of this Source
that does not.public final BooleanSource lt(Source rhs)
Source
to the corresponding element of another Source
and determines if it has a lesser value. This method produces a BooleanSource
that has an element with the value of true
for each element of this Source
that has a value that is less than the value of the corresponding element in the specified Source
, and an element with the value of false
for each element of this Source
that does not.rhs
- The Source
whose elements you want to compare to the elements of this Source
.BooleanSource
that has an element with the value of true
for each element of this Source
that has a value that is less than the value of the corresponding element in the specified Source
, and an element with the value of false
for each element of this Source
that does not.public final Source movingInterval(int bottom, int top)
Source
, selects the elements of this Source
in the range of positions from the position of the current element plus the bottom
value to the position of the current element plus the top
value. This method is equivalent to the following code where base
is this Source
.
Source result = base.interval(base.position().plus(bottom), base.position().plus(top));
bottom
- The offset from the position of the element of this Source
of the position of the first element in the range of elements that you want to select.top
- The offset from the position of the element of this Source
of the position of the last element in the range of elements that you want to select.Source
that has, for each element of this Source
, the elements of this Source
that are in the range of positions from the current position plus bottom
to the current position plus top
.interval(int bottom, int top)
public final Source movingInterval(NumberSource bottom, NumberSource top)
Source
, selects the elements of this Source
in the range of positions from the position of the current element plus the bottom
value to the position of the current element plus the top
value. This method is equivalent to the following code where base
is this Source
.
Source result = base.interval(base.position().plus(bottom), base.position().plus(top));
bottom
- The offset from the position of the element of this Source
of the position of the first element in the range of elements that you want to select.top
- The offset from the position of the element of this Source
of the position of the last element in the range of elements that you want to select.Source
that has, for each element of this Source
, the elements of this Source
that are in the range of positions from the current position plus bottom
to the current position plus top
.interval(oracle.olapi.data.source.NumberSource bottom, oracle.olapi.data.source.NumberSource top)
public final BooleanSource ne(Source rhs)
Source
to the values of the elements of the specified Source
, and determines if they are not equal. This method produces a BooleanSource
that has an element whose value is true
when the value of a given element of this Source
is not equal to the value of the corresponding element in the specified Source
, or false
when it is equalrhs
- The Source
whose elements you want to compare to the elements of this Source
.BooleanSource
that has an element with the value of true
when the value of a given element of this Source
is not equal to the value of the corresponding element of the specified Source
or false
when it is equal.public final Source offset(int offset)
Source
, selects the element of this Source
that is the specified number of positions away from it. This method is equivalent to the following code where base
is this Source
.
Source result = base.join(base.position(), base.position().plus(offset), Source.COMPARISON_RULE_SELECT, false);For example, assume that this
Source
is named month
and that its element values are the months for the year 2000 with 2000-01 as the value of the first element. When you call this method of the month
object with an offset of 4, the value of first element of the resulting Source
is 2000-05 and the resulting Source
has a type of month
and an input of month
.offset
- The number of positions away (plus or minus) from an element of this Source
that is the position of the element of this Source
that you want to select.Source
whose elements are selected from the elements of this Source
by identifying the position of each element in this Source
and selecting the element whose position is the specified number of places (the offset) away.public final Source offset(NumberSource offset)
Source
, selects the element of this Source
that is the specified number of positions away from it. This method is equivalent to the following code where base
is this Source
.
Source result = base.join(base.position(), base.position().plus(offset), Source.COMPARISON_RULE_SELECT, false);For example, assume that this
Source
is named month
and that its element values are the months for the year 2000 with 2000-01 as the value of the first element. When you call this method of the month
object with an offset of 4, the value of first element of the resulting Source
is 2000-05 and the resulting Source
has a type of month
and an input of month
.offset
- The number of positions away (plus or minus) from an element of this Source
that is the position of the element of this Source
that you want to select.Source
whose elements are selected from the elements of this Source
by identifying the position of each element in this Source
and selecting the element whose position is the specified number of places (the offset) away.public final NumberSource position()
NumberSource
that has an ordinal integer value for the position of each element of this Source
and that has this Source
as a regular input. The NumberSource
returned by this method has a paired PositionDefinition
that contains its definition.NumberSource
that has the positions of the elements of this Source
.public final NumberSource position(boolean zeroBased)
NumberSource
that has an ordinal integer value for the position of each element of this Source
and that has this Source
as a regular input. The position values are zero-based if zeroBased
is true
or one-based if zeroBased
is false
.
The NumberSource
returned by this method has a paired PositionDefinition
that contains its definition.
zeroBased
- A boolean
that specifies whether you want the position values to be zero-based or one-based.NumberSource
that has the positions of the elements of this Source
.public final NumberSource positionOfValue(Source value)
NumberSource
that has the positions of the elements of this Source
that have the value that is specified by value
. This method is equivalent to the following code where base
is this Source
and value
is a Source
that has the value to select.
NumberSource result = base.position() .join(base, value, COMPARISON_RULE_SELECT, false);
value
- A Source
that has the value of the elements of this Source
whose positions you want to know.NumberSource
that has the integer values of the positions of the elements of this Source
that have the value specified by value
. When this Source
does not have any elements that have the specified value, this method returns an empty NumberSource
.public final NumberSource positionOfValues(Source[] values)
NumberSource
that has the positions of the elements of this Source
that have the Source
objects that are specified by values
. This method is equivalent to the following code where base
is this Source
and values
is an array of Source
objects.
NumberSource result = base.position() .join(base, values, COMPARISON_RULE_SELECT, false);
values
- A Source
that has the values of the elements of this Source
whose positions you want to know.NumberSource
that has the positions of the elements of this Source
that have the values specified by values
. When this Source
does not have any elements that have the specified values, this method returns an empty NumberSource
.public final NumberSource positionOfValues(Source values)
NumberSource
that has the positions of the elements of this Source
that have the values that are specified by values
. This method is equivalent to the following code where base
is this Source
and values
is a Source
that has the values to select.
NumberSource result = base.position() .join(base, values, COMPARISON_RULE_SELECT, false);
values
- A Source
that has the values of the elements of this Source
whose positions you want to know.NumberSource
that has the positions of the elements of this Source
that have the values specified by values
. When this Source
does not have any elements that have the specified values, this method returns an empty NumberSource
.public final Source recursiveJoin(Source joined, Source comparison, Source parent, int comparisonRule, boolean parentsFirst, boolean parentsRestrictedToBase, int maxIterations, boolean visible)
Source
and, if comparisonRule
is one of the ascending or descending comparison rules, orders them hierarchically by the parents and their children in the hierarchy that this Source
represents. Use this method only with the Source
for an MdmHierarchy
or on a subtype of such a Source
.
The elements of this Source
are specified by the elements of joined
that are selected by comparison to the elements of comparison
as determined and ordered by comparisonRule
. The parents and ancestors of the elements of this Source
are identified by the parent
parameter.
The join
method returns a Source
that has the elements of this Source
that are specified by the elements of joined
that are, depending on comparisonRule
, in, or not in, comparison
. This method returns a Source
that has the elements of this Source
that are specified by the elements of joined
that are in, or not in, comparison
or that have a parent or ancestor that is in, or not in, comparison
.
The comparisonRule
value determines whether this method specifies the elements of joined
that have values that are in, or not in, comparison
, or whose parent or ancestor is in or not in comparison
, and whether the values of the elements the Source
returned by this method are in ascending or descending order. If you specify one of the ascending or descending comparison rules, such as COMPARISON_RULE_ASCENDING
or COMPARISON_RULE_DESCENDING
, then the children of a parent appear in ascending or descending order. If you specify true
for parentsFirst
, then children appear after their parent. If you specify false
for parentsFirst
, then children appear before their parent.
For a Source
that is a subtype of the hierarchy, the parentsRestrictedToBase
parameter specifies how this method handles the hierarchical ordering of an element of this Source
if the parent of that element is not an element of this Source
. If an element of this Source
is specified by the parameters of this method and the parent of that element is not an element of this Source
and if parentsRestrictedToBase
is true
, then this method uses the element of this Source
that is the closest ancestor of the element as the parent. If parentsRestrictedToBase
is false
, then this method uses the missing parent in ordering the elements of the hierarchy even though the missing parent does not appear in the result.
This method does not add the joined
Source
as an output, so the value of the visible
parameter is always false
.
In the following example, custHier
represents a hierarchy of a dimension of customers values that are ordered by geographical levels. The cities
object is a Source
that specifies the cities level of the hierarchy. The aCountry
object is a Source
that specifies the name of a country that is in the hierarchy. The custParentRel
object is the Source
for the parent relation of the hierarchy (the Source
for the MdmAttribute
returned by the getParentAttribute
method of the MdmLevelHierarchy
that represents the hierarchy of the customers dimension). The comparisonRule
value specifies that the results are returned in ascending order. The parentsFirst
and parentsRestrictedToBase
values are both true
. The maxIterations
value is 5
, although this method currently ignores this parameter. The visible
value is false
, which is currently always the value that this method uses for this parameter.
citiesForCountry = custHier.recursiveJoin(cities, aCountry, custParentRel, Source.COMPARISON_RULE_ASCENDING, true, true, 5, false);The
citiesForCountry
Source
has the cities whose ancestor is the country specified by aCountry
, and the cities are in alphabetical order.joined
- A Source
whose elements specify the elements of this Source
that appear in the resulting Source
.comparison
- A Source
that has the elements that you want to select or remove from joined
, or that has elements with values that specify parents or ancestors of elements that you want to select or remove from joined
.parent
- The Source
, or a subtype of the Source
, for the MdmAttribute
returned by the getParentAttribute
method of the MdmHierarchy
for the hierarchy that this Source
represents, or of which it is a subtype.comparisonRule
- A constant that specifies whether this method selects from joined
only the elements of joined
that are in comparison
, or that have a parent or ancestor that is in comparison
, or selects only the elements of joined
that are not in, or whose parent or ancestor is not in, comparison
, and whether this method sorts the children of a parent in ascending or descending order. Specify a value for this parameter using one of the COMPARISON_RULE
fields.parentsFirst
- A flag that specifies whether parents appear before or after their children in the result when comparisonRule
specifies sorting in ascending or descending order. Specify true
when you want parents to appear before their children or false
when you want parents to appear after their children.parentsRestrictedToBase
- A flag that specifies whether to restrict the parents in the hierarchy to those that are in this Source
. Specify true
when you want to restrict the parents to the elements of this Source
or false
when you do not.maxIterations
- The maximum number of levels of the hierarchy that this method traverses. This method does not currently use this parameter.visible
- Always false
. A recursive join does not add joined
as an output of the result.Source
that has the specified elements of this Source
ordered hierarchically by the parents and their children in the hierarchy that this Source
represents.public final Source recursiveJoin(Source joined, Source comparison, Source parent, int comparisonRule, boolean parentsFirst, boolean parentsRestrictedToBase)
Source
and orders them hierarchically by the parents and their children in the hierarchy that this Source
represents. Use this method only with the Source
for an MdmHierarchy
or on a subtype of such a Source
.
This method is currently the same as recursiveJoin(Source joined, Source comparison, Source parent, int comparisonRule, boolean parentsFirst, boolean parentsRestrictedToBase, int maxIterations, boolean visible)
.
joined
- A Source
whose elements specify the elements of this Source
that appear in the resulting Source
.comparison
- A Source
that has the elements that you want to select or remove from joined
, or that has elements with values that specify parents or ancestors of elements that you want to select or remove from joined
.parent
- The Source
, or a subtype of the Source
, for the MdmAttribute
returned by the getParentAttribute
method of the MdmHierarchy
for the hierarchy that this Source
represents, or of which it is a subtype.comparisonRule
- A constant that specifies whether this method selects from joined
only the elements of joined
that are in comparison
, or that have a parent or ancestor that is in comparison
, or selects only the elements of joined
that are not in, or whose parent or ancestor is not in, comparison
, and whether this method sorts the children of a parent in ascending or descending order. Specify a value for this parameter using one of the COMPARISON_RULE
fields.parentsFirst
- A flag that specifies whether parents appear before or after their children in the result when comparisonRule
specifies sorting in ascending or descending order. Specify true
when you want parents to appear before their children or false
when you want parents to appear after their children.parentsRestrictedToBase
- A flag that specifies whether to restrict the parents in the hierarchy to those that are in this Source
. Specify true
when you want to restrict the parents to the elements of this Source
or false
when you do not.Source
that has the specified elements of this Source
ordered hierarchically by the parents and their children in the hierarchy that this Source
represents.recursiveJoin(Source joined, Source comparison, Source parent, int comparisonRule, boolean parentsFirst, boolean parentsRestrictedToBase, int maxIterations, boolean visible)
public final Source recursiveJoin(Source joined, java.lang.String comparison, Source parent, int comparisonRule, boolean parentsFirst, boolean parentsRestrictedToBase)
Source
and orders them hierarchically by the parents and their children in the hierarchy that this Source
represents. Use this method only with the Source
for an MdmHierarchy
or on a subtype of such a Source
.
This method is the same as recursiveJoin(Source joined, Source comparison, Source parent, int comparisonRule, boolean parentsFirst, boolean parentsRestrictedToBase)
except that the value of comparison
is a String
instead of a Source
.
joined
- A Source
whose elements specify the elements of this Source
that appear in the resulting Source
.comparison
- A String
that specifies the value of the element that you want to select or remove from joined
or that specifies the parent or ancestor of elements that you want to select or remove from joined
.parent
- The Source
, or a subtype of the Source
, for the MdmAttribute
returned by the getParentAttribute
method of the MdmHierarchy
for the hierarchy that this Source
represents, or of which it is a subtype.comparisonRule
- A constant that specifies whether this method selects from joined
only the elements of joined
that are in comparison
, or that have a parent or ancestor that is in comparison
, or selects only the elements of joined
that are not in, or whose parent or ancestor is not in, comparison
, and whether this method sorts the children of a parent in ascending or descending order. Specify a value for this parameter using one of the COMPARISON_RULE
fields.parentsFirst
- A flag that specifies whether parents appear before or after their children in the result when comparisonRule
specifies sorting in ascending or descending order. Specify true
when you want parents to appear before their children or false
when you want parents to appear after their children.parentsRestrictedToBase
- A flag that specifies whether to restrict the parents in the hierarchy to those that are in this Source
. Specify true
when you want to restrict the parents to the elements of this Source
or false
when you do not.Source
that has the specified elements of this Source
ordered hierarchically by the parents and their children in the hierarchy that this Source
represents.recursiveJoin(Source joined, Source comparison, Source parent, int comparisonRule, boolean parentsFirst, boolean parentsRestrictedToBase)
public final Source recursiveJoin(Source joined, java.lang.String[] comparison, Source parent, int comparisonRule, boolean parentsFirst, boolean parentsRestrictedToBase)
Source
and orders them hierarchically by the parents and their children in the hierarchy that this Source
represents. Use this method only with the Source
for an MdmHierarchy
or on a subtype of such a Source
.
This method is the same as recursiveJoin(Source joined, Source comparison, Source parent, int comparisonRule, boolean parentsFirst, boolean parentsRestrictedToBase)
except that the value of comparison
is a String
array instead of a Source
.
joined
- A Source
whose elements specify the elements of this Source
that appear in the resulting Source
.comparison
- A String
array that specifies the values of the elements that you want to select or remove from joined
or that specifies the parents or ancestors of elements that you want to select or remove from joined
.parent
- The Source
, or a subtype of the Source
, for the MdmAttribute
returned by the getParentAttribute
method of the MdmHierarchy
for the hierarchy that this Source
represents, or of which it is a subtype.comparisonRule
- A constant that specifies whether this method selects from joined
only the elements of joined
that are in comparison
, or that have a parent or ancestor that is in comparison
, or selects only the elements of joined
that are not in, or whose parent or ancestor is not in, comparison
, and whether this method sorts the children of a parent in ascending or descending order. Specify a value for this parameter using one of the COMPARISON_RULE
fields.parentsFirst
- A flag that specifies whether parents appear before or after their children in the result when comparisonRule
specifies sorting in ascending or descending order. Specify true
when you want parents to appear before their children or false
when you want parents to appear after their children.parentsRestrictedToBase
- A flag that specifies whether to restrict the parents in the hierarchy to those that are in this Source
. Specify true
when you want to restrict the parents to the elements of this Source
or false
when you do not.Source
that has the specified elements of this Source
ordered hierarchically by the parents and their children in the hierarchy that this Source
represents.recursiveJoin(Source joined, Source comparison, Source parent, int comparisonRule, boolean parentsFirst, boolean parentsRestrictedToBase)
public final Source recursiveJoin(Source joined, Source comparison, Source parent, int comparisonRule)
Source
and orders them hierarchically by the parents and their children in the hierarchy that this Source
represents. Use this method only with the Source
for an MdmHierarchy
or on a subtype of such a Source
.
This method is the same as the recursiveJoin(Source joined, Source comparison, Source parent, int comparisonRule, boolean parentsFirst, boolean parentsRestrictedToBase)
method except that the parentsFirst
, and parentsRestrictedToBase
parameters are set to default values. You can discover the default values by calling methods on the RecursiveJoinDefinition
returned by the getDefinition
method of the Source
returned by this method.
joined
- A Source
whose elements specify the elements of this Source
that appear in the resulting Source
.comparison
- A Source
that has the elements that you want to select or remove from joined
, or that has elements with values that specify parents or ancestors of elements that you want to select or remove from joined
.parent
- The Source
, or a subtype of the Source
, for the MdmAttribute
returned by the getParentAttribute
method of the MdmHierarchy
for the hierarchy that this Source
represents, or of which it is a subtype.comparisonRule
- A constant that specifies whether this method selects from joined
only the elements of joined
that are in comparison
, or that have a parent or ancestor that is in comparison
, or selects only the elements of joined
that are not in, or whose parent or ancestor is not in, comparison
, and whether this method sorts the children of a parent in ascending or descending order. Specify a value for this parameter using one of the COMPARISON_RULE
fields.Source
that has the specified elements of this Source
ordered hierarchically by the parents and their children in the hierarchy that this Source
represents.recursiveJoin(Source joined, Source comparison, Source parent, int comparisonRule, boolean parentsFirst, boolean parentsRestrictedToBase)
public final Source recursiveJoin(Source joined, java.lang.String comparison, Source parent, int comparisonRule)
Source
and orders them hierarchically by the parents and their children in the hierarchy that this Source
represents. Use this method only with the Source
for an MdmHierarchy
or on a subtype of such a Source
.
This method is the same as the recursiveJoin(Source joined, Source comparison, Source parent, int comparisonRule)
method except that comparison
is a String
instead of a Source
.
joined
- A Source
whose elements specify the elements of this Source
that appear in the resulting Source
.comparison
- A String
that specifies the value of the element that you want to select or remove from joined
, or that specifies the parent or ancestor of elements that you want to select or remove from joined
.parent
- The Source
, or a subtype of the Source
, for the MdmAttribute
returned by the getParentAttribute
method of the MdmHierarchy
for the hierarchy that this Source
represents, or of which it is a subtype.comparisonRule
- A constant that specifies whether this method selects from joined
only the elements of joined
that are in comparison
, or that have a parent or ancestor that is in comparison
, or selects only the elements of joined
that are not in, or whose parent or ancestor is not in, comparison
, and whether this method sorts the children of a parent in ascending or descending order. Specify a value for this parameter using one of the COMPARISON_RULE
fields.Source
that has the specified elements of this Source
ordered hierarchically by the parents and their children in the hierarchy that this Source
represents.recursiveJoin(Source joined, Source comparison, Source parent, int comparisonRule)
public final Source recursiveJoin(Source joined, java.lang.String[] comparison, Source parent, int comparisonRule)
Source
and orders them hierarchically by the parents and their children in the hierarchy that this Source
represents. Use this method only with the Source
for an MdmHierarchy
or on a subtype of such a Source
.
This method is the same as the recursiveJoin(Source joined, Source comparison, Source parent, int comparisonRule)
method except that the value of comparison
is a String
array instead of a Source
.
joined
- A Source
whose elements specify the elements of this Source
that appear in the resulting Source
.comparison
- A String
array that specifies the values of the elements that you want to select or remove from joined
, or that specifies the parents or ancestors of elements that you want to select or remove from joined
.parent
- The Source
, or a subtype of the Source
, for the MdmAttribute
returned by the getParentAttribute
method of the MdmHierarchy
for the hierarchy that this Source
represents, or of which it is a subtype.comparisonRule
- A constant that specifies whether this method selects from joined
only the elements of joined
that are in comparison
, or that have a parent or ancestor that is in comparison
, or selects only the elements of joined
that are not in, or whose parent or ancestor is not in, comparison
, and whether this method sorts the children of a parent in ascending or descending order. Specify a value for this parameter using one of the COMPARISON_RULE
fields.Source
that has the specified elements of this Source
ordered hierarchically by the parents and their children in the hierarchy that this Source
represents.recursiveJoin(Source joined, Source comparison, Source parent, int comparisonRule)
public final Source remove(BooleanSource filter)
Source
for which the corresponding element of the specified BooleanSource
has a value of true
. For a base Source
that has String
values, this method is equivalent to the following code where base
is this Source
, dp
is the DataProvider
, and someString
is a String
that is present in base
.
Source filter = ((StringSource) base.value()).like(someString); Source result = base.join(filter, dp.createConstantSource(true), Source.COMPARISON_RULE_REMOVE, false);
filter
- A BooleanSource
whose values are true
for the elements of this Source
that you do not want to have in the returned Source
.Source
that has all of the elements of this Source
for which the value of the elements of filter
is false
.public final Source removeValue(Source value)
Source
that have the specified value. This method is equivalent to the following code where base
is this Source
and dp
is the DataProvider
.
Source result = base.join(base.value(), dp.createConstantSource(value), Source.COMPARISON_RULE_REMOVE, false);
values
- A Source
whose elements have the values that you do not want the resulting Source
to have.Source
that has all of the elements of this Source
except for the elements specified by value
.public final Source removeValues(Source[] values)
Source
that have the specified Source
objects. This method is equivalent to the following code where base
is this Source
and values
is an array of Source
objects.
Source result = base.join(base.value(), values, Source.COMPARISON_RULE_REMOVE, false);
values
- An array of Source
objects that you do not want to have in the resulting Source
.Source
that has all of the elements of this Source
except for the elements specified by values
.public final Source removeValues(Source values)
Source
that have the specified values. This method is equivalent to the following code where base
is this Source
.
Source result = base.join(base.value(), values, Source.COMPARISON_RULE_REMOVE, false);
values
- A Source
whose elements have the values that you do not want to have in the resulting Source
.Source
that has all of the elements of this Source
except for the elements specified by values
.public final Source select(BooleanSource filter)
Source
for which the corresponding element of the specified BooleanSource
has a value of true
. For a base Source
that has String
values, this method is equivalent to the following code where base
is this Source
, dp
is the DataProvider
, and someString
is a String
that is present in base
.
Source filter = ((StringSource) base.value()).like(someString); Source result = base.join(filter, dp.createConstantSource(true), Source.COMPARISON_RULE_SELECT, false);
filter
- A BooleanSource
whose values are true
for the elements of this Source
that you want to have in the returned Source
.Source
that has all of the elements of this Source
for which the value of the elements of filter
is true
.public final Source selectDescendants(Source comparison, Source parent)
Source
that are specified by comparison
and the descendants of those elements in the hierarchy that this Source
represents. Use this method only with the Source
for an MdmHierarchy
or on a subtype of such a Source
.
The Source
returned by this method has an associated RecursiveJoinDefinition
that contains information about the Source
.
comparison
- A Source
that has the element or elements that you want to select from this Source
.parent
- The Source
, or a subtype of the Source
, for the MdmAttribute
returned by the getParentAttribute
method of the MdmHierarchy
for the hierarchy that this Source
represents, or of which it is a subtype.Source
that has the specified elements of this Source
ordered hierarchically by the parents and their children in the hierarchy that this Source
represents.public final Source selectValue(Source value)
Source
that have the specified value. This method is equivalent to the following code where base
is this Source
and dp
is the DataProvider
.
Source result = base.join(base.value(), dp.createConstantSource(value), Source.COMPARISON_RULE_SELECT, false);
value
- A Source
that has the element of this Source
that you want to have in the returned Source
.Source
that has the elements of this Source
that have the specified value.public final Source selectValues(Source[] values)
Source
that have the specified values. This method is equivalent to the following code where base
is this Source
.
Source result = base.join(base.value(), values, Source.COMPARISON_RULE_SELECT, false);
values
- An array of Source
objects that you want to have as the values of the elements of the returned Source
.Source
that has all of the elements of this Source
that have the specified values.public final Source selectValues(Source values)
Source
that have the specified values. This method is equivalent to the following code where base
is this Source
.
Source result = base.join(base.value(), values, Source.COMPARISON_RULE_SELECT, false);
values
- A Source
that has elements of this Source
that you want to have in the returned Source
.Source
that has the elements of this Source
that have the specified values.public final Source sortAscending()
Source
in the ascending order of their data type. This method is equivalent to the following code where base
is this Source
.
Source result = base.join(base.value(), base.getDataType(), Source.COMPARISON_RULE_ASCENDING, false);
Source
that has the elements of this Source
sorted in ascending order by value.public final Source sortAscending(Source sortValue)
Source
that are specified by the elements of sortValue
, and orders them in the ascending order of the sortValue
data type. This method is equivalent to the following code where base
is this Source
.
Source result = base.join(sortValue, sortValue.getDataType(), Source.COMPARISON_RULE_ASCENDING, false);
sortValue
- A Source
whose elements, sorted in ascending order by value, you want to use to select the elements of this Source
.Source
that has the elements of this Source
that are selected by the sorted elements of the specified Source
.public final Source sortAscending(Source sortValue, boolean nullsFirst)
Source
that are specified by the elements of sortValue
, and orders them in the ascending order of the sortValue
data type. If the value of the specified boolean
is true
, then elements that have a null
value appear first. If the value of the boolean
is false
, then elements that have a null
value appear last. This method is equivalent to one of the following, where base
is this Source
.
Source result = base.join(sortValue, sortValue.getDataType(), Source.COMPARISON_RULE_ASCENDING_NULLS_FIRST, false);
Source result = base.join(sortValue, sortValue.getDataType(), Source.COMPARISON_RULE_ASCENDING_NULLS_LAST, false);
sortValue
- A Source
whose elements, sorted in ascending order by value, you want to use to select the elements of this Source
.nullsFirst
- A boolean
that specifies whether elements with a null
value appear first or last.Source
that has the elements of this Source
that are selected by the sorted elements of the specified Source
with the position of null
values as specified by nullsFirst.public final Source sortAscendingHierarchically(Source joined, Source parent, boolean parentsFirst, boolean parentsRestrictedToBase)
Source
that are specified by joined
and the descendants of those elements in the hierarchy that this Source
represents and sorts the children of the parents in ascending order. Use this method only with the Source
for an MdmHierarchy
or on a subtype of such a Source
.
The Source
returned by this method has an associated RecursiveJoinDefinition
that contains information about the Source
.
joined
- A Source
whose elements specify the elements of this Source
that appear in the resulting Source
.parent
- The Source
, or a subtype of the Source
, for the MdmAttribute
returned by the getParentAttribute
method of the MdmHierarchy
for the hierarchy that this Source
represents, or of which it is a subtype.parentsFirst
- A flag that specifies whether parents appear before or after their children in the result. Specify true
when you want parents to appear before their children or false
when you want parents to appear after their children.parentsRestrictedToBase
- A flag that specifies whether to restrict the parents in the hierarchy to those that are in this Source
. Specify true
when you want to restrict the parents to the elements of this Source
or false
when you do not.Source
that has the specified elements of this Source
ordered hierarchically by the parents and their children in the hierarchy that this Source
represents and with the children in ascending order.public final Source sortAscendingHierarchically(Source joined, Source parent)
Source
that are specified by joined
and the descendants of those elements in the hierarchy that this Source
represents and sorts the children of the parents in ascending order with the parents appearing before their children. The parents are restricted to the elements of this Source
. Use this method only with the Source
for an MdmHierarchy
or on a subtype of such a Source
.
The Source
returned by this method has an associated RecursiveJoinDefinition
that contains information about the Source
.
joined
- A Source
whose elements specify the elements of this Source
that appear in the resulting Source
.parent
- The Source
, or a subtype of the Source
, for the MdmAttribute
returned by the getParentAttribute
method of the MdmHierarchy
for the hierarchy that this Source
represents, or of which it is a subtype.Source
that has the specified elements of this Source
ordered hierarchically by the parents and their children in the hierarchy that this Source
represents and with the children in ascending order.sortAscendingHierarchically(Source joined, Source parent, boolean parentsFirst, boolean parentsRestrictedToBase)
public final Source sortAscendingHierarchically(Source parent, boolean parentsFirst)
Source
and the descendants of those elements in the hierarchy that this Source
represents and sorts the children of the parents in ascending order. The parents are restricted to the elements of this Source
. Use this method only with the Source
for an MdmHierarchy
or on a subtype of such a Source
.
The Source
returned by this method has an associated RecursiveJoinDefinition
that contains information about the Source
.
parent
- The Source
, or a subtype of the Source
, for the MdmAttribute
returned by the getParentAttribute
method of the MdmHierarchy
for the hierarchy that this Source
represents, or of which it is a subtype.parentsFirst
- A flag that specifies whether parents appear before or after their children in the result. Specify true
when you want parents to appear before their children or false
when you want parents to appear after their children.Source
that has the specified elements of this Source
ordered hierarchically by the parents and their children in the hierarchy that this Source
represents and with the children in ascending order.sortAscendingHierarchically(Source joined, Source parent, boolean parentsFirst, boolean parentsRestrictedToBase)
public final Source sortAscendingHierarchically(Source parent)
Source
and the descendants of those elements in the hierarchy that this Source
represents and sorts the children of the parents in ascending order with the parents appearing before the children in the result. The parents are restricted to the elements of this Source
. Use this method only with the Source
for an MdmHierarchy
or on a subtype of such a Source
.
The Source
returned by this method has an associated RecursiveJoinDefinition
that contains information about the Source
.
parent
- The Source
, or a subtype of the Source
, for the MdmAttribute
returned by the getParentAttribute
method of the MdmHierarchy
for the hierarchy that this Source
represents, or of which it is a subtype.Source
that has the specified elements of this Source
ordered hierarchically by the parents and their children in the hierarchy that this Source
represents and with the children in ascending order.sortAscendingHierarchically(Source joined, Source parent, boolean parentsFirst, boolean parentsRestrictedToBase)
public final Source sortDescending()
Source
in the descending order of their values. This method is equivalent to the following code where base
is this Source
.
Source result = base.join(base.value(), base.getDataType(), Source.COMPARISON_RULE_DESCENDING, false);
Source
that has the elements of this Source
sorted in descending order by value.public final Source sortDescending(Source sortValue)
Source
that are specified by the elements of sortValue
, and orders them in the descending order of the sortValue
data type. This method is equivalent to the following code where base
is this Source
.
Source result = base.join(sortValue, sortValue.getDataType(), Source.COMPARISON_RULE_DESCENDING, false);
sortValue
- A Source
whose elements, sorted in descending order by value, you want to use to select the elements of this Source
.Source
that has the elements of this Source
that are selected by the sorted elements of the specified Source
.public final Source sortDescending(Source sortValue, boolean nullsFirst)
Source
that are specified by the elements of sortValue
, and orders them in the descending order of the sortValue
data type. If the value of the specified boolean
is true
, then elements that have a null
value appear first. If the value of the boolean
is false
, then elements that have a null
value appear last. This method is equivalent to one of the following, where base
is this Source
.
Source result = base.join(sortValue, sortValue.getDataType(), Source.COMPARISON_RULE_DESCENDING_NULLS_FIRST, false);
Source result = base.join(sortValue, sortValue.getDataType(), Source.COMPARISON_RULE_DESCENDING_NULLS_LAST, false);
sortValue
- A Source
whose elements, sorted in ascending order by value, you want to use to select the elements of this Source
.nullsFirst
- A boolean
that specifies whether elements with a null
value appear first or last.Source
that has the elements of this Source
that are selected by the sorted elements of the specified Source
with the position of null
values as specified by nullsFirst.public final Source sortDescendingHierarchically(Source joined, Source parent, boolean parentsFirst, boolean parentsRestrictedToBase)
Source
that are specified by joined
and the descendants of those elements in the hierarchy that this Source
represents and sorts the children of the parents in descending order. Use this method only with the Source
for an MdmHierarchy
or on a subtype of such a Source
.
The Source
returned by this method has an associated RecursiveJoinDefinition
that contains information about the Source
.
joined
- A Source
whose elements specify the elements of this Source
that appear in the resulting Source
.parent
- The Source
, or a subtype of the Source
, for the MdmAttribute
returned by the getParentAttribute
method of the MdmHierarchy
for the hierarchy that this Source
represents, or of which it is a subtype.parentsFirst
- A flag that specifies whether parents appear before or after their children in the result. Specify true
when you want parents to appear before their children or false
when you want parents to appear after their children.parentsRestrictedToBase
- A flag that specifies whether to restrict the parents in the hierarchy to those that are in this Source
. Specify true
when you want to restrict the parents to the elements of this Source
or false
when you do not.Source
that has the specified elements of this Source
ordered hierarchically by the parents and their children in the hierarchy that this Source
represents and with the children in descending order.recursiveJoin(Source joined, Source comparison, Source parent, int comparisonRule, boolean parentsFirst, boolean parentsRestrictedToBase)
public final Source sortDescendingHierarchically(Source joined, Source parent)
Source
that are specified by joined
and the descendants of those elements in the hierarchy that this Source
represents and sorts the children of the parents in descending order with the parents appearing before their children. The parents are restricted to the elements of this Source
. Use this method only with the Source
for an MdmHierarchy
or on a subtype of such a Source
.
The Source
returned by this method has an associated RecursiveJoinDefinition
that contains information about the Source
.
joined
- A Source
whose elements specify the elements of this Source
that appear in the resulting Source
.parent
- The Source
, or a subtype of the Source
, for the MdmAttribute
returned by the getParentAttribute
method of the MdmHierarchy
for the hierarchy that this Source
represents, or of which it is a subtype.Source
that has the specified elements of this Source
ordered hierarchically by the parents and their children in the hierarchy that this Source
represents and with the children in descending order.sortDescendingHierarchically(Source joined, Source parent, boolean parentsFirst, boolean parentsRestrictedToBase)
public final Source sortDescendingHierarchically(Source parent, boolean parentsFirst)
Source
and the descendants of those elements in the hierarchy that this Source
represents and sorts the children of the parents in descending order. The parents are restricted to the elements of this Source
. Use this method only with the Source
for an MdmHierarchy
or on a subtype of such a Source
.
The Source
returned by this method has an associated RecursiveJoinDefinition
that contains information about the Source
.
parent
- The Source
, or a subtype of the Source
, for the MdmAttribute
returned by the getParentAttribute
method of the MdmHierarchy
for the hierarchy that this Source
represents, or of which it is a subtype.parentsFirst
- A flag that specifies whether parents appear before or after their children in the result. Specify true
when you want parents to appear before their children or false
when you want parents to appear after their children.Source
that has the specified elements of this Source
ordered hierarchically by the parents and their children in the hierarchy that this Source
represents and with the children in descending order.sortDescendingHierarchically(Source joined, Source parent, boolean parentsFirst, boolean parentsRestrictedToBase)
public final Source sortDescendingHierarchically(Source parent)
Source
and the descendants of those elements in the hierarchy that this Source
represents and sorts the children of the parents in descending order with the parents appearing before the children in the result. The parents are restricted to the elements of this Source
. Use this method only with the Source
for an MdmHierarchy
or on a subtype of such a Source
.
The Source
returned by this method has an associated RecursiveJoinDefinition
that contains information about the Source
.
parent
- The Source
, or a subtype of the Source
, for the MdmAttribute
returned by the getParentAttribute
method of the MdmHierarchy
for the hierarchy that this Source
represents, or of which it is a subtype.Source
that has the specified elements of this Source
ordered hierarchically by the parents and their children in the hierarchy that this Source
represents and with the children in descending order.sortDescendingHierarchically(Source joined, Source parent, boolean parentsFirst, boolean parentsRestrictedToBase)
public final NumberSource toDoubleSource()
Source
to the Java double
data type.Source
that has the same elements as this Source
, but whose type is the fundamental Double Source
.public final NumberSource toFloatSource()
Source
to the Java float
data type.Source
that has the same elements as this Source
, but whose type Float Source
.public final NumberSource toIntegerSource()
Source
to the Java int
data type.Source
that has the same elements as this Source
, but whose type is the fundamental Integer Source
.public final NumberSource toShortSource()
Source
to the Java short
data type.Source
that has the same elements as this Source
, but whose type is the fundamental Short Source
.public StringSource toStringSource()
Source
to Java String
objects.Source
that has the same elements as this Source
, but whose type is the fundamental String Source
.public final Source value()
Source
that has the elements of this Source
and that has this Source
as an input. Use this method when you want to produce a Source
that has a subset of the elements of the Source
on which you call it. For examples, see the selectValues
and removeValues
methods.
Each Source
produced by this method has a paired ValueDefinition
that contains its definition.
Source
that has the elements of this Source
and that has this Source
as an input.public final Source value(Source input)
Source
that has the same elements as this Source
and that has the specified Source
as an input.
A Source
produced by this method has a paired ValueDefinition
that contains its definition.
input
- The Source
that you want as an input to the returned Source
.Source
that has the same elements as this Source
and that has the specified Source
as an input.
|
Oracle OLAP Java API Reference 10g Release 1 (10.1) B10994-01 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |