All Packages Class Hierarchy This Package Previous Next Index
Class asjava.uniclientlibs.UniDataSet
java.lang.Object
|
+----asjava.uniclientlibs.UniDataSet
- public class UniDataSet
- extends Object
- implements Serializable
-
formatType
-
-
rowSet
-
-
UniDataSet()
- A UniDataSet object is a collection object.
-
UniDataSet(Object)
- A UniDataSet object is a collection object.
-
UniDataSet(Object, String)
- A UniDataSet object is a collection object.
-
UniDataSet(UniDataSet, Object, Object, Object, int, String)
- A UniDataSet object is a collection object.
-
absolute(int)
- specifies the absolute position within the
UniDataSet
that the cursor
should point to
-
afterLast()
- moves the internal
UniDataSet
cursor to point to the end of the data set.
-
append(Object)
- appends a new data element at the end of the existing data set
-
append(Object, Object)
- appends a new data element at the end of the existing data set
-
append(UniRecord)
- appends a new data element at the end of the existing data set
-
close()
- closes the dataset, resetting internal values to their initial state
-
deleteRow()
- deletes the current row from the dataset
-
deleteRow(int)
- deletes the
indexLoc
row from the dataset
-
deleteRow(String)
- deletes the row referenced by the recordID specified.
-
findRow(String)
- identifies the cursor position of a given row, based on the recordID passed in.
-
first()
- moves the internal
UniDataSet
cursor to point to the beginning of the data set.
-
getCurrentRow()
- returns the current cursor position within the dataset.
-
getDataSet()
- returns the data contained in the dataset as a
-
getIDSet()
- returns the IDs contained in the dataset as a
-
getRowCount()
- returns the dataset size
-
getString()
- returns the dataset row represented by
currentRow
as a String
-
getString(int)
- returns the dataset row represented by
columnIndex
as a String
-
getString(String)
- returns the dataset row represented by
columnName
as a String
-
getUniDynArray()
- Extracts the row currently pointed to by the cursor position and returns it as a
UniDynArray
object
-
getUniDynArray(int)
- Extracts the row referenced by
indexLoc
and returns it as a UniDynArray
object
-
getUniDynArray(String)
- Extracts the row referenced by
columnName
and returns it as a UniDynArray
object
-
getUniRecord()
- Extracts the row currently pointed to by the cursor position and returns it as a
UniRecord
object
-
getUniRecord(int)
- Extracts the row currently pointed to by the cursor position and returns it as a
getUniRecord
object
-
getUniRecord(String)
- Extracts the row currently pointed to by the cursor name and returns it as a
getUniRecord
object
-
getUniString()
- Extracts the row currently pointed to by the cursor position and returns it as a
UniString
object
-
getUniString(int)
- Extracts the row currently pointed to by the cursor position and returns it as a
UniString
object
-
getUniString(String)
- Extracts the row currently pointed to by the cursor position and returns it as a
UniString
object
-
insert(int, Object)
- inserts a new row into the dataset, inserting the row at the given cursor position
-
insert(int, Object, Object)
- inserts a new row into the dataset, inserting the row at the given cursor position
-
insert(int, UniRecord)
- inserts a new row into the dataset, inserting the row at the current cursor position
-
insert(Object)
- inserts a new row into the dataset, inserting the row at the current cursor position.
-
insert(Object, Object)
- inserts a new row into the dataset, inserting the row at the current cursor position
-
insert(UniRecord)
- inserts a new row into the dataset, inserting the row at the current cursor position
-
isAfterLast()
- determines whether or not cursor is positioned past the last row in the dataset.
-
isBeforeFirst()
- determines whether or not cursor is positioned before the first row in the dataset.
-
isFirst()
- determines whether or not cursor is positioned at the first row in the dataset.
-
isLast()
- determines whether or not cursor is positioned at the last row in the dataset.
-
last()
- sets the cursor to the last row in the dataset
-
next()
- increments the dataset cursor by one.
-
previous()
- decrements the dataset cursor by one.
-
relative(int)
- positions the dataset cursor to a position
numRows
away from the current position.
-
setIndex(int)
- sets the cursor position to the
indexLoc
value referenced.
-
toString()
- Converts the dataset into it's
String
representation.
formatType
protected int formatType
rowSet
protected Vector rowSet
UniDataSet
public UniDataSet()
- A UniDataSet object is a collection object. It provides a collection interface for sets of
UniRecord
objects, which can then be used to perform bulk or batch style operations
with one network operation.
UniDataSet
public UniDataSet(Object initVal)
- A UniDataSet object is a collection object. It provides a collection interface for sets of
UniRecord
objects, which can then be used to perform bulk or batch style operations
with one network operation.
- Parameters:
- initVal - string representing the initial recordIDs to be stored in the dataset, which are
separated by the UniTokens.AT_FM character
UniDataSet
public UniDataSet(Object initVal,
String delimiter)
- A UniDataSet object is a collection object. It provides a collection interface for sets of
UniRecord
objects, which can then be used to perform bulk or batch style operations
with one network operation.
- Parameters:
- initVal - string representing the initial recordIDs to be stored in the dataset
- delimiter - string representing the delimiter to use to separate the recordID string
UniDataSet
public UniDataSet(UniDataSet origSet,
Object newSet,
Object retSet,
Object statSet,
int returnCode,
String delimiter)
- A UniDataSet object is a collection object. It provides a collection interface for sets of
UniRecord
objects, which can then be used to perform bulk or batch style operations
with one network operation. *FOR INTERNAL USE ONLY*
- Parameters:
- origSet - UniDataSet object containing the recordIDs that will be copied into the new
dataset object
- newSet - delimited string containing the data for the new collection
- retSet - delimited string containing the return values for the new collection
- statSet - delimited string containing the status values for the new collection
- returnCode - integer representing the overall dataset status
- delimiter - string representing the delimiter to use to separate the strings
absolute
public boolean absolute(int rowNum)
- specifies the absolute position within the
UniDataSet
that the cursor
should point to
- Parameters:
- rowNum - integer which specifies the absolute position within the UniDataSet
- Returns:
- boolean specifying whether the operation was successful.
- See Also:
- relative
afterLast
public void afterLast()
- moves the internal
UniDataSet
cursor to point to the end of the data set.
- See Also:
- beforeFirst
append
public boolean append(Object rowID)
- appends a new data element at the end of the existing data set
- Parameters:
- rowData - Object that specifies the data to be added
- Returns:
- boolean representing whether the operation was successful
append
public boolean append(Object rowID,
Object rowData)
- appends a new data element at the end of the existing data set
- Parameters:
- rowID - object that identifies the data added
- rowData - object that specifies the data to be added
- Returns:
- boolean representing whether the operation was successful
append
public boolean append(UniRecord recordSet)
- appends a new data element at the end of the existing data set
- Parameters:
- recordSet - UniRecord object that specifies the data to be added
- Returns:
- boolean representing whether the operation was successful
close
public void close()
- closes the dataset, resetting internal values to their initial state
deleteRow
public boolean deleteRow()
- deletes the current row from the dataset
- Returns:
- boolean denoting whether the operation was successful
deleteRow
public boolean deleteRow(int indexLoc)
- deletes the
indexLoc
row from the dataset
- Parameters:
- indexLoc - integer repesenting which row to be deleted
- Returns:
- boolean denoting whether the operation was successful
deleteRow
public boolean deleteRow(String recordID)
- deletes the row referenced by the recordID specified. If the recordID does not exist
in the dataset, it will return
false
- Parameters:
- indexLoc - integer repesenting which row to be deleted
- Returns:
- boolean denoting whether the operation was successful
findRow
public int findRow(String aRowVal)
- identifies the cursor position of a given row, based on the recordID passed in. If the recordID is found,
the index value is passed back. If it is not found, a -1 is returned
- Parameters:
- aRowVal - name of the field to reference
- Returns:
- integer denoting the cursor position of the requested recordID name. If the recordID was not found,
-1 is returned.
first
public void first()
- moves the internal
UniDataSet
cursor to point to the beginning of the data set.
- See Also:
- beforeFirst
getCurrentRow
public int getCurrentRow()
- returns the current cursor position within the dataset.
- Returns:
- integer representing the current cursor positions
getDataSet
public String getDataSet()
- returns the data contained in the dataset as a @IM separated String
- Returns:
- String representing an @IM separated String of the dataset data
getIDSet
public String getIDSet()
- returns the IDs contained in the dataset as a @IM separated String
- Returns:
- String representing an @IM separated String of the dataset IDs
getString
public String getString()
- returns the dataset row represented by
currentRow
as a String
- Returns:
- String representing the requested dataset row
getString
public String getString(int columnIndex)
- returns the dataset row represented by
columnIndex
as a String
- Parameters:
- columnIndex - integer representing which dataset row to retrieve
- Returns:
- String representing the requested dataset row
getString
public String getString(String columnName)
- returns the dataset row represented by
columnName
as a String
- Parameters:
- columnName - String representing the recordID to be retrieved.
- Returns:
- String representing the requested dataset row
getUniDynArray
public UniDynArray getUniDynArray()
- Extracts the row currently pointed to by the cursor position and returns it as a
UniDynArray
object
- Returns:
- UniDynArray representing the current row of the dataset as a UniDynArray
getUniDynArray
public UniDynArray getUniDynArray(int indexLoc)
- Extracts the row referenced by
indexLoc
and returns it as a UniDynArray
object
- Parameters:
- indexLoc - integer representing the cursor row to return
- Returns:
- UniDynArray representing the current row of the dataset as a UniDynArray
getUniDynArray
public UniDynArray getUniDynArray(String columnName)
- Extracts the row referenced by
columnName
and returns it as a UniDynArray
object
- Parameters:
- columnName - string representing the record ID of the row to return
- Returns:
- UniDynArray representing the current row of the dataset as a UniDynArray
getUniRecord
public UniRecord getUniRecord()
- Extracts the row currently pointed to by the cursor position and returns it as a
UniRecord
object
- Returns:
- UniRecord representing the current row of the dataset as a UniString
getUniRecord
public UniRecord getUniRecord(int indexLoc)
- Extracts the row currently pointed to by the cursor position and returns it as a
getUniRecord
object
- Returns:
- UniRecord representing the current row of the dataset as a UniString
getUniRecord
public UniRecord getUniRecord(String columnName)
- Extracts the row currently pointed to by the cursor name and returns it as a
getUniRecord
object
- Returns:
- UniRecord representing the current row of the dataset as a UniString
getUniString
public UniString getUniString()
- Extracts the row currently pointed to by the cursor position and returns it as a
UniString
object
- Returns:
- UniDynArray representing the current row of the dataset as a UniString
getUniString
public UniString getUniString(int indexLoc)
- Extracts the row currently pointed to by the cursor position and returns it as a
UniString
object
- Parameters:
- indexLoc - integer representing the cursor row to return
- Returns:
- UniDynArray representing the current row of the dataset as a UniString
getUniString
public UniString getUniString(String columnName)
- Extracts the row currently pointed to by the cursor position and returns it as a
UniString
object
- Parameters:
- columnName - String representing the record ID of the cursor row to return
- Returns:
- UniDynArray representing the current row of the dataset as a UniString
getRowCount
public int getRowCount()
- returns the dataset size
- Returns:
- integer representing the size of the dataset
insert
public boolean insert(Object rowVal)
- inserts a new row into the dataset, inserting the row at the current cursor position.
- Parameters:
- rowVal - the rowID of the row being inserted
- Returns:
- boolean representing whether the operation was successful
insert
public boolean insert(int indexLoc,
Object rowID)
- inserts a new row into the dataset, inserting the row at the given cursor position
- Parameters:
- indexLoc - the location where the row should be inserted
- rowVal - the rowID of the row being inserted
- Returns:
- boolean representing whether the operation was successful
insert
public boolean insert(Object rowID,
Object rowVal)
- inserts a new row into the dataset, inserting the row at the current cursor position
- Parameters:
- rowID - the recordID of this row
- rowVal - the data value of this row
- Returns:
- boolean representing whether the operation was successful
insert
public boolean insert(int indexLoc,
Object rowID,
Object rowVal)
- inserts a new row into the dataset, inserting the row at the given cursor position
- Parameters:
- indexLoc - location in the dataset to insert this row
- rowID - the recordID of this row
- rowVal - the data value of this row
- Returns:
- boolean representing whether the operation was successful
insert
public boolean insert(UniRecord recordSet)
- inserts a new row into the dataset, inserting the row at the current cursor position
- Parameters:
- recordSet - UniRecord representing the entire row to be inserted
- Returns:
- boolean representing whether the operation was successful
insert
public boolean insert(int indexLoc,
UniRecord recordSet)
- inserts a new row into the dataset, inserting the row at the current cursor position
- Parameters:
- indexLoc - the location where the row should be inserted
- recordSet - UniRecord representing the entire row to be inserted
- Returns:
- boolean representing whether the operation was successful
isAfterLast
public boolean isAfterLast()
- determines whether or not cursor is positioned past the last row in the dataset. It can be used
for the determination of when the list is exhausted.
- Returns:
- boolean denoting whether the cursor is past the last row or not
isBeforeFirst
public boolean isBeforeFirst()
- determines whether or not cursor is positioned before the first row in the dataset.
- Returns:
- boolean denoting whether the cursor is before the first row or not
isFirst
public boolean isFirst()
- determines whether or not cursor is positioned at the first row in the dataset.
- Returns:
- boolean denoting whether the cursor is at the first row or not
isLast
public boolean isLast()
- determines whether or not cursor is positioned at the last row in the dataset.
- Returns:
- boolean denoting whether the cursor is at the last row or not
last
public void last()
- sets the cursor to the last row in the dataset
next
public boolean next()
- increments the dataset cursor by one. Returns true if the cursor position could be moved. If it is
already at the end of the dataset, it returns a false.
- Returns:
- boolean denoting whether the operation was successful
previous
public boolean previous()
- decrements the dataset cursor by one. Returns true if the cursor position could be moved. If it is
already at the beginning of the dataset, it returns a false.
- Returns:
- boolean denoting whether the operation was successful
relative
public boolean relative(int numRows)
- positions the dataset cursor to a position
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
.
- Parameters:
- numRows - integer representing the number of rows the cursor should be moved
- Returns:
- boolean denoting whether the operation was successful
setIndex
public boolean setIndex(int indexLoc)
- sets the cursor position to the
indexLoc
value referenced. Returns true
false if the operation attempted to position the
cursor outside the dataset
- Parameters:
- indexLoc - the index location to be used for the dataset.
- Returns:
- boolean denoting whether the operation was successful
toString
public String toString()
- Converts the dataset into it's
String
representation. It will add a UniVerse @IM mark
inbetween each row of the dataset.
- Returns:
- String representing the dataset as a String
- Overrides:
- toString in class Object
All Packages Class Hierarchy This Package Previous Next Index