com.ibm.ims.dli

Interface Path

public interface Path

The Path interface represents a list of database segments for the purpose of a DL/I retrieval, insert, delete, or update operation. The Path can be viewed as the concatenation of all of the segment instances in a specific database hierarchic path, starting from the highest level segment that is nearest the root segment to the lowest level segment. Use the Path interface to set or retrieve the value of any segment field located in the hierarchic path. The following code fragment shows how to create and use Path to get the value of the ILLNAME field in the ILLNESS segment and return it as a String.

 Path path = ssaList.getPathForRetrieveReplace();
 if (pcb.getUnique(path, ssaList, false)) {
        String fieldValue = path.getString("ILLNESS", "ILLNAME");
 }
 

See Also:

PathSet.next(), PathSet.next(Path), PCB, SSAList.getPathForBatchUpdate(String), SSAList.getPathForInsert(String), SSAList.getPathForRetrieveReplace()

Method Summary

Modifier and Type	Method and Description
void	clearWarnings() Clears all warnings reported on this Path object.
AIB	getAIB() Returns the AIB (Application Interface Block) associated with the most recent DL/I call.
DBArray	getArray(java.lang.String fieldName) Retrieves the value of the designated field in the Path object as a com.ibm.ims.dli.DBArray.
DBArray	getArray(java.lang.String segmentName, java.lang.String fieldName) Retrieves the value of the field in the specified segment of this Path object as a com.ibm.ims.dli.DBArray.
java.math.BigDecimal	getBigDecimal(java.lang.String fieldName) Retrieves the value of the designated field in the Path object as a java.math.BigDecimal.
java.math.BigDecimal	getBigDecimal(java.lang.String segmentName, java.lang.String fieldName) Retrieves the value of the field in the specified segment of this Path object as a java.math.BigDecimal.
boolean	getBoolean(java.lang.String fieldName) Retrieves the value of the designated field in the Path object as a boolean.
boolean	getBoolean(java.lang.String segmentName, java.lang.String fieldName) Retrieves the value of the field in the specified segment of this Path object as a boolean.
byte	getByte(java.lang.String fieldName) Retrieves the value of the designated field in the segment of this Path object as a byte.
byte	getByte(java.lang.String segmentName, java.lang.String fieldName) Retrieves the value of the field in the specified segment of this Path object as a byte.
byte[]	getBytes(java.lang.String fieldName) Gets the value of the designated field in the Path object as a byte array.
byte[]	getBytes(java.lang.String segmentName, java.lang.String fieldName) Retrieves the value of the designated field in the segment of this Path object as a byte array.
java.sql.Date	getDate(java.lang.String fieldName) Sets the value of the designated field in the Path object as a java.sql.Date.
java.sql.Date	getDate(java.lang.String segmentName, java.lang.String fieldName) Retrieves the value of the field in the specified segment of this Path object as a java.sql.Date.
double	getDouble(java.lang.String fieldName) Retrieves the value of the designated field in the Path object as a double.
double	getDouble(java.lang.String segmentName, java.lang.String fieldName) Retrieves the value of the field in the specified segment of this Path object as a double.
java.util.Hashtable<java.lang.String,java.util.Vector<java.lang.String>>	getFields() Returns a collection of fields in this path.
float	getFloat(java.lang.String fieldName) Retrieves the value of the designated field in the Path object as a float.
float	getFloat(java.lang.String segmentName, java.lang.String fieldName) Retrieves the value of the field in the specified segment of this Path object as a float.
int	getInt(java.lang.String fieldName) Retrieves the value of the designated field in the segment of this Path object as an int.
int	getInt(java.lang.String segmentName, java.lang.String fieldName) Retrieves the value of the field in the specified segment of this Path object as an int.
long	getLong(java.lang.String fieldName) Retrieves the value of the designated field in the Path object as a long.
long	getLong(java.lang.String segmentName, java.lang.String fieldName) Retrieves the value of the field in the specified segment of this Path object as a long.
PathMetaData	getMetaData() Retrieves the number, types and properties of the fields of this Path object.
java.lang.String	getName() Returns the names of the segment(s) contained in this Path as defined by the database metadata.
java.lang.Object	getObject(java.lang.String fieldName) Retrieves the value of the designated field in the Path object as an Object in the Java Programming Language.
java.lang.Object	getObject(java.lang.String segmentName, java.lang.String fieldName) Retrieves the value of the designated field in the Path object as a java.lang.Object.
short	getShort(java.lang.String fieldName) Retrieves the value of the designated field in the Path object as a short.
short	getShort(java.lang.String segmentName, java.lang.String fieldName) Retrieves the value of the field in the specified segment of this Path object as a short.
java.lang.String	getString(java.lang.String fieldName) Gets the value of the designated field in the Path object as a java.lang.String.
java.lang.String	getString(java.lang.String segmentName, java.lang.String fieldName) Retrieves the value of the field in the specified segment of this Path object as a java.lang.String.
java.sql.Time	getTime(java.lang.String fieldName) Sets the value of the designated field in the Path object as a java.sql.Time.
java.sql.Time	getTime(java.lang.String segmentName, java.lang.String fieldName) Retrieves the value of the field in the specified segment of this Path object as a java.sql.Time.
java.sql.Timestamp	getTimestamp(java.lang.String fieldName) Sets the value of the designated field in the Path object as a java.sql.TimeStamp.
java.sql.Timestamp	getTimestamp(java.lang.String segmentName, java.lang.String fieldName) Retrieves the value of the field in the specified segment of this Path object as a java.sql.TimeStamp.
com.ibm.ims.dli.DLIWarning	getWarnings() Retrieves the first warning reported by calls on this Path object.
void	setArray(java.lang.String fieldName, DBArray value) Sets the value of the designated field in the Path object as a com.ibm.ims.dli.DBArray.
void	setArray(java.lang.String segmentName, java.lang.String fieldName, DBArray value) Sets the value of the field in the specified segment of this Path object as a com.ibm.ims.dli.DBArray.
void	setBigDecimal(java.lang.String fieldName, java.math.BigDecimal value) Sets the value of the field in the Path object as a java.math.BigDecimal.
void	setBigDecimal(java.lang.String segmentName, java.lang.String fieldName, java.math.BigDecimal value) Sets the value of the designated field in the segment of this Path object as a java.math.BigDecimal.
void	setBoolean(java.lang.String fieldName, boolean value) Sets the value of the designated field in the Path object as a boolean.
void	setBoolean(java.lang.String segmentName, java.lang.String fieldName, boolean value) Sets the value of the field in the specified segment of this Path object as a boolean.
void	setByte(java.lang.String fieldName, byte value) Sets the value of the designated field in the segment of this Path object as a byte.
void	setByte(java.lang.String segmentName, java.lang.String fieldName, byte value) Sets the value of the field in the specified segment of this Path object as a byte.
void	setBytes(java.lang.String fieldName, byte[] value) Sets the value of the designated field in the Path object as a byte array.
void	setBytes(java.lang.String segmentName, java.lang.String fieldName, byte[] value) Sets the value of the designated field in the segment of this Path object as a byte array.
void	setDate(java.lang.String fieldName, java.sql.Date value) Sets the value of the designated field in the Path object as a java.sql.Date.
void	setDate(java.lang.String segmentName, java.lang.String fieldName, java.sql.Date value) Sets the value of the field in the specified segment of this Path object as a java.sql.Date.
void	setDouble(java.lang.String fieldName, double value) Sets the value of the designated field in the Path object as a double .
void	setDouble(java.lang.String segmentName, java.lang.String fieldName, double value) Sets the value of the field in the specified segment of this Path object as a double.
void	setFloat(java.lang.String fieldName, float value) Sets the value of the designated field in the Path object as a float.
void	setFloat(java.lang.String segmentName, java.lang.String fieldName, float value) Sets the value of the field in the specified segment of this Path object as a float.
void	setInt(java.lang.String fieldName, int value) Sets the value of the designated field in the Path object as an int.
void	setInt(java.lang.String segmentName, java.lang.String fieldName, int value) Sets the value of the field in the specified segment of this Path object as an int.
void	setLong(java.lang.String fieldName, long value) Sets the value of the designated field in the Path object as a long.
void	setLong(java.lang.String segmentName, java.lang.String fieldName, long value) Sets the value of the field in the specified segment of this Path object as a long.
void	setObject(java.lang.String fieldName, java.lang.Object value) Sets the value of the designated field in the Path object with the Object value.
void	setObject(java.lang.String segmentName, java.lang.String fieldName, java.lang.Object value) Sets the value of the designated field in the Path object with the java.lang.Object value.
void	setShort(java.lang.String fieldName, short value) Sets the value of the designated field in the s Path object as a short.
void	setShort(java.lang.String segmentName, java.lang.String fieldName, short value) Sets the value of the field in the specified segment of this Path object as a short.
void	setString(java.lang.String fieldName, java.lang.String value) Sets the value of the designated field in the Path object as a java.lang.String.
void	setString(java.lang.String segmentName, java.lang.String fieldName, java.lang.String value) Sets the value of the field in the specified segment of this Path object as an java.lang.String.
void	setTime(java.lang.String segmentName, java.lang.String fieldName, java.sql.Time value) Sets the value of the field in the specified segment of this Path object as a java.sql.Time.
void	setTime(java.lang.String fieldName, java.sql.Time value) Sets the value of the designated field in the Path object as a java.sql.Time.
void	setTimestamp(java.lang.String segmentName, java.lang.String fieldName, java.sql.Timestamp value) Sets the value of the field in the specified segment of this Path object as a java.sql.TimeStamp.
void	setTimestamp(java.lang.String fieldName, java.sql.Timestamp value) Sets the value of the designated field in the Path object as a java.sql.TimeStamp.
boolean	wasNull() Reports whether the last field read had a value of NULL.

Method Detail

getName

java.lang.String getName()

Returns the names of the segment(s) contained in this Path as defined by the database metadata. If there is more than one segment, the segment names are delimited with periods.

Note: Can be used when making unqualified DL/I calls with no SSAList to determine what type of segment was returned in order to make the proper getXXX (where 'XXX' is the data type; for example, getString) calls.

The following code fragment shows how the getName method is used.

 String value = null;
 Path path = pcb.getNext(false);
 String name = path.getName(); // returns the name of the segment
 if (name.equals("PATIENT")) {
        value = path.getString("PATNAME");
 } else if (name.equals("DOCTOR")) {
        value = path.getString("DOCNAME");
 }
 

Returns:

names of the segment(s) contained in this Path.

getArray

DBArray getArray(java.lang.String segmentName,
                 java.lang.String fieldName)
          throws DLIException

Retrieves the value of the field in the specified segment of this Path object as a com.ibm.ims.dli.DBArray.

Parameters:

segmentName - name of the segment

fieldName - name of the field

Returns:

value of the field; if the value is NULL, the value returned is false

Throws:

DLIException - if the field or segment name is not found in the current Path because the segment or field does not exist in the database or was not marked for retrieval, or if the field value was not able to be converted into a boolean

See Also:

DBArray

setArray

void setArray(java.lang.String segmentName,
              java.lang.String fieldName,
              DBArray value)
       throws DLIException

Sets the value of the field in the specified segment of this Path object as a com.ibm.ims.dli.DBArray.

Parameters:

segmentName - name of the segment

fieldName - name of the field

value - value of the field

Throws:

DLIException - if the field or segment name is not found in the current Path because the segment or field does not exist in the database or was not marked for retrieval, or if the field value was not able to be converted into a boolean

See Also:

DBArray

getBoolean

boolean getBoolean(java.lang.String segmentName,
                   java.lang.String fieldName)
            throws DLIException

Retrieves the value of the field in the specified segment of this Path object as a boolean.

Parameters:

segmentName - name of the segment

fieldName - name of the field

Returns:

value of the field; if the value is NULL, the value returned is false

Throws:

DLIException - if the field or segment name is not found in the current Path because the segment or field does not exist in the database or was not marked for retrieval, or if the field value was not able to be converted into a boolean

setBoolean

void setBoolean(java.lang.String segmentName,
                java.lang.String fieldName,
                boolean value)
         throws DLIException

Sets the value of the field in the specified segment of this Path object as a boolean.

Parameters:

segmentName - name of the segment

fieldName - name of the field

value - value of the field

Throws:

DLIException - if the field or segment name is not found in the current Path because the segment or field does not exist in the database or was not marked for retrieval, or if the field value was not able to be converted into a boolean

getByte

byte getByte(java.lang.String segmentName,
             java.lang.String fieldName)
      throws DLIException

Retrieves the value of the field in the specified segment of this Path object as a byte.

Parameters:

segmentName - name of the segment

fieldName - name of the field

Returns:

value of the field; if the value is NULL, the value returned is 0

Throws:

DLIException - if the field or segment name is not found in the current Path because the segment or field does not exist in the database or was not marked for retrieval, or if the field value was not able to be converted into a byte

setByte

void setByte(java.lang.String segmentName,
             java.lang.String fieldName,
             byte value)
      throws DLIException

Sets the value of the field in the specified segment of this Path object as a byte.

Parameters:

segmentName - name of the segment

fieldName - name of the field

value - value of the field

Throws:

DLIException - if the field or segment name is not found in the current Path because the segment or field does not exist in the database or was not marked for retrieval, or if the field value was not able to be converted into a byte

getInt

int getInt(java.lang.String segmentName,
           java.lang.String fieldName)
    throws DLIException

Retrieves the value of the field in the specified segment of this Path object as an int.

Parameters:

segmentName - name of the segment

fieldName - name of the field

Returns:

value of the field; if the value is NULL, the value returned is 0

Throws:

DLIException - if the field or segment name is not found in the current Path because the segment or field does not exist in the database or was not marked for retrieval, or if the field value was not able to be converted into an int

setInt

void setInt(java.lang.String segmentName,
            java.lang.String fieldName,
            int value)
     throws DLIException

Sets the value of the field in the specified segment of this Path object as an int.

Parameters:

segmentName - name of the segment

fieldName - name of the field

value - value of the field

Throws:

DLIException - if the field or segment name is not found in the current Path because the segment or field does not exist in the database or was not marked for retrieval, or if the field value was not able to be converted into an int

getShort

short getShort(java.lang.String segmentName,
               java.lang.String fieldName)
        throws DLIException

Retrieves the value of the field in the specified segment of this Path object as a short.

Parameters:

segmentName - name of the segment

fieldName - name of the field

Returns:

value of the field; if the value is NULL, the value returned is 0

Throws:

DLIException - if the field or segment name is not found in the current Path because the segment or field does not exist in the database or was not marked for retrieval, or if the field value was not able to be converted into a short

setShort

void setShort(java.lang.String segmentName,
              java.lang.String fieldName,
              short value)
       throws DLIException

Sets the value of the field in the specified segment of this Path object as a short.

Parameters:

segmentName - name of the segment

fieldName - name of the field

value - value of the field

Throws:

DLIException - if the field or segment name is not found in the current Path because the segment or field does not exist in the database or was not marked for retrieval, or if the field value was not able to be converted into a short

getLong

long getLong(java.lang.String segmentName,
             java.lang.String fieldName)
      throws DLIException

Retrieves the value of the field in the specified segment of this Path object as a long.

Parameters:

segmentName - name of the segment

fieldName - name of the field

Returns:

value of the field; if the value is NULL, the value returned is 0

Throws:

DLIException - if the field or segment name is not found in the current Path because the segment or field does not exist in the database or was not marked for retrieval, or if the field value was not able to be converted into a long

setLong

void setLong(java.lang.String segmentName,
             java.lang.String fieldName,
             long value)
      throws DLIException

Sets the value of the field in the specified segment of this Path object as a long.

Parameters:

segmentName - name of the segment

fieldName - name of the field

value - value of the field

Throws:

DLIException - if the field or segment name is not found in the current Path because the segment or field does not exist in the database or was not marked for retrieval, or if the field value was not able to be converted into a long

getFloat

float getFloat(java.lang.String segmentName,
               java.lang.String fieldName)
        throws DLIException

Retrieves the value of the field in the specified segment of this Path object as a float.

Parameters:

segmentName - name of the segment

fieldName - name of the field

Returns:

value of the field; if the value is NULL, the value returned is 0

Throws:

DLIException - if the field or segment name is not found in the current Path because the segment or field does not exist in the database or was not marked for retrieval, or if the field value was not able to be converted into a float

setFloat

void setFloat(java.lang.String segmentName,
              java.lang.String fieldName,
              float value)
       throws DLIException

Sets the value of the field in the specified segment of this Path object as a float.

Parameters:

segmentName - name of the segment

fieldName - name of the field

value - value of the field

Throws:

DLIException - if the field or segment name is not found in the current Path because the segment or field does not exist in the database or was not marked for retrieval, or if the field value was not able to be converted into a float

getDouble

double getDouble(java.lang.String segmentName,
                 java.lang.String fieldName)
          throws DLIException

Retrieves the value of the field in the specified segment of this Path object as a double.

Parameters:

segmentName - name of the segment

fieldName - name of the field

Returns:

value of the field; if the value is NULL, the value returned is 0

Throws:

DLIException - if the field or segment name is not found in the current Path because the segment or field does not exist in the database or was not marked for retrieval, or if the field value was not able to be converted into a double

setDouble

void setDouble(java.lang.String segmentName,
               java.lang.String fieldName,
               double value)
        throws DLIException

Sets the value of the field in the specified segment of this Path object as a double.

Parameters:

segmentName - name of the segment

fieldName - name of the field

value - value of the field

Throws:

DLIException - if the field or segment name is not found in the current Path because the segment or field does not exist in the database or was not marked for retrieval, or if the field value was not able to be converted into a double

getBytes

byte[] getBytes(java.lang.String segmentName,
                java.lang.String fieldName)
         throws DLIException

Retrieves the value of the designated field in the segment of this Path object as a byte array.

Parameters:

segmentName - name of the segment

fieldName - name of the field

Returns:

value of the field; if the value is NULL, the value returned is null

Throws:

DLIException - if the field or segment name is not found in the current Path because the segment or field does not exist in the database or was not marked for retrieval, or if the field value was not able to be converted into a byte array

setBytes

void setBytes(java.lang.String segmentName,
              java.lang.String fieldName,
              byte[] value)
       throws DLIException

Sets the value of the designated field in the segment of this Path object as a byte array.

Parameters:

segmentName - name of the segment

fieldName - name of the field

value - value of the field

Throws:

DLIException - if the field or segment name is not found in the current Path because the segment or field does not exist in the database or was not marked for retrieval, or if the field value was not able to be converted into a byte array

getString

java.lang.String getString(java.lang.String segmentName,
                           java.lang.String fieldName)
                    throws DLIException

Retrieves the value of the field in the specified segment of this Path object as a java.lang.String.

Parameters:

segmentName - name of the segment

fieldName - name of the field

Returns:

value of the field; if the value is NULL, the value returned is null

Throws:

DLIException - if the field or segment name is not found in the current Path because the segment or field does not exist in the database or was not marked for retrieval, or if the field value was not able to be converted into a java.lang.String.

setString

void setString(java.lang.String segmentName,
               java.lang.String fieldName,
               java.lang.String value)
        throws DLIException

Sets the value of the field in the specified segment of this Path object as an java.lang.String.

Parameters:

segmentName - name of the segment

fieldName - name of the field

value - value of the field

Throws:

DLIException - if the field or segment name is not found in the current Path because the segment or field does not exist in the database or was not marked for retrieval, or if the field value was not able to be converted into a java.lang.String.

getBigDecimal

java.math.BigDecimal getBigDecimal(java.lang.String segmentName,
                                   java.lang.String fieldName)
                            throws DLIException

Retrieves the value of the field in the specified segment of this Path object as a java.math.BigDecimal.

Parameters:

segmentName - name of the segment

fieldName - name of the field

Returns:

value of the field; if the value is NULL, the value returned is null

Throws:

DLIException - if the field or segment name is not found in the current Path because the segment or field does not exist in the database or was not marked for retrieval, or if the field value was not able to be converted into a java.math.BigDecimal.

setBigDecimal

void setBigDecimal(java.lang.String segmentName,
                   java.lang.String fieldName,
                   java.math.BigDecimal value)
            throws DLIException

Sets the value of the designated field in the segment of this Path object as a java.math.BigDecimal.

Parameters:

segmentName - name of the segment

fieldName - name of the field

value - value of the field

Throws:

DLIException - if the field or segment name is not found in the current Path because the segment or field does not exist in the database or was not marked for retrieval, or if the field value was not able to be converted into a java.math.BigDecimal.

getDate

java.sql.Date getDate(java.lang.String segmentName,
                      java.lang.String fieldName)
               throws DLIException

Retrieves the value of the field in the specified segment of this Path object as a java.sql.Date.

Parameters:

segmentName - name of the segment

fieldName - name of the field

Returns:

value of the field; if the value is NULL, the value returned is null

Throws:

DLIException - if the field or segment name is not found in the current Path because the segment or field does not exist in the database or was not marked for retrieval, or if the field value was not able to be converted into a java.sql.Date

setDate

void setDate(java.lang.String segmentName,
             java.lang.String fieldName,
             java.sql.Date value)
      throws DLIException

Sets the value of the field in the specified segment of this Path object as a java.sql.Date.

Parameters:

segmentName - name of the segment

fieldName - name of the field

value - value of the field

Throws:

DLIException - if the field or segment name is not found in the current Path because the segment or field does not exist in the database or was not marked for retrieval, or if the field value was not able to be converted into a java.sql.Date

getTime

java.sql.Time getTime(java.lang.String segmentName,
                      java.lang.String fieldName)
               throws DLIException

Retrieves the value of the field in the specified segment of this Path object as a java.sql.Time.

Parameters:

segmentName - name of the segment

fieldName - name of the field

Returns:

value of the field; if the value is NULL, the value returned is null

Throws:

DLIException - if the field or segment name is not found in the current Path because the segment or field does not exist in the database or was not marked for retrieval, or if the field value was not able to be converted into a java.sql.Time

setTime

void setTime(java.lang.String segmentName,
             java.lang.String fieldName,
             java.sql.Time value)
      throws DLIException

Sets the value of the field in the specified segment of this Path object as a java.sql.Time.

Parameters:

segmentName - name of the segment

fieldName - name of the field

value - value of the field

Throws:

DLIException - if the field or segment name is not found in the current Path because the segment or field does not exist in the database or was not marked for retrieval, or if the field value was not able to be converted into a java.sql.Time

getTimestamp

java.sql.Timestamp getTimestamp(java.lang.String segmentName,
                                java.lang.String fieldName)
                         throws DLIException

Retrieves the value of the field in the specified segment of this Path object as a java.sql.TimeStamp.

Parameters:

segmentName - name of the segment

fieldName - name of the field

Returns:

value of the field; if the value is NULL, the value returned is null

Throws:

DLIException - if the field or segment name is not found in the current Path because the segment or field does not exist in the database or was not marked for retrieval, or if the field value was not able to be converted into a java.sql.TimeStamp

getWarnings

com.ibm.ims.dli.DLIWarning getWarnings()

Retrieves the first warning reported by calls on this Path object. Subsequent warnings on this Path object will be chained to the DLIWarning object that this method returns. The warning chain is automatically cleared each time a new row is read.

Returns:

The first DLIWarning object reported or null if no warning situations occurred.

clearWarnings

void clearWarnings()

Clears all warnings reported on this Path object. After this method is called, the method getWarnings returns null until a new warning is reported for this Path object.

setTimestamp

void setTimestamp(java.lang.String segmentName,
                  java.lang.String fieldName,
                  java.sql.Timestamp value)
           throws DLIException

Sets the value of the field in the specified segment of this Path object as a java.sql.TimeStamp.

Parameters:

segmentName - name of the segment

fieldName - name of the field

value - value of the field

Throws:

DLIException - if the field or segment name is not found in the current Path because the segment or field does not exist in the database or was not marked for retrieval, or if the field value was not able to be converted into a java.sql.TimeStamp

getObject

java.lang.Object getObject(java.lang.String segmentName,
                           java.lang.String fieldName)
                    throws DLIException

Retrieves the value of the designated field in the Path object as a java.lang.Object.
This method will return the value of the given field as a Java object. The type of the Java object will be the default Java object type corresponding to the field's actual type.

Parameters:

segmentName - name of the segment

fieldName - name of the field

Returns:

value of the field; if the value is NULL, the value returned is null

Throws:

DLIException - if the field or segment name is not found in the current Path because the segment or field does not exist in the database or was not marked for retrieval.

setObject

void setObject(java.lang.String segmentName,
               java.lang.String fieldName,
               java.lang.Object value)
        throws DLIException

Sets the value of the designated field in the Path object with the java.lang.Object value.

Parameters:

segmentName - name of the segment

fieldName - name of the field

value - value of the field

Throws:

DLIException - if the field or segment name is not found in the current Path because the segment or field does not exist in the database or was not marked for retrieval.

getArray

DBArray getArray(java.lang.String fieldName)
          throws DLIException

Retrieves the value of the designated field in the Path object as a com.ibm.ims.dli.DBArray.
This method is used when the field name is unique within the Path. Otherwise use the method that has the segment name parameter.

Returns:

value of the field; if the value is NULL, the value returned is false

Throws:

DLIException - if the field or segment name is not found in the current Path because the segment or field does not exist in the database or was not marked for retrieval, or if the field value was not able to be converted into a boolean

See Also:

DBArray

setArray

void setArray(java.lang.String fieldName,
              DBArray value)
       throws DLIException

Sets the value of the designated field in the Path object as a com.ibm.ims.dli.DBArray.
This method is used when the field name is unique within the Path. Otherwise use the method that has the segment name parameter.

Parameters:

fieldName - name of the field

value - value of the field

Throws:

DLIException - if the field or segment name is not found in the current Path because the segment or field does not exist in the database or was not marked for retrieval, or if the field value was not able to be converted into a boolean

See Also:

DBArray

getBoolean

boolean getBoolean(java.lang.String fieldName)
            throws DLIException

Retrieves the value of the designated field in the Path object as a boolean.
This method is used when the field name is unique within the Path. Otherwise use the method that has the segment name parameter.

Returns:

value of the field; if the value is NULL, the value returned is false

Throws:

DLIException - if the field or segment name is not found in the current Path because the segment or field does not exist in the database or was not marked for retrieval, or if the field value was not able to be converted into a boolean

setBoolean

void setBoolean(java.lang.String fieldName,
                boolean value)
         throws DLIException

Sets the value of the designated field in the Path object as a boolean.
This method is used when the field name is unique within the Path. Otherwise use the method that has the segment name parameter.

Parameters:

fieldName - name of the field

value - value of the field

Throws:

DLIException - if the field or segment name is not found in the current Path because the segment or field does not exist in the database or was not marked for retrieval, or if the field value was not able to be converted into a boolean

getByte

byte getByte(java.lang.String fieldName)
      throws DLIException

Retrieves the value of the designated field in the segment of this Path object as a byte.
This method is used when the field name is unique within the Path. Otherwise use the method that has the segment name parameter.

Returns:

value of the field; if the value is NULL, the value returned is 0

Throws:

DLIException - if the field or segment name is not found in the current Path because the segment or field does not exist in the database or was not marked for retrieval, or if the field value was not able to be converted into a byte

setByte

void setByte(java.lang.String fieldName,
             byte value)
      throws DLIException

Sets the value of the designated field in the segment of this Path object as a byte.
This method is used when the field name is unique within the Path. Otherwise use the method that has the segment name parameter.

Parameters:

fieldName - name of the field

value - value of the field

Throws:

DLIException - if the field or segment name is not found in the current Path because the segment or field does not exist in the database or was not marked for retrieval, or if the field value was not able to be converted into a byte

getInt

int getInt(java.lang.String fieldName)
    throws DLIException

Retrieves the value of the designated field in the segment of this Path object as an int.
This method is used when the field name is unique within the Path. Otherwise use the method that has the segment name parameter.

Returns:

value of the field; if the value is NULL, the value returned is 0

Throws:

DLIException - if the field or segment name is not found in the current Path because the segment or field does not exist in the database or was not marked for retrieval, or if the field value was not able to be converted into an int

setInt

void setInt(java.lang.String fieldName,
            int value)
     throws DLIException

Sets the value of the designated field in the Path object as an int.
This method is used when the field name is unique within the Path. Otherwise use the method that has the segment name parameter.

Parameters:

fieldName - name of the field

value - value of the field

Throws:

DLIException - if the field or segment name is not found in the current Path because the segment or field does not exist in the database or was not marked for retrieval, or if the field value was not able to be converted into a int

getShort

short getShort(java.lang.String fieldName)
        throws DLIException

Retrieves the value of the designated field in the Path object as a short.
This method is used when the field name is unique within the Path. Otherwise use the method that has the segment name parameter.

Returns:

value of the field; if the value is NULL, the value returned is 0

Throws:

DLIException - if the field or segment name is not found in the current Path because the segment or field does not exist in the database or was not marked for retrieval, or if the field value was not able to be converted into a short

setShort

void setShort(java.lang.String fieldName,
              short value)
       throws DLIException

Sets the value of the designated field in the s Path object as a short.
This method is used when the field name is unique within the Path. Otherwise use the method that has the segment name parameter.

Parameters:

fieldName - name of the field

value - value of the field

Throws:

DLIException - if the field or segment name is not found in the current Path because the segment or field does not exist in the database or was not marked for retrieval, or if the field value was not able to be converted into a short

getLong

long getLong(java.lang.String fieldName)
      throws DLIException

Retrieves the value of the designated field in the Path object as a long.
This method is used when the field name is unique within the Path. Otherwise use the method that has the segment name parameter.

Returns:

value of the field; if the value is NULL, the value returned is 0

Throws:

DLIException - if the field name is not found in the database or if the field value was not able to be converted into a long

setLong

void setLong(java.lang.String fieldName,
             long value)
      throws DLIException

Sets the value of the designated field in the Path object as a long.
This method is used when the field name is unique within the Path. Otherwise use the method that has the segment name parameter.

Parameters:

fieldName - name of the field

value - value of the field

Throws:

DLIException - if the field or segment name is not found in the current Path because the segment or field does not exist in the database or was not marked for retrieval, or if the field value was not able to be converted into a long

getFloat

float getFloat(java.lang.String fieldName)
        throws DLIException

Retrieves the value of the designated field in the Path object as a float.
This method is used when the field name is unique within the Path. Otherwise use the method that has the segment name parameter.

Returns:

value of the field; if the value is NULL, the value returned is 0

Throws:

DLIException - if the field or segment name is not found in the current Path because the segment or field does not exist in the database or was not marked for retrieval, or if the field value was not able to be converted into a float

setFloat

void setFloat(java.lang.String fieldName,
              float value)
       throws DLIException

Sets the value of the designated field in the Path object as a float.
This method is used when the field name is unique within the Path. Otherwise use the method that has the segment name parameter.

Parameters:

fieldName - name of the field

value - value of the field

Throws:

DLIException - if the field or segment name is not found in the current Path because the segment or field does not exist in the database or was not marked for retrieval, or if the field value was not able to be converted into a float

getDouble

double getDouble(java.lang.String fieldName)
          throws DLIException

Retrieves the value of the designated field in the Path object as a double.
This method is used when the field name is unique within the Path. Otherwise use the method that has the segment name parameter.

Returns:

value of the field; if the value is NULL, the value returned is 0

Throws:

DLIException - if the field or segment name is not found in the current Path because the segment or field does not exist in the database or was not marked for retrieval, or if the field value was not able to be converted into a double

setDouble

void setDouble(java.lang.String fieldName,
               double value)
        throws DLIException

Sets the value of the designated field in the Path object as a double .
This method is used when the field name is unique within the Path. Otherwise use the method that has the segment name parameter.

Parameters:

fieldName - name of the field

value - value of the field

Throws:

DLIException - if the field or segment name is not found in the current Path because the segment or field does not exist in the database or was not marked for retrieval, or if the field value was not able to be converted into a double

getBytes

byte[] getBytes(java.lang.String fieldName)
         throws DLIException

Gets the value of the designated field in the Path object as a byte array.
This method is used when the field name is unique within the Path. Otherwise use the method that has the segment name parameter.

Returns:

value of the field; if the value is NULL, the value returned is null

Throws:

DLIException - if the field or segment name is not found in the current Path because the segment or field does not exist in the database or was not marked for retrieval, or if the field value was not able to be converted into a byte array

setBytes

void setBytes(java.lang.String fieldName,
              byte[] value)
       throws DLIException

Sets the value of the designated field in the Path object as a byte array.
This method is used when the field name is unique within the Path. Otherwise use the method that has the segment name parameter.

Parameters:

fieldName - name of the field

value - value of the field

Throws:

DLIException - if the field or segment name is not found in the current Path because the segment or field does not exist in the database or was not marked for retrieval, or if the field value was not able to be converted into a byte array

getString

java.lang.String getString(java.lang.String fieldName)
                    throws DLIException

Gets the value of the designated field in the Path object as a java.lang.String.
This method is used when the field name is unique within the Path. Otherwise use the method that has the segment name parameter.

Returns:

value of the field; if the value is NULL, the value returned is null

Throws:

DLIException - if the field or segment name is not found in the current Path because the segment or field does not exist in the database or was not marked for retrieval, or if the field value was not able to be converted into a java.lang.String.

setString

void setString(java.lang.String fieldName,
               java.lang.String value)
        throws DLIException

Sets the value of the designated field in the Path object as a java.lang.String.
This method is used when the field name is unique within the Path. Otherwise use the method that has the segment name parameter.

Parameters:

fieldName - name of the field

value - value of the field

Throws:

DLIException - if the field or segment name is not found in the current Path because the segment or field does not exist in the database or was not marked for retrieval, or if the field value was not able to be converted into a java.lang.String.

getBigDecimal

java.math.BigDecimal getBigDecimal(java.lang.String fieldName)
                            throws DLIException

Retrieves the value of the designated field in the Path object as a java.math.BigDecimal.
This method is used when the field name is unique within the Path. Otherwise use the method that has the segment name parameter.

Returns:

value of the field; if the value is NULL, the value returned is null

Throws:

DLIException - if the field or segment name is not found in the current Path because the segment or field does not exist in the database or was not marked for retrieval, or if the field value was not able to be converted into a java.math.BigDecimal

setBigDecimal

void setBigDecimal(java.lang.String fieldName,
                   java.math.BigDecimal value)
            throws DLIException

Sets the value of the field in the Path object as a java.math.BigDecimal.
This method is used when the field name is unique within the Path. Otherwise use the method that has the segment name parameter.

Parameters:

fieldName - name of the field

value - value of the field

Throws:

DLIException - if the field or segment name is not found in the current Path because the segment or field does not exist in the database or was not marked for retrieval, or if the field value was not able to be converted into a java.math.BigDecimal

getDate

java.sql.Date getDate(java.lang.String fieldName)
               throws DLIException

Sets the value of the designated field in the Path object as a java.sql.Date.
This method is used when the field name is unique within the Path. Otherwise use the method that has the segment name parameter.

Returns:

value of the field; if the value is NULL, the value returned is null

Throws:

DLIException - if the field or segment name is not found in the current Path because the segment or field does not exist in the database or was not marked for retrieval, or if the field value was not able to be converted into a java.sql.Date

setDate

void setDate(java.lang.String fieldName,
             java.sql.Date value)
      throws DLIException

Sets the value of the designated field in the Path object as a java.sql.Date.
This method is used when the field name is unique within the Path. Otherwise use the method that has the segment name parameter.

Parameters:

fieldName - name of the field

value - value of the field

Throws:

DLIException - if the field or segment name is not found in the current Path because the segment or field does not exist in the database or was not marked for retrieval, or if the field value was not able to be converted into a java.sql.Date

getTime

java.sql.Time getTime(java.lang.String fieldName)
               throws DLIException

Sets the value of the designated field in the Path object as a java.sql.Time.
This method is used when the field name is unique within the Path. Otherwise use the method that has the segment name parameter.

Returns:

value of the field; if the value is NULL, the value returned is null

Throws:

DLIException - if the field or segment name is not found in the current Path because the segment or field does not exist in the database or was not marked for retrieval, or if the field value was not able to be converted into a java.sql.Time

setTime

void setTime(java.lang.String fieldName,
             java.sql.Time value)
      throws DLIException

Sets the value of the designated field in the Path object as a java.sql.Time.
This method is used when the field name is unique within the Path. Otherwise use the method that has the segment name parameter.

Parameters:

fieldName - name of the field

value - value of the field

Throws:

DLIException - if the field or segment name is not found in the current Path because the segment or field does not exist in the database or was not marked for retrieval, or if the field value was not able to be converted into a java.sql.Time

getTimestamp

java.sql.Timestamp getTimestamp(java.lang.String fieldName)
                         throws DLIException

Sets the value of the designated field in the Path object as a java.sql.TimeStamp.
This method is used when the field name is unique within the Path. Otherwise use the method that has the segment name parameter.

Returns:

value of the field; if the value is NULL, the value returned is null

Throws:

DLIException - if the field or segment name is not found in the current Path because the segment or field does not exist in the database or was not marked for retrieval, or if the field value was not able to be converted into a java.sql.TimeStamp

setTimestamp

void setTimestamp(java.lang.String fieldName,
                  java.sql.Timestamp value)
           throws DLIException

Sets the value of the designated field in the Path object as a java.sql.TimeStamp.
This method is used when the field name is unique within the Path. Otherwise use the method that has the segment name parameter.

Parameters:

fieldName - name of the field

value - value of the field

Throws:

DLIException - if the field or segment name is not found in the current Path because the segment or field does not exist in the database or was not marked for retrieval, or if the field value was not able to be converted into a java.sql.TimeStamp.

getObject

java.lang.Object getObject(java.lang.String fieldName)
                    throws DLIException

Retrieves the value of the designated field in the Path object as an Object in the Java Programming Language.
This method will return the value of the given field as a Java object. The type of the Java object will be the default Java object type corresponding to the field's actual type.
This method is used when the field name is unique within the Path. Otherwise use the method that has the segment name parameter.

Returns:

value of the field; if the value is NULL, the value returned is null

Throws:

DLIException - if the field or segment name is not found in the current Path because the segment or field does not exist in the database or was not marked for retrieval, or if the field value was not able to be converted into a java.math.BigDecimal

setObject

void setObject(java.lang.String fieldName,
               java.lang.Object value)
        throws DLIException

Sets the value of the designated field in the Path object with the Object value.
This method is used when the field name is unique within the Path. Otherwise use the method that has the segment name parameter.

Parameters:

fieldName - name of the field

value - value of the field

Throws:

DLIException - if the field or segment name is not found in the current Path because the segment or field does not exist in the database or was not marked for retrieval, or if the field value could not be converted into a java.sql.TimeStamp.

getAIB

AIB getAIB()

Returns the AIB (Application Interface Block) associated with the most recent DL/I call.

Returns:

the AIB

wasNull

boolean wasNull()

Reports whether the last field read had a value of NULL. You must first call one of the getter methods on a field to try to read its value before you call this method to see if the value read was NULL.

Returns:

true if the last column value read was NULL and false otherwise

getFields

java.util.Hashtable<java.lang.String,java.util.Vector<java.lang.String>> getFields()

Returns a collection of fields in this path. The key is the name of a segment and the values are a Vector of fields names in that segment.

Returns:

the collection if this Path contains fields (e,g,; was used to retrieve fields) and null otherwise

getMetaData

PathMetaData getMetaData()
                  throws DLIException

Retrieves the number, types and properties of the fields of this Path object.

Returns:

the description of the fields of this Path object

Throws:

DLIException - if a processing error occurs