com.mapquest
Class RecordSet

java.lang.Object
  com.mapquest.MQObject
      com.mapquest.RecordSet

All Implemented Interfaces:

java.lang.Cloneable

public class RecordSet

extends MQObject

Class for retrieving record attribute information.

See Also:

StringCollection

Field Summary

static int	CLASS_ID
static java.lang.String	CLASS_NAME

Fields inherited from class com.mapquest.MQObject

DEFAULT_ID, DEFAULT_NAME, DEFAULT_VERSION, FORMAT_NUMERIC_ID, FORMAT_TEXT_NAME, INVALID_ID, INVALID_NAME, INVALID_VERSION

Constructor Summary

RecordSet()
Constructor

Method Summary

boolean	equals(java.lang.Object otherObject) Compares this object to the specified object.
int	getClassId() Returns the numeric id of this class.
java.lang.String	getClassName() Returns the text name of this class.
java.lang.String	getField(java.lang.String strFieldName) Get the field value by field name
StringCollection	getFieldNames() Get the list of available field names
int	hashCode() Returns a hash code for this RecordSet.
void	init() Initializes object.
boolean	isBOF() Set to true when the cursor is before the beginning of the record set
boolean	isEOF() Set to true when the cursor is passed the end of the record set
void	moveFirst() Sets the cursor to the first record in the record set.
void	moveLast() Sets the cursor to the last record in the record set.
void	moveNext() Sets the cursor to the next record in the record set.

Methods inherited from class com.mapquest.MQObject

clone, getFormat, getIdWithVersion, getNameWithVersion, getObjectVersion, getTypeId, getTypeName, getVerboseConsoleOutput, setFormat, setObjectVersion, setVerboseConsoleOutput, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

CLASS_ID

public static final int CLASS_ID

See Also:

Constant Field Values

CLASS_NAME

public static final java.lang.String CLASS_NAME

See Also:

Constant Field Values

Constructor Detail

RecordSet

public RecordSet()

Constructor

Method Detail

init

public void init()

Initializes object.

Overrides:

init in class MQObject

getClassId

public int getClassId()

Returns the numeric id of this class.

Overrides:

getClassId in class MQObject

Returns:

the numeric id of this class.

getClassName

public java.lang.String getClassName()

Returns the text name of this class.

Overrides:

getClassName in class MQObject

Returns:

the text name of this class.

moveFirst

public void moveFirst()
               throws java.lang.Exception

Sets the cursor to the first record in the record set.

Throws:

java.lang.Exception

moveLast

public void moveLast()
              throws java.lang.Exception

Sets the cursor to the last record in the record set.

Throws:

java.lang.Exception

moveNext

public void moveNext()
              throws java.lang.Exception

Sets the cursor to the next record in the record set. If the cursor is currently set to the last record, A call to MoveNext sets EOF to true

Throws:

java.lang.Exception

isEOF

public boolean isEOF()

Set to true when the cursor is passed the end of the record set

Returns:

end record set flag

isBOF

public boolean isBOF()

Set to true when the cursor is before the beginning of the record set

Returns:

beginning record set flag

getFieldNames

public StringCollection getFieldNames()

Get the list of available field names

Returns:

the list of field names

getField

public java.lang.String getField(java.lang.String strFieldName)
                          throws java.lang.Exception

Get the field value by field name

Parameters:

strFieldName - the field name

Throws:

java.lang.Exception

equals

public boolean equals(java.lang.Object otherObject)

Compares this object to the specified object. The result is true if and only if the argument is not null and is a RecordSet object that has same attributes as this object.

Overrides:

equals in class MQObject

Parameters:

otherObject - the object to compare this RecordSet against.

Returns:

true if the RecordSet objects are equal; false otherwise.

hashCode

public int hashCode()

Returns a hash code for this RecordSet.

Overrides:

hashCode in class MQObject

Returns:

a hash code value for this RecordSet.