public interface DBArray
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
.DBStruct
Modifier and Type | Method and Description |
---|---|
void |
free()
This method frees the
DBArray object and releases the
resources that it holds. |
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. |
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. |
String |
getBaseTypeName()
Retrieves the type name of the array type that this
DBArray
object represents. |
com.ibm.ims.dli.DBArrayElementSet |
getElements()
Retrieves the elements of the array encapsulated in a
DBArrayElementSet object. |
Object getArray() throws DLIException
DBArray
object in the form of an array in the Java
programming language.DBArray
objectDLIException
- if an error occurs processingObject getArray(long index, int count) throws DLIException
DBArray
object, beginning with the specified
index
and containing up to count
successive
elements of the array.index
- the array index of the first element to retrieve; the first
element is at index 1count
- the number of successive SQL array elements to retrievecount
consecutive elements
of the array, beginning with element index
DLIException
- if an error occurs processingString getBaseTypeName() throws DLIException
DBArray
object represents.DLIException
- if an error occurscom.ibm.ims.dli.DBArrayElementSet getElements() throws DLIException
DBArrayElementSet
object.DLIException
- if an error occursDBArrayElementSet
void free() throws DLIException
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.DLIException
- if an error occurs(c) Copyright IBM Corporation 2008, 2017.