|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.ibm.ims.db.SSAList
SSAList represents a collection of SSA (Segment Search Arguments) objects.
Constructor Summary | |
protected |
SSAList()
Creates an empty SSA list. |
protected |
SSAList(SSA ssa)
Creates an SSA list from an existing SSA, and places the ssa argument at the head of the list. |
protected |
SSAList(java.lang.String dbPCBNameReference)
Creates an empty SSA list. |
protected |
SSAList(java.lang.String dbPCBNameReference,
SSA ssa)
Creates an SSA list from an existing SSA, and places the ssa argument at the head of the list. |
Method Summary | |
void |
addSSA(SSA ssa)
Adds the ssa argument to an existing SSA list, placing it at the end of the list. |
void |
clearParameters()
Clears the values of all prepared parameters |
protected java.lang.Object |
clone()
Returns a clone of the SSAList. |
static SSAList |
createInstance()
Deprecated. Replaced by createInstance(String) |
static SSAList |
createInstance(SSA ssa)
Deprecated. Replaced by createInstance(String, SSA) |
static SSAList |
createInstance(java.lang.String dbPCBNameReference)
Creates an SSA list. |
static SSAList |
createInstance(java.lang.String dbPCBNameReference,
SSA ssa)
Creates an SSA list from an existing SSA, and places the ssa argument at the head of the list. |
byte[][] |
getBytes(DLIDatabaseView dbView)
Returns the SSA list in a two-dimensional byte array. |
void |
setValue(int index,
java.math.BigDecimal value)
Sets the value of a prepared parameter to the desired value. |
void |
setValue(int index,
boolean value)
Sets the value of a prepared parameter to the desired value. |
void |
setValue(int index,
byte value)
Sets the value of a prepared parameter to the desired value. |
void |
setValue(int index,
byte[] value)
Sets the value of a prepared parameter to the desired value. |
void |
setValue(int index,
java.sql.Date value)
Sets the value of a prepared parameter to the desired value. |
void |
setValue(int index,
double value)
Sets the value of a prepared parameter to the desired value. |
void |
setValue(int index,
float value)
Sets the value of a prepared parameter to the desired value. |
void |
setValue(int index,
int value)
Sets the value of a prepared parameter to the desired value. |
void |
setValue(int index,
long value)
Sets the value of a prepared parameter to the desired value. |
void |
setValue(int index,
short value)
Sets the value of a prepared parameter to the desired value. |
void |
setValue(int index,
java.lang.String value)
Sets the value of a prepared parameter to the desired value. |
void |
setValue(int index,
java.sql.Time value)
Sets the value of a prepared parameter to the desired value. |
void |
setValue(int index,
java.sql.Timestamp value)
Sets the value of a prepared parameter to the desired value. |
int |
size()
Returns the number of SSAs in this list |
SSA |
ssaAt(int index)
Returns the SSA at the specified index |
Methods inherited from class java.lang.Object |
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
protected SSAList()
protected SSAList(SSA ssa)
ssa
- an SSAprotected SSAList(java.lang.String dbPCBNameReference)
dbPCBNameReference
- The reference to the actual DB PCB name. The reference
name is the database PCB name that was provided via the
dbPCBNameReference
parameter to either the
DLIDatabaseView(String, String, String, DLISegmentInfo[])
constructor or DLIDatabaseView.addDatabase(String, String, DLISegmentInfo[])
method.DLIDatabaseView
protected SSAList(java.lang.String dbPCBNameReference, SSA ssa)
dbPCBNameReference
- The reference to the actual DB PCB name. The reference
name is the database PCB name that was provided via the
dbPCBNameReference
parameter to either the
DLIDatabaseView(String, String, String, DLISegmentInfo[])
constructor or DLIDatabaseView.addDatabase(String, String, DLISegmentInfo[])
method.ssa
- an SSADLIDatabaseView
Method Detail |
public void addSSA(SSA ssa) throws IMSException
If an SSA uses the CONCATENATED_KEY
command code, it must be the only
SSA in the SSAList, otherwise an exception will be thrown.
ssa
- an SSApublic void clearParameters()
public static SSAList createInstance()
public static SSAList createInstance(SSA ssa)
ssa
- an SSApublic byte[][] getBytes(DLIDatabaseView dbView) throws IMSException
DLIException
- if the SSAList does not have all its fields set (i.e.; some fields still
have 'null' as their value)public void setValue(int index, byte[] value)
null
when the SSA or the SSAQualificationStatement was
created, indicating that the value could be substituted in later. If an SSAList is
composed of 2 SSAs, each with 2 prepared parameters, then the index can be between
1 and 4, inclusive. For example, an index of 2 would specify the second prepared
parameter of the first SSA in the SSAList.index
- the index of the parameter value to be changed, starting with 1value
- the value of the parameterSSA
,
SSAQualificationStatement
public void setValue(int index, byte value)
null
when the SSA or the SSAQualificationStatement was
created, indicating that the value could be substituted in later. If an SSAList is
composed of 2 SSAs, each with 2 prepared parameters, then the index can be between
1 and 4, inclusive. For example, an index of 2 would specify the second prepared
parameter of the first SSA in the SSAList.index
- the index of the parameter value to be changed, starting with 1value
- the value of the parameterSSA
,
SSAQualificationStatement
public void setValue(int index, double value)
null
when the SSA or the SSAQualificationStatement was
created, indicating that the value could be substituted in later. If an SSAList is
composed of 2 SSAs, each with 2 prepared parameters, then the index can be between
1 and 4, inclusive. For example, an index of 2 would specify the second prepared
parameter of the first SSA in the SSAList.index
- the index of the parameter value to be changed, starting with 1value
- the value of the parameterSSA
,
SSAQualificationStatement
public void setValue(int index, float value)
null
when the SSA or the SSAQualificationStatement was
created, indicating that the value could be substituted in later. If an SSAList is
composed of 2 SSAs, each with 2 prepared parameters, then the index can be between
1 and 4, inclusive. For example, an index of 2 would specify the second prepared
parameter of the first SSA in the SSAList.index
- the index of the parameter value to be changed, starting with 1value
- the value of the parameterSSA
,
SSAQualificationStatement
public void setValue(int index, int value)
null
when the SSA or the SSAQualificationStatement was
created, indicating that the value could be substituted in later. If an SSAList is
composed of 2 SSAs, each with 2 prepared parameters, then the index can be between
1 and 4, inclusive. For example, an index of 2 would specify the second prepared
parameter of the first SSA in the SSAList.index
- the index of the parameter value to be changed, starting with 1value
- the value of the parameterSSA
,
SSAQualificationStatement
public void setValue(int index, long value)
null
when the SSA or the SSAQualificationStatement was
created, indicating that the value could be substituted in later. If an SSAList is
composed of 2 SSAs, each with 2 prepared parameters, then the index can be between
1 and 4, inclusive. For example, an index of 2 would specify the second prepared
parameter of the first SSA in the SSAList.index
- the index of the parameter value to be changed, starting with 1value
- the value of the parameterSSA
,
SSAQualificationStatement
public void setValue(int index, java.lang.String value)
null
when the SSA or the SSAQualificationStatement was
created, indicating that the value could be substituted in later. If an SSAList is
composed of 2 SSAs, each with 2 prepared parameters, then the index can be between
1 and 4, inclusive. For example, an index of 2 would specify the second prepared
parameter of the first SSA in the SSAList.index
- the index of the parameter value to be changed, starting with 1value
- the value of the parameter, which will be converted to its
appropriate type as defined in the type infoSSA
,
SSAQualificationStatement
public void setValue(int index, java.math.BigDecimal value)
null
when the SSA or the SSAQualificationStatement was
created, indicating that the value could be substituted in later. If an SSAList is
composed of 2 SSAs, each with 2 prepared parameters, then the index can be between
1 and 4, inclusive. For example, an index of 2 would specify the second prepared
parameter of the first SSA in the SSAList.index
- the index of the parameter value to be changed, starting with 1value
- the value of the parameterSSA
,
SSAQualificationStatement
public void setValue(int index, java.sql.Date value)
null
when the SSA or the SSAQualificationStatement was
created, indicating that the value could be substituted in later. If an SSAList is
composed of 2 SSAs, each with 2 prepared parameters, then the index can be between
1 and 4, inclusive. For example, an index of 2 would specify the second prepared
parameter of the first SSA in the SSAList.index
- the index of the parameter value to be changed, starting with 1value
- the value of the parameterSSA
,
SSAQualificationStatement
public void setValue(int index, java.sql.Time value)
null
when the SSA or the SSAQualificationStatement was
created, indicating that the value could be substituted in later. If an SSAList is
composed of 2 SSAs, each with 2 prepared parameters, then the index can be between
1 and 4, inclusive. For example, an index of 2 would specify the second prepared
parameter of the first SSA in the SSAList.index
- the index of the parameter value to be changed, starting with 1value
- the value of the parameterSSA
,
SSAQualificationStatement
public void setValue(int index, java.sql.Timestamp value)
null
when the SSA or the SSAQualificationStatement was
created, indicating that the value could be substituted in later. If an SSAList is
composed of 2 SSAs, each with 2 prepared parameters, then the index can be between
1 and 4, inclusive. For example, an index of 2 would specify the second prepared
parameter of the first SSA in the SSAList.index
- the index of the parameter value to be changed, starting with 1value
- the value of the parameterSSA
,
SSAQualificationStatement
public void setValue(int index, short value)
null
when the SSA or the SSAQualificationStatement was
created, indicating that the value could be substituted in later. If an SSAList is
composed of 2 SSAs, each with 2 prepared parameters, then the index can be between
1 and 4, inclusive. For example, an index of 2 would specify the second prepared
parameter of the first SSA in the SSAList.index
- the index of the parameter value to be changed, starting with 1value
- the value of the parameterSSA
,
SSAQualificationStatement
public void setValue(int index, boolean value)
null
when the SSA or the SSAQualificationStatement was
created, indicating that the value could be substituted in later. If an SSAList is
composed of 2 SSAs, each with 2 prepared parameters, then the index can be between
1 and 4, inclusive. For example, an index of 2 would specify the second prepared
parameter of the first SSA in the SSAList.index
- the index of the parameter value to be changed, starting with 1value
- the value of the parameterSSA
,
SSAQualificationStatement
public final int size()
public final SSA ssaAt(int index)
index
- the 1-based index into the list (i.e.; index 1 is the first SSA)public static SSAList createInstance(java.lang.String dbPCBNameReference)
dbPCBNameReference
- The reference to the actual DB PCB name. The reference
name is the database PCB name that was provided via the
dbPCBNameReference
parameter to either the
DLIDatabaseView(String, String, String, DLISegmentInfo[])
constructor or DLIDatabaseView.addDatabase(String, String, DLISegmentInfo[])
method.public static SSAList createInstance(java.lang.String dbPCBNameReference, SSA ssa)
dbPCBNameReference
- The reference to the actual DB PCB name. The reference
name is the database PCB name that was provided via the
dbPCBNameReference
parameter to either the
DLIDatabaseView(String, String, String, DLISegmentInfo[])
constructor or DLIDatabaseView.addDatabase(String, String, DLISegmentInfo[])
method.ssa
- an SSAprotected java.lang.Object clone() throws java.lang.CloneNotSupportedException
clone
in class java.lang.Object
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |