oracle.olapi.data.source
Class StringSource

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

public final class StringSource

extends Source

A Source that has elements that have String objects as values. A StringSource has an OLAP API data type of String. This class implements some Source methods so that they use String values, such as appendValue, and implements other methods that perform String operations, such as toUppercase, substring, and trim.

See Also:

Source.getDataType()

appendValue

public final StringSource appendValue(java.lang.String appendValue)

Appends an element with the specified String value to the elements of this StringSource.

Parameters:

appendValue - The String value that you want to append to this StringSource.

Returns:

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

See Also:

Source.appendValue(Source value)

appendValues

public final StringSource appendValues(java.lang.String[] appendValues)

Appends elements with the specified String values to the elements of this StringSource.

Parameters:

appendValues - An array of StringStringSource.

Returns:

A StringSource that has the same elements as this StringSource and that has additional appended elements that have the specified String values.

See Also:

Source.appendValue(Source value)

eq

public final BooleanSource eq(java.lang.String rhs)

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

Parameters:

rhs - The String value that you want to compare to the values of the elements of this StringSource.

Returns:

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

See Also:

Source.eq(Source rhs)

ge

public final BooleanSource ge(java.lang.String rhs)

Compares the value of each element of this StringSource to the specified String value, and determines whether it has a greater or equal value.

Parameters:

rhs - The String value that you want to compare to the values of the elements of this StringSource.

Returns:

A BooleanSource that has an element with a value of true when the value of an element of this StringSource is greater than or equal to the specified String 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 StringSource, which is String.

Returns:

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

Overrides:

getDataType in class Source

gt

public final BooleanSource gt(java.lang.String rhs)

Compares the value of each element of this StringSource to the specified String value, and determines whether it has a greater value.

Parameters:

rhs - The String value that you want to compare to the values of the elements of this StringSource.

Returns:

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

See Also:

Source.gt(Source rhs)

indexOf

public final NumberSource indexOf(java.lang.String substring,
                                  int fromIndex)

Starting at the fromIndex position in the value of each element of this StringSource, identifies the starting position of the first occurrence of substring in the value.

Parameters:

substring - A String the beginning position of which you want to locate in the value of each element of this StringSource.

fromIndex - An int that is the one-based position in the value of each element of this StringSource at which this method begins searching for substring.

Returns:

A NumberSource that has the beginning position of the first occurrence of substring in the values of the elements of this StringSource or zero if substring is not in the value.

indexOf

public final NumberSource indexOf(StringSource substring,
NumberSource fromIndex)

Starting at the fromIndex position in the value of each element of this StringSource, identifies the starting position of the first occurrence of substring in the value.

Parameters:

substring - A String the beginning position of which you want to locate in each element of this StringSource.

fromIndex - An NumberSource that has the one-based position in the value of each element of this StringSource at which this method begins searching for substring.

Returns:

A NumberSource that has the beginning position of the first occurrence of substring in the values of the elements of this StringSource or zero if substring is not in the value.

le

public final BooleanSource le(java.lang.String rhs)

Compares the value of each element of this StringSource to the specified String value, and determines whether it has a lesser or equal value.

Parameters:

rhs - The String value that you want to compare to the values of the elements of this StringSource.

Returns:

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

See Also:

Source.le(Source rhs)

length

public final NumberSource length()

Determines the length of the value of each element of this StringSource.

Returns:

A NumberSource, the value of each element of which is the length of the value of the corresponding element of this StringSource.

like

public final BooleanSource like(java.lang.String rhs)

Compares the values of the elements of this StringSource to the specified String.

This method supports the percent sign wildcard and the underline position marker. For example, to find out if the value of an element of this StringSource includes the characters Chloride, you can specify the String %Chloride%, as in the following.

 BooleanSource includesChloride = thisStringSource.like("%Chloride%");

To find out if the value of an element of this StringSource has with the characters oxi at positions two through four, you can specify the String _oxi%, as in the following.

 BooleanSource includesOxi = thisStringSource.like("_oxi%");

Parameters:

rhs - The String value that you want to compare to the values of the elements of this StringSource.

Returns:

A BooleanSource that has an element with a value of true when the value of the corresponding element of this StringSource matches the value of the specified String, or false when it is does not.

like

public final BooleanSource like(StringSource rhs)

Compares the values of the elements of this StringSource to the values of the elements of the specified StringSource.

This method supports the percent sign wildcard and the underline position marker.

Parameters:

rhs - A StringSource, the values of the elements of which you want to compare to the values of the elements of this StringSource.

Returns:

A BooleanSource that has an element with a value of true when a value of an element of this StringSource matches the value of an element of the specified StringSource, or false when it is does not.

See Also:

like(String rhs)

lt

public final BooleanSource lt(java.lang.String rhs)

Compares the value of each element of this StringSource to the specified String value, and determines whether it has a lesser value.

Parameters:

rhs - The String value that you want to compare to the values of the elements of this StringSource.

Returns:

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

See Also:

Source.lt(Source rhs)

ne

public final BooleanSource ne(java.lang.String rhs)

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

Parameters:

rhs - The String value that you want to compare to the values of the elements of this StringSource.

Returns:

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

See Also:

Source.ne(Source rhs)

positionOfValue

public final NumberSource positionOfValue(java.lang.String value)

Identifies the positions of the elements of this StringSource that have the specified String value.

Parameters:

value - The String value that you want to compare to the values of the elements of this StringSource.

Returns:

A NumberSource whose elements have int values that identify the positions of the elements of this StringSource that have the specified String value. If this StringSource 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(java.lang.String[] values)

Identifies the positions of the elements of this StringSource that have the specified String values.

Parameters:

value - An array ofString values that you want to compare to the values of the elements of this StringSource.

Returns:

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

remove

public final StringSource remove(int index,
                                 int length)

Removes length number of characters starting at position index from the values of the elements of this StringSource. This method returns a StringSource that has the values of the elements of this StringSource with the specified characters removed.

Parameters:

index - An int value that is the one-based position within the value of each element of this StringSource that is the first of the characters that you want to remove.

length - An int value that is the number of characters that you want to remove.

Returns:

A StringSource that has elements that have the values of the elements of this StringSource with the specified number of characters removed.

remove

public final StringSource remove(NumberSource index,
NumberSource length)

Removes length number of characters starting at position index from the values of the elements of this StringSource.

Parameters:

index - A NumberSource that has elements that have the integer values that are the one-based character positions within the value of each element of this StringSource that is the first of the characters that you want to remove.

length - A NumberSource that has elements that have the integer values that are the number of characters that you want to remove.

Returns:

A StringSource that has elements that have the values of the elements of this StringSource with the specified number of characters removed.

removeValue

public final StringSource removeValue(java.lang.String value)

Removes the elements of this StringSource that have the specified String as a value.

Parameters:

value - A String that has the value of the element or elements you do not want to have in the returned StringSource.

Returns:

A StringSource that has the elements of this StringSource except for those that have values that match the specified value.

See Also:

Source.removeValue(Source value)

removeValues

public final StringSource removeValues(java.lang.String[] values)

Removes the elements of this StringSource that have a value specified by one of the String objects in the values array. This method returns a StringSource that has the elements of this StringSource except for any elements that have a value that matches one of the specified String objects values.

Parameters:

values - An array of String objects that have the values that you do not want to have in the returned StringSource.

Returns:

A StringSource that has the elements of this StringSource except for those that have values that match the specified values.

See Also:

Source.removeValues(Source values)

replace

public final StringSource replace(java.lang.String oldString,
                                  java.lang.String newString)

Replaces each occurrence of oldString with newString in the value of each element of this StringSource.

Parameters:

oldString - A String that has the value that you want to replace with newString.

newString - A String that has the value with which you want to replace oldString.

Returns:

A StringSource that has the elements of this StringSource but that has oldString replaced by newString in value of each element.

replace

public final StringSource replace(StringSource oldString,
StringSource newString)

Replaces each occurrence of oldString with newString in the value of each element of this StringSource.

Parameters:

oldString - A StringSource that has elements that have the values that you want to replace with the values of the elements of newString.

newString - A StringSource that has elements that have the values with which you want to replace the values of the elements of oldString.

Returns:

A StringSource that has the elements of this StringSource but that has the values of the elements of oldString replaced by the values of the elements of newString.

selectDescendants

public final StringSource selectDescendants(java.lang.String comparison,
Source parent)

Selects the elements of this StringSource that are specified by comparison and the descendants of those elements in the hierarchy that this StringSource represents. Call this method only on a StringSource that is the Source for an MdmHierarchy or on a subtype of such a Source.

Parameters:

comparison - A String that has the value of the element or elements that you want to select from this StringSource.

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 StringSource represents.

Returns:

A StringSource that has the elements of this StringSource that are specified by comparison and the descendants of those elements in the hierarchy that this StringSource represents.

selectDescendants

public final StringSource selectDescendants(java.lang.String[] comparison,
Source parent)

Selects the elements of this StringSource that are specified by comparison and the descendants of those elements in the hierarchy that this StringSource represents. Call this method only on a StringSource that is the Source for an MdmHierarchy or on a subtype of such a Source.

Parameters:

comparison - An array of String objects that have the values of the elements that you want to select from this StringSource.

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 StringSource represents.

Returns:

A StringSource that has the elements of this StringSource that are specified by comparison and the descendants of those elements in the hierarchy that this StringSource represents.

selectValue

public final StringSource selectValue(java.lang.String value)

Selects the elements of this StringSource that have the specified value.

Parameters:

value - A String that has the value of the elements of this StringSource that you want to have in the returned StringSource.

Returns:

A StringSource that has the elements of this StringSource that have the specified String value.

See Also:

Source.selectValue(Source value)

selectValues

public final StringSource selectValues(java.lang.String[] values)

Selects the elements of this StringSource that have the specified values.

Parameters:

values - An array of String objects that have the values of the elements of this StringSource that you want to have in the returned StringSource.

Returns:

A StringSource that has the elements of this StringSource that have the values specified by values.

See Also:

Source.selectValues(Source values)

substring

public final StringSource substring(int index,
                                    int length)

Selects the length number of characters, beginning at the position specified by index, from the values of the elements of this StringSource.

Parameters:

index - An int value that is the one-based position within the value of each element of this StringSource of the first character of the substring to select.

length - An int value that is the number of characters in the substring.

Returns:

A StringSource that has the specified characters selected from the values of the elements of this StringSource.

substring

public final StringSource substring(NumberSource index,
NumberSource length)

Selects the length number of characters, beginning at the position specified by index, from the values of the elements of this StringSource.

Parameters:

index - A NumberSource that has the one-based positions within the values of the elements of this StringSource of the first character of the substring or substrings to select.

length - A NumberSource that has the number of characters in the substring or substrings.

Returns:

A StringSource that has the specified characters selected from the values of the elements of this StringSource.

textFill

public final StringSource textFill(int width)

Resizes the values of the elements of this StringSource to the specified width.

Parameters:

width - An int value that specifies the length that you want the values of the returned StringSource to be.

Returns:

A StringSource that has elements that have the values of the elements of this StringSource with the values truncated or lengthened by blank spaces to the number of characters specified by width.

textFill

public final StringSource textFill(NumberSource width)

Resizes the values of the elements of this StringSource to the specified width or widths.

Parameters:

width - A NumberSource that has elements that have the value or values that specify the length that you want the values of the returned StringSource to be.

Returns:

A StringSource that has elements that have the values of the elements of this StringSource with the values truncated or lengthened by blank spaces to the number of characters specified by width.

toLowercase

public final StringSource toLowercase()

Converts the alphabetic characters in the values of the elements of this StringSource to lowercase.

Returns:

A StringSource that has the elements of this StringSource with the alphabetic characters in the values of those elements converted to lowercase.

toUppercase

public final StringSource toUppercase()

Converts the alphabetic characters in the values of the elements of this StringSource to uppercase.

Returns:

A StringSource that has the elements of this StringSource with the alphabetic characters in the values of those elements converted to uppercase.

trim

public final StringSource trim()

Removes the leading and trailing blank spaces from the values of the elements of this StringSource.

Returns:

A StringSource with the same elements as this StringSource but with all of the leading and trailing blank spaces removed from the values of the elements.

See Also:

trimLeading(), trimTrailing()

trimLeading

public final StringSource trimLeading()

Removes the leading blank spaces from the values of the elements of this StringSource.

Returns:

A StringSource with the same elements as this StringSource but with all of the leading blank spaces removed from the values of the elements.

See Also:

trim(), trimTrailing()

trimTrailing

public final StringSource trimTrailing()

Removes the trailing blank spaces from the values of the elements of this StringSource.

Returns:

A StringSource with the same elements as this StringSource but with all of the trailing blank spaces removed from the values of the elements.

See Also:

trim(), trimLeading()

plus

public final StringSource plus(StringSource rhs)

Appends the values of the elements of rhs to the values of the elements of this StringSource.

Parameters:

rhs - A StringSource whose elements have the values that you want to append to the values of the elements of this StringSource.

Returns:

A StringSource that has the elements of this StringSource with the values of rhs appended to them.