com.ibm.ims.dli

Interface DBArray

public interface DBArray

A DBArray object contains a value for each element of the structured type that it represents. The Array structured type is used when a database description (DBD) contains a field with DATATYPE=ARRAY.

See Also:

DBStruct

Method Summary

Modifier and Type	Method and Description
void	free() This method frees the DBArray object and releases the resources that it holds.
java.lang.Object	getArray() Retrieves the contents of the ARRAY value designated by this DBArray object in the form of an array in the Java programming language.
java.lang.Object	getArray(long index, int count) Retrieves a slice of the ARRAY value designated by this DBArray object, beginning with the specified index and containing up to count successive elements of the array.
java.lang.String	getBaseTypeName() Retrieves the type name of the array type that this DBArray object represents.
DBArrayElementSet	getElements() Retrieves the elements of the array encapsulated in a DBArrayElementSet object.

Method Detail

getArray

java.lang.Object getArray()
                   throws DLIException

Retrieves the contents of the ARRAY value designated by this DBArray object in the form of an array in the Java programming language.

Returns:

an array in the Java programming language that contains the ordered elements of the ARRAY value designated by this DBArray object

Throws:

DLIException - if an error occurs processing

getArray

java.lang.Object getArray(long index,
                          int count)
                   throws DLIException

Retrieves a slice of the ARRAY value designated by this DBArray object, beginning with the specified index and containing up to count successive elements of the array.

Parameters:

index - the array index of the first element to retrieve; the first element is at index 1

count - the number of successive SQL array elements to retrieve

Returns:

an array containing up to count consecutive elements of the array, beginning with element index

Throws:

DLIException - if an error occurs processing

getBaseTypeName

java.lang.String getBaseTypeName()
                          throws DLIException

Retrieves the type name of the array type that this DBArray object represents.

Returns:

the fully-qualified type name in the format pcbName. segmentName.arrayName

Throws:

DLIException - if an error occurs

getElements

DBArrayElementSet getElements()
                       throws DLIException

Retrieves the elements of the array encapsulated in a DBArrayElementSet object.

Returns:

the elements of the array

Throws:

DLIException - if an error occurs

See Also:

DBArrayElementSet

free

void free()
   throws DLIException

This method frees the DBArray object and releases the resources that it holds. The object is invalid once the free method is called. After free has been called, any attempt to invoke a method other than free will result in a DLIException being thrown. If free is called multiple times, the subsequent calls to free are treated as a no-op.

Throws:

DLIException - if an error occurs