com.sap.ip.bi.sdk.dac.relational.query.sapq
Interface IBISapqSelectOption

All Superinterfaces:

Comparable

public interface IBISapqSelectOption

extends Comparable

Record of an ABAP/4 SELECT-OPTIONS table. The semantic is described below, paraphrased from ABAP/4 online help. Throughout this document, sel stands for an array of IBISapqSelectOption.

The components of sel have the following meaning:

• COLUMN contains the column on which the restriction (row of sel) is defined.
• SIGN contains I for Inclusive or E for Exclusive.
• OPTION contains one of the following operators:
• EQ (EQual)
• BT (BeTween ... and ...)
• CP (Contains Pattern)
• LE (Less than or Equal)
• GE (Greater than or Equal)
• NE (Not Equal to)
• NB (Not Between ... and ...)
• NP (Not contains Pattern)
• GT (Greater Than)
• LT (Less Than)
• LOW contains the comparison value; with BT, this is the lower limit of the range.
• With BT and NB, HIGH contains the higher limit of the range.

Note:

1. All lines with the same COLUMN define together a set (in the following SEL).
1. Each line of SEL describes a set.
2. The set defined by the entire table SEL is the union of inclusive sets (lines with SIGN = 'I) minus the union of exclusive sets (lines with SIGN = 'E').
3. If no lines exist with SIGN = 'I', the union of inclusive sets is set to its maximum size.
4. If no lines exist with SIGN = 'E', the union of exclusive sets is empty.
2. The set defined by the entire table is the intersection of the above defined sets (defined by grouping the rows by the same COLUMN value).

Example
Contents of table sel:

COLUMN	SIGN	OPTION	LOW	HIGH
col1	I	BT	1	6
col1	E	BT	4	7
col1	I	EQ	1
col1	I	EQ	7
col1	I	EQ	9
col1	E	EQ	1
col2	I	EQ	10

If the table T with the columns col1 and col2 contained all possible pairs of integral numbers the above sel would contain the following pairs: {(2,10), (3,10), (9,10)}.

Note:
The logical expression is satisfied whenever the table sel is empty.

Since:

3.50

Inner Class Summary

static class	IBISapqSelectOption.Enum Simple typesafe enumerator.
static class	IBISapqSelectOption.Kind Typesafe Enumerator for SELECT-OPTIONS Kind.
static class	IBISapqSelectOption.Option Typesafe Enumerator for SELECT-OPTIONS Option.
static class	IBISapqSelectOption.Sign Typesafe Enumerator for SELECT-OPTIONS Sign.

Field Summary

static char	MATCH_ESCAPE Allows the literal use of the characters MATCH_MULTIPLE_CHARS, MATCH_SINGLE_CHAR and MATCH_ESCAPE in the pattern.
static char	MATCH_MULTIPLE_CHARS Matches 0 or more characters in the string.
static char	MATCH_SINGLE_CHAR Matches exactly 1 character in the string.

Method Summary

Column	getColumn() Gets the column.
String	getHigh() Gets the high value (used only in conjunction with the options BETWEEN and NOT_BETWEEN).
IBISapqSelectOption.Kind	getKind() Gets the kind (PARAMETER or SELECT_OPTION).
String	getLow() Gets the low value.
IBISapqSelectOption.Option	getOption() Gets the option (EQUALS, BETWEEN, ...).
IBISapqSelectOption.Sign	getSign() Gets the sign (INCLUDING or EXCLUDING).
String	getTableRef() Gets the table reference.

Methods inherited from interface java.lang.Comparable

compareTo

Field Detail

MATCH_MULTIPLE_CHARS

public static final char MATCH_MULTIPLE_CHARS

Matches 0 or more characters in the string.

MATCH_SINGLE_CHAR

public static final char MATCH_SINGLE_CHAR

Matches exactly 1 character in the string.

MATCH_ESCAPE

public static final char MATCH_ESCAPE

Allows the literal use of the characters MATCH_MULTIPLE_CHARS, MATCH_SINGLE_CHAR and MATCH_ESCAPE in the pattern.

Method Detail

getTableRef

public String getTableRef()

Gets the table reference.

Returns:

the table reference

getColumn

public Column getColumn()

Gets the column.

Returns:

the column

getKind

public IBISapqSelectOption.Kind getKind()

Gets the kind (PARAMETER or SELECT_OPTION).

Returns:

the kind

getSign

public IBISapqSelectOption.Sign getSign()

Gets the sign (INCLUDING or EXCLUDING).

Returns:

the sign

getOption

public IBISapqSelectOption.Option getOption()

Gets the option (EQUALS, BETWEEN, ...).

Returns:

the option

getLow

public String getLow()

Gets the low value.

Returns:

the low value

getHigh

public String getHigh()

Gets the high value (used only in conjunction with the options BETWEEN and NOT_BETWEEN).

Returns:

the high value