com.ibm.ims.db.cci

Class SSAListHelper

java.lang.Object

com.ibm.ims.db.cci.SSAListHelper

public class SSAListHelper
extends java.lang.Object

The SSAListHelper class is used to construct a segment search argument (SSA) qualification statement string. You can set DL/I command codes for the SSAs, with the exception of lock classes and the C command code.

The following code example shows how to set the SSA qualification statement string using the SSAListHelper to return return the last patient admitted to all of the wards with more than five doctors and less than three nurses in hospital "ALEXANDRIA"):

 
 SSAListHelper sh = new SSAListHelper();
 sh.addInitialQualification("Hospital", "HospName", SSAListHelper.EQUALS, "ALEXANDRIA");
 sh.appendQualification("Ward", SSAListHelper.AND, "Doccount", SSAListHelper.GREATER_THAN, 5);
 sh.appendQualification("Ward", SSAListHelper.OR, "Nurcount", SSAListHelper.LESS_THAN, 3);
 sh.addCommandCode("Patient", SSAListHelper.CC_L);
 iSpec.setSSAList(sh.toString()); 
 

Field Summary

Fields

Modifier and Type	Field and Description
static byte	AND Constant indicating the boolean operator AND in an SSA qualification statement
static byte	CC_D Constant indicating the D command code (path call)
static byte	CC_L Constant indicating the L command code (last occurrence)
static short	EQUALS Constant indicating the relational operator for equals (=) in an SSA qualification statement
static short	GREATER_OR_EQUAL Constant indicating the relational operator for greater than or equal to (>=) in an SSA qualification statement
static short	GREATER_THAN Constant indicating the relational operator for greater than (>) in an SSA qualification statement
static byte	INDEPENDENT_AND Constant indicating the boolean operator INDEPENDENT AND in an SSA qualification statement
static short	LESS_OR_EQUAL Constant indicating the relational operator for less than or equal to (<=) in an SSA qualification statement
static short	LESS_THAN Constant indicating the relational operator for less than (<) in an SSA qualification statement
static short	NOT_EQUAL Constant indicating the relational operator for not equal to (!=) in an SSA qualification statement
static byte	OR Constant indicating the boolean operator OR in an SSA qualification statement

Constructor Summary

Constructors

Constructor and Description
SSAListHelper()

Method Summary

Modifier and Type	Method and Description
void	addCommandCode(java.lang.String segmentName, byte commandCode) Add a command code to the SSAList.
void	addInitialQualification(java.lang.String segmentName, java.lang.String fieldName, short relationalOp, java.lang.String value) Add the initial qualification statement to the SSAList.
void	addSSA(java.lang.String segmentName) Add an initial unqualified statement to the SSAList.
void	appendQualification(java.lang.String segmentName, byte booleanOp, java.lang.String fieldName, short relationalOp, java.lang.String value) Append a qualification statement to the specified SSA in the SSAList.
java.lang.String	toString() Returns the SSAList in the form of a string.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

EQUALS

public static final short EQUALS

Constant indicating the relational operator for equals (=) in an SSA qualification statement

See Also:

Constant Field Values

GREATER_OR_EQUAL

public static final short GREATER_OR_EQUAL

Constant indicating the relational operator for greater than or equal to (>=) in an SSA qualification statement

See Also:

Constant Field Values

LESS_OR_EQUAL

public static final short LESS_OR_EQUAL

Constant indicating the relational operator for less than or equal to (<=) in an SSA qualification statement

See Also:

Constant Field Values

GREATER_THAN

public static final short GREATER_THAN

Constant indicating the relational operator for greater than (>) in an SSA qualification statement

See Also:

Constant Field Values

LESS_THAN

public static final short LESS_THAN

Constant indicating the relational operator for less than (<) in an SSA qualification statement

See Also:

Constant Field Values

NOT_EQUAL

public static final short NOT_EQUAL

Constant indicating the relational operator for not equal to (!=) in an SSA qualification statement

See Also:

Constant Field Values

AND

public static final byte AND

Constant indicating the boolean operator AND in an SSA qualification statement

See Also:

Constant Field Values

OR

public static final byte OR

Constant indicating the boolean operator OR in an SSA qualification statement

See Also:

Constant Field Values

INDEPENDENT_AND

public static final byte INDEPENDENT_AND

Constant indicating the boolean operator INDEPENDENT AND in an SSA qualification statement

See Also:

Constant Field Values

CC_D

public static final byte CC_D

Constant indicating the D command code (path call)

See Also:

Constant Field Values

CC_L

public static final byte CC_L

Constant indicating the L command code (last occurrence)

See Also:

Constant Field Values

Constructor Detail

SSAListHelper

public SSAListHelper()

Method Detail

addCommandCode

public void addCommandCode(java.lang.String segmentName,
                           byte commandCode)
                    throws javax.resource.ResourceException

Add a command code to the SSAList.

Parameters:

segmentName - the name of the segment in the SSAList

commandCode - the command code to add

Throws:

javax.resource.ResourceException - if an error occurs during processing

addInitialQualification

public void addInitialQualification(java.lang.String segmentName,
                                    java.lang.String fieldName,
                                    short relationalOp,
                                    java.lang.String value)
                             throws javax.resource.ResourceException

Add the initial qualification statement to the SSAList.

Parameters:

segmentName - the name of the segment in the SSAList to add the qualification to

fieldName - the name of the field

relationalOp - the relational operator to use - one of the SSAList constants

value - the value of the field as a String

Throws:

javax.resource.ResourceException - if an error occurs during processing

appendQualification

public void appendQualification(java.lang.String segmentName,
                                byte booleanOp,
                                java.lang.String fieldName,
                                short relationalOp,
                                java.lang.String value)
                         throws javax.resource.ResourceException

Append a qualification statement to the specified SSA in the SSAList.

Parameters:

segmentName - the name of the segment in the SSAList to add the qualification to

booleanOp - the boolean operator to use to connect this qualification to the previous - one of the SSAList constants

fieldName - the name of the field

relationalOp - the relational operator to use - one of the SSAList constants

value - the value of the field as a String

Throws:

javax.resource.ResourceException - if an error occurs during processing

addSSA

public void addSSA(java.lang.String segmentName)
            throws javax.resource.ResourceException

Add an initial unqualified statement to the SSAList.

Parameters:

segmentName - the name of the segment in the SSAList to add the qualification to

Throws:

javax.resource.ResourceException

toString

public java.lang.String toString()

Returns the SSAList in the form of a string.

Overrides:

toString in class java.lang.Object

Returns:

the ssaList String.