com.cordys.cpc.bsf.query

Class Cursor

java.lang.Object

com.cordys.cpc.bsf.query.Cursor

public class Cursor
extends java.lang.Object

This class encapsulates the Cursor object required in Database operations. The cursor contains information regarding the number of rows to be fetched each time, the current position of the cursor and also the maximum number of rows that can be fetched from the cursor.

Author:

hbank

Constructor Summary

Constructors

Constructor and Description
Cursor(Document doc) Creates a new instance of Cursor
Cursor(int cursorNode) Creates a new instance of Cursor

Method Summary

Modifier and Type	Method and Description
java.lang.String	getId() Returns the identifier of this Cursor object as specified in "id" attribute.
int	getMaxRows() Returns the maximum number of rows that can be fetched by this Cursor object.
int	getNumRows() Returns the number of rows that will be fetched by this Cursor object.
int	getPosition() Returns the current position of this Cursor as specified in "position" attribute
java.lang.String	getXmlString() Returns the string for this Cusror object.
void	setId(java.lang.String id) Sets the id of Cursor object.
void	setMaxRows(int maxRows) Set the max number of rows to be fetched by this Cursor object each time.
void	setNumRows(int numRows) Set the number of rows to be fetched by this Cursor object each time.
void	setPosition(int position) Set the position of the Cursor.
void	setSameConnection(boolean useSameConnection) Sets value indicating if the same connection should be used or not
void	updateCursorData(int newCursorData) Updates the cursor data with the given nom handle to the cursor details
boolean	useSameConnection() Returns boolean value indicating if the same connection should be used or not

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Cursor

public Cursor(int cursorNode)

Creates a new instance of Cursor

Parameters:

cursorNode - The nom integer that represents the cursor node in <cursor numRows="5" id="10" position="20" maxRows="1000"/> format This responsibility of deleting this XML node lies with the calling program

Cursor

public Cursor(Document doc)

Creates a new instance of Cursor

Parameters:

doc - Document object

Method Detail

getNumRows

public int getNumRows()

Returns the number of rows that will be fetched by this Cursor object.

Returns:

No of rows

getMaxRows

public int getMaxRows()

Returns the maximum number of rows that can be fetched by this Cursor object.

Returns:

Maximum number of rows

getId

public java.lang.String getId()

Returns the identifier of this Cursor object as specified in "id" attribute.

Returns:

ID

getPosition

public int getPosition()

Returns the current position of this Cursor as specified in "position" attribute

Returns:

The position

useSameConnection

public boolean useSameConnection()

Returns boolean value indicating if the same connection should be used or not

Returns:

The boolean value of 'sameConnection' attribute

setSameConnection

public void setSameConnection(boolean useSameConnection)

Sets value indicating if the same connection should be used or not

setNumRows

public void setNumRows(int numRows)

Set the number of rows to be fetched by this Cursor object each time.

Parameters:

numRows -

setMaxRows

public void setMaxRows(int maxRows)

Set the max number of rows to be fetched by this Cursor object each time.

Parameters:

maxRows -

setId

public void setId(java.lang.String id)

Sets the id of Cursor object.

Parameters:

id -

setPosition

public void setPosition(int position)

Set the position of the Cursor. This position will be taken as the starting point for the next fetch.

Parameters:

position -

updateCursorData

public void updateCursorData(int newCursorData)

Updates the cursor data with the given nom handle to the cursor details

Parameters:

newCursorData -

getXmlString

public java.lang.String getXmlString()

Returns the string for this Cusror object.

Returns:

the string representation of this cursor object