|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectasjava.uniclientlibs.UniDataSet
Field Summary | |
---|---|
protected int |
formatType
|
protected java.util.Vector |
rowSet
|
Constructor Summary | |
---|---|
UniDataSet()
A UniDataSet object is a collection object. |
|
UniDataSet(java.lang.Object initVal)
A UniDataSet object is a collection object. |
|
UniDataSet(java.lang.Object initVal,
java.lang.String delimiter)
A UniDataSet object is a collection object. |
|
UniDataSet(UniDataSet origSet,
java.lang.Object newSet,
java.lang.Object retSet,
java.lang.Object statSet,
int returnCode,
java.lang.String delimiter)
A UniDataSet object is a collection object. |
Method Summary | |
---|---|
boolean |
absolute(int rowNum)
specifies the absolute position within the UniDataSet that the cursor
should point to |
void |
afterLast()
moves the internal UniDataSet cursor to point to the end of the data set. |
boolean |
append(java.lang.Object rowID)
appends a new data element at the end of the existing data set |
boolean |
append(java.lang.Object rowID,
java.lang.Object rowData)
appends a new data element at the end of the existing data set |
boolean |
append(UniRecord recordSet)
appends a new data element at the end of the existing data set |
void |
close()
closes the dataset, resetting internal values to their initial state |
boolean |
deleteRow()
deletes the current row from the dataset |
boolean |
deleteRow(int indexLoc)
deletes the indexLoc row from the dataset |
boolean |
deleteRow(java.lang.String recordID)
deletes the row referenced by the recordID specified. |
int |
findRow(java.lang.String aRowVal)
identifies the cursor position of a given row, based on the recordID passed in. |
void |
first()
moves the internal UniDataSet cursor to point to the beginning of the data set. |
int |
getCurrentRow()
returns the current cursor position within the dataset. |
java.lang.String |
getDataSet()
returns the data contained in the dataset as a @IM separated String |
java.lang.String |
getIDSet()
returns the IDs contained in the dataset as a @IM separated String |
int |
getRowCount()
returns the dataset size |
java.lang.String |
getString()
returns the dataset row represented by currentRow as a String |
java.lang.String |
getString(int columnIndex)
returns the dataset row represented by columnIndex as a String |
java.lang.String |
getString(java.lang.String columnName)
returns the dataset row represented by columnName as a String |
UniDynArray |
getUniDynArray()
Extracts the row currently pointed to by the cursor position and returns it as a UniDynArray
object |
UniDynArray |
getUniDynArray(int indexLoc)
Extracts the row referenced by indexLoc and returns it as a UniDynArray
object |
UniDynArray |
getUniDynArray(java.lang.String columnName)
Extracts the row referenced by columnName and returns it as a UniDynArray
object |
UniRecord |
getUniRecord()
Extracts the row currently pointed to by the cursor position and returns it as a UniRecord
object |
UniRecord |
getUniRecord(int indexLoc)
Extracts the row currently pointed to by the cursor position and returns it as a getUniRecord
object |
UniRecord |
getUniRecord(java.lang.String columnName)
Extracts the row currently pointed to by the cursor name and returns it as a getUniRecord
object |
UniString |
getUniString()
Extracts the row currently pointed to by the cursor position and returns it as a UniString
object |
UniString |
getUniString(int indexLoc)
Extracts the row currently pointed to by the cursor position and returns it as a UniString
object |
UniString |
getUniString(java.lang.String columnName)
Extracts the row currently pointed to by the cursor position and returns it as a UniString
object |
boolean |
insert(int indexLoc,
java.lang.Object rowID)
inserts a new row into the dataset, inserting the row at the given cursor position |
boolean |
insert(int indexLoc,
java.lang.Object rowID,
java.lang.Object rowVal)
inserts a new row into the dataset, inserting the row at the given cursor position |
boolean |
insert(int indexLoc,
UniRecord recordSet)
inserts a new row into the dataset, inserting the row at the current cursor position |
boolean |
insert(java.lang.Object rowVal)
inserts a new row into the dataset, inserting the row at the current cursor position. |
boolean |
insert(java.lang.Object rowID,
java.lang.Object rowVal)
inserts a new row into the dataset, inserting the row at the current cursor position |
boolean |
insert(UniRecord recordSet)
inserts a new row into the dataset, inserting the row at the current cursor position |
boolean |
isAfterLast()
determines whether or not cursor is positioned past the last row in the dataset. |
boolean |
isBeforeFirst()
determines whether or not cursor is positioned before the first row in the dataset. |
boolean |
isFirst()
determines whether or not cursor is positioned at the first row in the dataset. |
boolean |
isLast()
determines whether or not cursor is positioned at the last row in the dataset. |
void |
last()
sets the cursor to the last row in the dataset |
boolean |
next()
increments the dataset cursor by one. |
boolean |
previous()
decrements the dataset cursor by one. |
boolean |
relative(int numRows)
positions the dataset cursor to a position numRows away from the current position. |
boolean |
setIndex(int indexLoc)
sets the cursor position to the indexLoc value referenced. |
java.lang.String |
toString()
Converts the dataset into it's String representation. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
protected int formatType
protected java.util.Vector rowSet
Constructor Detail |
public UniDataSet()
UniRecord
objects, which can then be used to perform bulk or batch style operations
with one network operation.
public UniDataSet(java.lang.Object initVal)
UniRecord
objects, which can then be used to perform bulk or batch style operations
with one network operation.
initVal
- string representing the initial recordIDs to be stored in the dataset, which are
separated by the UniTokens.AT_FM characterpublic UniDataSet(java.lang.Object initVal, java.lang.String delimiter)
UniRecord
objects, which can then be used to perform bulk or batch style operations
with one network operation.
initVal
- string representing the initial recordIDs to be stored in the datasetdelimiter
- string representing the delimiter to use to separate the recordID stringpublic UniDataSet(UniDataSet origSet, java.lang.Object newSet, java.lang.Object retSet, java.lang.Object statSet, int returnCode, java.lang.String delimiter)
UniRecord
objects, which can then be used to perform bulk or batch style operations
with one network operation. *FOR INTERNAL USE ONLY*
origSet
- UniDataSet object containing the recordIDs that will be copied into the new
dataset objectnewSet
- delimited string containing the data for the new collectionretSet
- delimited string containing the return values for the new collectionstatSet
- delimited string containing the status values for the new collectionreturnCode
- integer representing the overall dataset statusdelimiter
- string representing the delimiter to use to separate the stringsMethod Detail |
public boolean absolute(int rowNum)
UniDataSet
that the cursor
should point to
rowNum
- integer which specifies the absolute position within the UniDataSet
relative(int)
public void afterLast()
UniDataSet
cursor to point to the end of the data set.
isBeforeFirst()
public boolean append(java.lang.Object rowID)
rowID
- Object that specifies the data to be added
public boolean append(java.lang.Object rowID, java.lang.Object rowData)
rowID
- object that identifies the data addedrowData
- object that specifies the data to be added
public boolean append(UniRecord recordSet)
recordSet
- UniRecord object that specifies the data to be added
public void close()
public boolean deleteRow()
public boolean deleteRow(int indexLoc)
indexLoc
row from the dataset
indexLoc
- integer repesenting which row to be deleted
public boolean deleteRow(java.lang.String recordID)
false
recordID
- integer repesenting which row to be deleted
public int findRow(java.lang.String aRowVal)
aRowVal
- name of the field to reference
public void first()
UniDataSet
cursor to point to the beginning of the data set.
isBeforeFirst()
public int getCurrentRow()
public java.lang.String getDataSet()
public java.lang.String getIDSet()
public java.lang.String getString()
currentRow
as a String
public java.lang.String getString(int columnIndex)
columnIndex
as a String
columnIndex
- integer representing which dataset row to retrieve
public java.lang.String getString(java.lang.String columnName)
columnName
as a String
columnName
- String representing the recordID to be retrieved.
public UniDynArray getUniDynArray()
UniDynArray
object
public UniDynArray getUniDynArray(int indexLoc)
indexLoc
and returns it as a UniDynArray
object
indexLoc
- integer representing the cursor row to return
public UniDynArray getUniDynArray(java.lang.String columnName)
columnName
and returns it as a UniDynArray
object
columnName
- string representing the record ID of the row to return
public UniRecord getUniRecord()
UniRecord
object
public UniRecord getUniRecord(int indexLoc)
getUniRecord
object
public UniRecord getUniRecord(java.lang.String columnName)
getUniRecord
object
public UniString getUniString()
UniString
object
public UniString getUniString(int indexLoc)
UniString
object
indexLoc
- integer representing the cursor row to return
public UniString getUniString(java.lang.String columnName)
UniString
object
columnName
- String representing the record ID of the cursor row to return
public int getRowCount()
public boolean insert(java.lang.Object rowVal)
rowVal
- the rowID of the row being inserted
public boolean insert(int indexLoc, java.lang.Object rowID)
indexLoc
- the location where the row should be insertedrowID
- the rowID of the row being inserted
public boolean insert(java.lang.Object rowID, java.lang.Object rowVal)
rowID
- the recordID of this rowrowVal
- the data value of this row
public boolean insert(int indexLoc, java.lang.Object rowID, java.lang.Object rowVal)
indexLoc
- location in the dataset to insert this rowrowID
- the recordID of this rowrowVal
- the data value of this row
public boolean insert(UniRecord recordSet)
recordSet
- UniRecord representing the entire row to be inserted
public boolean insert(int indexLoc, UniRecord recordSet)
indexLoc
- the location where the row should be insertedrecordSet
- UniRecord representing the entire row to be inserted
public boolean isAfterLast()
public boolean isBeforeFirst()
public boolean isFirst()
public boolean isLast()
public void last()
public boolean next()
public boolean previous()
public boolean relative(int numRows)
numRows
away from the current position. For
example, if the cursor is already set to the third row, and UniDataSet.relative( 5 ) is referenced,
it will set the cursor to the eighth position within the set. If an operation is successful, it
returns a true
. If the operation attempts to move the cursor past the end or before
the beginning, the cursor will be set to the last row or first row respectively and the operation
will return false
.
numRows
- integer representing the number of rows the cursor should be moved
public boolean setIndex(int indexLoc)
indexLoc
value referenced. Returns true
false if the operation attempted to position the
cursor outside the dataset
indexLoc
- the index location to be used for the dataset.
public java.lang.String toString()
String
representation. It will add a UniVerse @IM mark
inbetween each row of the dataset.
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |