oracle.olapi.data.source
Class BooleanSource

java.lang.Object
  |
  +--oracle.olapi.data.source.Source
        |
        +--oracle.olapi.data.source.BooleanSource

public final class BooleanSource

extends Source

A Source whose elements have boolean values. A BooleanSource object has an OLAP API data type of Boolean. This class implements some Source methods so that they use boolean values, such as appendValue and eq, and implements other boolean operations such as the and, or, and forAny methods.

Fields inherited from class oracle.olapi.data.source.Source

COMPARISON_RULE_ASCENDING, COMPARISON_RULE_ASCENDING_NULLS_FIRST, COMPARISON_RULE_ASCENDING_NULLS_LAST, COMPARISON_RULE_DESCENDING, COMPARISON_RULE_DESCENDING_NULLS_FIRST, COMPARISON_RULE_DESCENDING_NULLS_LAST, COMPARISON_RULE_REMOVE, COMPARISON_RULE_SELECT

Method Summary

BooleanSource	and(boolean rhs) Performs a logical AND operation between the values of the elements of this BooleanSource and the specified boolean value.
BooleanSource	and(BooleanSource rhs) Performs a logical AND operation between the values of the elements of this BooleanSource and the values of the corresponding elements of the specified BooleanSource.
BooleanSource	appendValue(boolean appendValue) Appends an element with the specified boolean value to this BooleanSource.
BooleanSource	appendValues(boolean[] appendValues) Appends elements with the specified boolean values to this BooleanSource.
BooleanSource	eq(boolean rhs) Compares the value of each element of this BooleanSource to the specified boolean value and determines if the values are equal.
BooleanSource	forAll() Indicates whether the values of all of the elements of this BooleanSource are true.
BooleanSource	forAll(boolean noValueAsFalse) Indicates whether the values of all of the elements of this BooleanSource are true.
BooleanSource	forAny() Indicates whether the value of any of the elements of this BooleanSource is true.
BooleanSource	forAny(boolean noValueAsFalse) Indicates whether the value of any of the elements of this BooleanSource is true.
BooleanSource	forNone() Indicates whether the value of none of the elements of this BooleanSource is true.
BooleanSource	forNone(boolean noValueAsFalse) Indicates whether the value of none of the elements of this BooleanSource is true.
BooleanSource	ge(boolean rhs) Compares the value of each element of this BooleanSource to the specified boolean value, and determines whether it is a greater or equal value.
Source	getDataType() Gets the fundamental Source that represents the OLAP API data type of this BooleanSource, which is Boolean.
BooleanSource	gt(boolean rhs) Compares the value of each element of this BooleanSource to the specified boolean value, and determines whether it is a greater value.
DateSource	implies(java.util.Date ifTrue, java.util.Date ifFalse) Produces a DateSource that has an element with the value of ifTrue for each element of this BooleanSource that has a value of true and an element with the value of ifFalse for each element of this BooleanSource that has a value of false.
DateSource	implies(DateSource ifTrue, DateSource ifFalse) Produces a DateSource that has an element with the value of ifTrue for each element of this BooleanSource that has a value of true and an element with the value of ifFalse for each element of this BooleanSource that has a value of false.
NumberSource	implies(double ifTrue, double ifFalse) Produces a NumberSource that has an element with the value of ifTrue for each element of this BooleanSource that has a value of true and an element with the value of ifFalse for each element of this BooleanSource that has a value of false.
NumberSource	implies(int ifTrue, int ifFalse) Produces a NumberSource that has an element with the value of ifTrue for each element of this BooleanSource that has a value of true and an element with the value of ifFalse for each element of this BooleanSource that has a value of false.
NumberSource	implies(NumberSource ifTrue, NumberSource ifFalse) Produces a NumberSource that has an element with the value of ifTrue for each element of this BooleanSource that has a value of true and an element with the value of ifFalse for each element of this BooleanSource that has a value of false.
StringSource	implies(StringSource ifTrue, StringSource ifFalse) Produces a StringSource that has an element with the value of ifTrue for each element of this BooleanSource that has a value of true and an element with the value of ifFalse for each element of this BooleanSource that has a value of false.
StringSource	implies(java.lang.String ifTrue, java.lang.String ifFalse) Produces a StringSource that has an element with the value of ifTrue for each element of this BooleanSource that has a value of true and an element with the value of ifFalse for each element of this BooleanSource that has a value of false.
BooleanSource	le(boolean rhs) Compares the value of each element of this BooleanSource to the specified boolean value, and determines whether it is a lesser or equal value.
BooleanSource	lt(boolean rhs) Compares the value of each element of this BooleanSource to the specified boolean value, and determines whether it is a lesser value.
BooleanSource	ne(boolean rhs) Compares the value of each element of this BooleanSource to the specified boolean value, and determines whether it is not equal to the value.
BooleanSource	not() Performs a logical NOT operation on the values of the elements of this BooleanSource, which negates the values so that if an element of this BooleanSource has a value of true, then the corresponding element of the resulting BooleanSource has a value of false.
BooleanSource	or(boolean rhs) Performs a logical OR operation between the values of the elements of this BooleanSource and the specified boolean value.
BooleanSource	or(BooleanSource rhs) Performs a logical OR operation between the values of the elements of this BooleanSource and the values of the corresponding elements of the specified BooleanSource.
NumberSource	positionOfValue(boolean value) Identifies the positions of elements in this BooleanSource that have the specified boolean value.
NumberSource	positionOfValues(boolean[] values) Identifies the positions of elements in this BooleanSource that have the specified boolean values.
BooleanSource	removeValue(boolean value) Removes the elements of this BooleanSource that have the specified boolean value.
BooleanSource	removeValues(boolean[] values) Removes the elements of this BooleanSource that have the specified boolean values.
BooleanSource	selectValue(boolean value) Selects the elements of this BooleanSource that have the specified boolean value.
BooleanSource	selectValues(boolean[] values) Selects the elements of this BooleanSource that have the specified boolean values.

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

alias, appendValue, appendValues, appendValues, at, at, count, count, cumulativeInterval, cumulativeInterval, cumulativeInterval, distinct, eq, extract, findMatchFor, first, ge, getDataProvider, getDefinition, getExtractionInputs, getID, getInputs, getMetadataProvider, getMetadataProviderID, getModel, getOutputs, getRegularInputs, getType, gt, hasValue, in, interval, interval, isSubtypeOf, join, join, join, join, join, join, join, join, join, join, join, join, join, join, join, join, join, join, join, joinHidden, last, le, lt, movingInterval, movingInterval, ne, nullSource, offset, offset, position, position, positionOfValue, positionOfValues, positionOfValues, recursiveJoin, recursiveJoin, recursiveJoin, recursiveJoin, recursiveJoin, recursiveJoin, recursiveJoin, remove, removeValue, removeValues, removeValues, select, selectDescendants, selectValue, selectValues, selectValues, sortAscending, sortAscending, sortAscending, sortAscendingHierarchically, sortAscendingHierarchically, sortAscendingHierarchically, sortAscendingHierarchically, sortDescending, sortDescending, sortDescending, sortDescendingHierarchically, sortDescendingHierarchically, sortDescendingHierarchically, sortDescendingHierarchically, toDoubleSource, toFloatSource, toIntegerSource, toShortSource, toStringSource, value, value

Methods inherited from class java.lang.Object

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

Method Detail

and

public final BooleanSource and(BooleanSource rhs)

Performs a logical AND operation between the values of the elements of this BooleanSource and the values of the corresponding elements of the specified BooleanSource.

Parameters:

rhs - The BooleanSource whose elements you want to logically AND with the elements of this BooleanSource.

Returns:

A BooleanSource that has the results of the logical AND operations between the values of the elements of this BooleanSource and the values of the corresponding elements of the specified BooleanSource.

and

public final BooleanSource and(boolean rhs)

Performs a logical AND operation between the values of the elements of this BooleanSource and the specified boolean value.

Parameters:

rhs - The boolean value that you want to logically AND with the values of the elements of this BooleanSource.

Returns:

A BooleanSource that has the results of the logical AND operations between the values of the element of this BooleanSource and the specified boolean value.

appendValue

public final BooleanSource appendValue(boolean appendValue)

Appends an element with the specified boolean value to this BooleanSource. The outputs of this BooleanSource, if any, do not appear in the resulting BooleanSource.

Parameters:

appendValue - The boolean value that you want to append to this BooleanSource.

Returns:

A BooleanSource that has the same elements as this BooleanSource and that has an additional appended element that has the specified boolean value.

See Also:

Source.appendValue(Source appendValue)

appendValues

public final BooleanSource appendValues(boolean[] appendValues)

Appends elements with the specified boolean values to this BooleanSource. The outputs of this BooleanSource, if any, do not appear in the resulting BooleanSource.

Parameters:

appendValues - An array of boolean values that you want to append to this BooleanSource.

Returns:

A BooleanSource that has the same elements as this BooleanSource and that has additional appended elements that have the specified boolean values.

See Also:

Source.appendValues(Source appendValues)

eq

public final BooleanSource eq(boolean rhs)

Compares the value of each element of this BooleanSource to the specified boolean value and determines if the values are equal.

Parameters:

rhs - The boolean value that you want to compare to the values of the elements of this BooleanSource.

Returns:

A BooleanSource that has an element that has a value of true when the value of the corresponding element of this BooleanSource equals the specified boolean value or false when it does not.

See Also:

Source.eq(Source rhs)

forAll

public final BooleanSource forAll()

Indicates whether the values of all of the elements of this BooleanSource are true. This method ignores elements that do not have a value.

For a BooleanSource with no outputs, this method returns a BooleanSource that has an element whose value is true when all of the elements of this BooleanSource have a value of true, or false when they do not. For a BooleanSource with outputs, this method returns a BooleanSource that has an element whose value is true when the value of an element and the values of all of its corresponding output elements are true, or false when they are not.

Returns:

A BooleanSource that has an element whose value is true when the values of all of the elements, or an element and all of the corresponding elements of its outputs, is true, or false when they are not.

See Also:

forAll(boolean noValueAsFalse)

forAll

public final BooleanSource forAll(boolean noValueAsFalse)

Indicates whether the values of all of the elements of this BooleanSource are true. If noValueAsFalse is true, this method uses a value of false for elements that do not have a value. If noValueAsFalse is false, this method ignores elements that do not have a value.

For a BooleanSource with no outputs, this method returns a BooleanSource that has an element whose value is true when all of the elements of this BooleanSource have a value of true, or false when they do not. For a BooleanSource with outputs, this method returns a BooleanSource that has an element whose value is true when the value of an element and the values of all of its corresponding output elements are true, or false when they are not.

Parameters:

noValueAsFalse - Specify true when you want this method to use a value of false for elements that do not have a value.

Returns:

A BooleanSource that has an element whose value is true when the values of all of the elements, or an element and all of the corresponding elements of its outputs, is true, or false when they are not.

See Also:

forAll()

forAny

public final BooleanSource forAny()

Indicates whether the value of any of the elements of this BooleanSource is true. This method ignores elements that do not have a value.

For a BooleanSource with no outputs, this method returns a BooleanSource that has an element whose value is true when any of the elements of this BooleanSource have a value of true, or false when none does. For a BooleanSource with outputs, this method returns a BooleanSource that has an element whose value is true when the value of an element or the value of any of its corresponding output elements is true, or false when none is.

Returns:

A BooleanSource that has an element whose value is true when the value of any of the elements, or any of the corresponding elements of its outputs, is true, or false when none is.

See Also:

forAny(boolean noValueAsFalse)

forAny

public final BooleanSource forAny(boolean noValueAsFalse)

Indicates whether the value of any of the elements of this BooleanSource is true. If noValueAsFalse is true, this method uses a value of false for elements that do not have a value. If noValueAsFalse is false, this method ignores elements that do not have a value.

For a BooleanSource with no outputs, this method returns a BooleanSource that has an element whose value is true when any of the elements of this BooleanSource have a value of true, or false when none does. For a BooleanSource with outputs, this method returns a BooleanSource that has an element whose value is true when the value of any element or the value of any of its corresponding output elements is true, or false when none is.

Parameters:

noValueAsFalse - Specify true when you want this method to use a value of false for elements that do not have a value.

Returns:

A BooleanSource that has an element whose value is true when the value of any of the elements of this BooleanSource, or any of the corresponding elements of its outputs, is true, or false when none is.

See Also:

forAny()

forNone

public final BooleanSource forNone()

Indicates whether the value of none of the elements of this BooleanSource is true. This method ignores elements that do not have any values.

For a BooleanSource with no outputs, this method returns a BooleanSource that has an element whose value is true when none of the elements of this BooleanSource have a value of true, or false when any does. For a BooleanSource with outputs, this method returns a BooleanSource that has an element whose value is true when no value of an element or any of its corresponding output elements is true, or false when any is.

Returns:

A BooleanSource that has an element whose value is true when no value of any of the elements of this BooleanSource, or any of the corresponding elements of its outputs, is true, or false when any is.

See Also:

forNone(boolean noValueAsFalse)

forNone

public final BooleanSource forNone(boolean noValueAsFalse)

Indicates whether the value of none of the elements of this BooleanSource is true. If noValueAsFalse is true, this method uses a value of false for elements that do not have a value. If noValueAsFalse is false, this method ignores elements that do not have a value.

For a BooleanSource with no outputs, this method returns a BooleanSource that has an element whose value is true when none of the elements of this BooleanSource have a value of true, or false when any does. For a BooleanSource with outputs, this method returns a BooleanSource that has an element whose value is true when no value of an element or any of its corresponding output elements is true, or false when any is.

Parameters:

noValueAsFalse - Specify true when you want this method to use a value of false for elements that do not have a value.

Returns:

A BooleanSource that has an element whose value is true when no value of any of the elements of this BooleanSource, or any of the corresponding elements of its outputs, is true, or false when any is.

See Also:

forNone()

ge

public final BooleanSource ge(boolean rhs)

Compares the value of each element of this BooleanSource to the specified boolean value, and determines whether it is a greater or equal value.

Parameters:

rhs - The boolean value that you want to compare to the values of the elements of this BooleanSource.

Returns:

A BooleanSource that has an element with a value of true when the value of the corresponding element of this BooleanSource is greater than or equal to the specified boolean value, or false when it is not.

See Also:

Source.ge(Source rhs)

getDataType

public Source getDataType()

Gets the fundamental Source that represents the OLAP API data type of this BooleanSource, which is Boolean.

Overrides:

getDataType in class Source

Returns:

The fundamental Source that represents the OLAP API Boolean data type.

gt

public final BooleanSource gt(boolean rhs)

Compares the value of each element of this BooleanSource to the specified boolean value, and determines whether it is a greater value.

Parameters:

rhs - The boolean value that you want to compare to the values of the elements of this BooleanSource.

Returns:

A BooleanSource that has an element with a value of true when the value of the corresponding element of this BooleanSource is greater than the specified boolean value, or false when it is not.

See Also:

Source.gt(Source rhs)

implies

public final NumberSource implies(double ifTrue,
                                  double ifFalse)

Produces a NumberSource that has an element with the value of ifTrue for each element of this BooleanSource that has a value of true and an element with the value of ifFalse for each element of this BooleanSource that has a value of false.

Parameters:

ifTrue - The double value that you want the elements of the resulting NumberSource to have for the elements of this BooleanSource that have a value of true.

ifFalse - The double value that you want the elements of the resulting NumberSource to have for the elements of this BooleanSource that have a value of false.

Returns:

A NumberSource that has the value of ifTrue when the corresponding value of this BooleanSource is true, or the value of ifFalse when the corresponding value of this BooleanSource is false.

implies

public final NumberSource implies(int ifTrue,
                                  int ifFalse)

Produces a NumberSource that has an element with the value of ifTrue for each element of this BooleanSource that has a value of true and an element with the value of ifFalse for each element of this BooleanSource that has a value of false.

Parameters:

ifTrue - The int value that you want the elements of the resulting NumberSource to have for the elements of this BooleanSource that have a value of true.

ifFalse - The int value that you want the elements of int value that you want the elements of the resulting NumberSource to have for the elements of this BooleanSource that have a value of false.

Returns:

A NumberSource that has the value of ifTrue when the corresponding value of this BooleanSource is true, or the value of ifFalse when the corresponding value of this BooleanSource is false.

implies

public final StringSource implies(java.lang.String ifTrue,
                                  java.lang.String ifFalse)

Produces a StringSource that has an element with the value of ifTrue for each element of this BooleanSource that has a value of true and an element with the value of ifFalse for each element of this BooleanSource that has a value of false.

Parameters:

ifTrue - The String value that you want the elements of the resulting StringSource to have for the elements of this BooleanSource that have a value of true.

ifFalse - The String value that you want the elements of the resulting StringSource to have for the elements of this BooleanSource that have a value of false.

Returns:

A StringSource that has the value of ifTrue when the corresponding value of this BooleanSource is true, or the value of ifFalse when the corresponding value of this BooleanSource is false.

implies

public final DateSource implies(java.util.Date ifTrue,
                                java.util.Date ifFalse)

Produces a DateSource that has an element with the value of ifTrue for each element of this BooleanSource that has a value of true and an element with the value of ifFalse for each element of this BooleanSource that has a value of false.

Parameters:

ifTrue - The Date value that you want the elements of the resulting DateSource to have for the elements of this BooleanSource that have a value of true.

ifFalse - The Date value that you want the elements of the resulting DateSource to have for the elements of this BooleanSource that have a value of false.

Returns:

A DateSource that has the value of ifTrue when the corresponding value of this BooleanSource is true, or the value of ifFalse when the corresponding value of this BooleanSource is false.

implies

public final DateSource implies(DateSource ifTrue,
                                DateSource ifFalse)

Produces a DateSource that has an element with the value of ifTrue for each element of this BooleanSource that has a value of true and an element with the value of ifFalse for each element of this BooleanSource that has a value of false.

Parameters:

ifTrue - A DateSource that has the Date value that you want the elements of the resulting DateSource to have for the elements of this BooleanSource that have a value of true.

ifFalse - A DateSource that has the Date value that you want the elements of the resulting DateSource to have for the elements of this BooleanSource that have a value of false.

Returns:

A DateSource that has the value of the element of ifTrue when the corresponding value of this BooleanSource is true, or the value of the element of ifFalse when the corresponding value of this BooleanSource is false.

implies

public final NumberSource implies(NumberSource ifTrue,
                                  NumberSource ifFalse)

Produces a NumberSource that has an element with the value of ifTrue for each element of this BooleanSource that has a value of true and an element with the value of ifFalse for each element of this BooleanSource that has a value of false.

Parameters:

ifTrue - A NumberSource that has the value that you want the elements of the resulting NumberSource to have for the elements of this BooleanSource that have a value of true.

ifFalse - A NumberSource that has the value that you want the elements of the resulting NumberSource to have for the elements of this BooleanSource that have a value of false.

Returns:

A NumberSource that has the value of the element of ifTrue when the corresponding value of this BooleanSource is true, or the value of the element of ifFalse when the corresponding value of this BooleanSource is false.

implies

public final StringSource implies(StringSource ifTrue,
                                  StringSource ifFalse)

Produces a StringSource that has an element with the value of ifTrue for each element of this BooleanSource that has a value of true and an element with the value of ifFalse for each element of this BooleanSource that has a value of false.

Parameters:

ifTrue - A StringSource that has the value that you want the elements of the resulting StringSource to have for the elements of this BooleanSource that have a value of true.

ifFalse - A StringSource that has the value that you want the elements of the resulting StringSource to have for the elements of this BooleanSource that have a value of false.

Returns:

A StringSource that has the value of the element of ifTrue when the corresponding value of this BooleanSource is true, or the value of the element of ifFalse when the corresponding value of this BooleanSource is false.

le

public final BooleanSource le(boolean rhs)

Compares the value of each element of this BooleanSource to the specified boolean value, and determines whether it is a lesser or equal value.

Parameters:

rhs - The boolean value that you want to compare to the values of the elements of this BooleanSource.

Returns:

A BooleanSource that has an element with a value of true when the value of a given element of this BooleanSource is less than or equal to the specified boolean value, or false when it is not.

See Also:

Source.le(Source rhs)

lt

public final BooleanSource lt(boolean rhs)

Compares the value of each element of this BooleanSource to the specified boolean value, and determines whether it is a lesser value.

Parameters:

rhs - The boolean value that you want to compare to the values of the elements of this BooleanSource.

Returns:

A BooleanSource that has an element with a value of true when the value of the corresponding element of this BooleanSource is less than the specified boolean value, or false when it is not.

See Also:

Source.lt(Source rhs)

ne

public final BooleanSource ne(boolean rhs)

Compares the value of each element of this BooleanSource to the specified boolean value, and determines whether it is not equal to the value.

Parameters:

rhs - The boolean value that you want to compare to the values of the elements of this BooleanSource.

Returns:

A BooleanSource that has an element with a value of true when the value of the corresponding element of this BooleanSource is not equal to the specified boolean value, or false when it is equal to the specified value.

See Also:

Source.ne(Source rhs)

not

public final BooleanSource not()

Performs a logical NOT operation on the values of the elements of this BooleanSource, which negates the values so that if an element of this BooleanSource has a value of true, then the corresponding element of the resulting BooleanSource has a value of false. If an element of this BooleanSource has a value of false, then the corresponding element of the resulting BooleanSource has a value of true.

Returns:

A BooleanSource that has the results of the logical NOT operations on the values of the elements of this BooleanSource.

or

public final BooleanSource or(BooleanSource rhs)

Performs a logical OR operation between the values of the elements of this BooleanSource and the values of the corresponding elements of the specified BooleanSource.

Parameters:

rhs - The BooleanSource whose elements you want to logically OR with the elements of this BooleanSource.

Returns:

A BooleanSource that has the results of the logical OR operations between the values of the elements of this BooleanSource and the values of the corresponding elements of the specified BooleanSource.

or

public final BooleanSource or(boolean rhs)

Performs a logical OR operation between the values of the elements of this BooleanSource and the specified boolean value.

Parameters:

rhs - The boolan value that you want to logically OR with the elements of this BooleanSource.

Returns:

A BooleanSource that has the results of the logical OR operations between the values of the elements of this BooleanSource and the specified value.

positionOfValue

public final NumberSource positionOfValue(boolean value)

Identifies the positions of elements in this BooleanSource that have the specified boolean value.

Parameters:

value - The boolean value that you want to compare to the values of the elements of this BooleanSource.

Returns:

A NumberSource whose elements have int values that identify the positions of the elements in this BooleanSource that have the specified boolean value. If this BooleanSource does not have any elements that have the specified value, then this method returns an empty NumberSource, which has no elements.

See Also:

Source.positionOfValue(Source value)

positionOfValues

public final NumberSource positionOfValues(boolean[] values)

Identifies the positions of elements in this BooleanSource that have the specified boolean values.

Parameters:

values - An array of boolean values that you want to compare to the values of the elements of this BooleanSource.

Returns:

A NumberSource whose elements have int values that identify the positions of the elements in this BooleanSource that have the specified boolean values. If this BooleanSource does not have any elements that have the specified values, then this method returns an empty NumberSource, which has no elements.

See Also:

Source.positionOfValues(Source values)

removeValue

public final BooleanSource removeValue(boolean value)

Removes the elements of this BooleanSource that have the specified boolean value.

Parameters:

value - The boolean value you do not want to have in the returned BooleanSource.

Returns:

A BooleanSource that has the elements of this BooleanSource that do not have the specified boolean value.

See Also:

Source.removeValue(Source value)

removeValues

public final BooleanSource removeValues(boolean[] values)

Removes the elements of this BooleanSource that have the specified boolean values.

Parameters:

values - An array of boolean values that you do not want to have in the returned BooleanSource.

Returns:

A BooleanSource that has the elements of this BooleanSource that do not have the specified values.

See Also:

Source.removeValues(Source values)

selectValue

public final BooleanSource selectValue(boolean value)

Selects the elements of this BooleanSource that have the specified boolean value.

Parameters:

value - The value to compare to the values of the elements of this BooleanSource.

Returns:

A BooleanSource that has the elements of this BooleanSource that have the specified boolean value.

See Also:

Source.selectValue(Source value)

selectValues

public final BooleanSource selectValues(boolean[] values)

Selects the elements of this BooleanSource that have the specified boolean values.

Parameters:

values - An array of boolean values to compare to the values of the elements of this BooleanSource.

Returns:

A BooleanSource that has the elements of this BooleanSource that have the specified values.

See Also:

Source.selectValues(Source values)