Package oracle.stellent.ridc.model

Interface DataResultSet

All Known Implementing Classes:
DataResultSetImpl
@Exported public interface DataResultSet
DataResultSet represents a two-dimension data structure. It contains a collection of rows (DataObject). Each row contains a collection of fields (actually values of fields). Because a field contains definition (e.g. a name, type, etc.) for a column of cells. However this interface does not provide direct access to an individual cell. Instead a caller uses getRows () to retrieve an entire row of values.

  • Method Details

    • hasField

      boolean hasField(String name)
      Determines if the field is present in this result set by a given field name
      Parameters:
      name - the field name
      Returns:
      true if the field exists

    • getField

      DataResultSet.Field getField(String name)
      Retrieve the field object with the given field name.
      Parameters:
      name - the name of the field
      Returns:
      the field or null if no such field exists

    • getField

      DataResultSet.Field getField(int index)
      Retrieve the field object at a given index
      Parameters:
      index - the column index
      Returns:
      the field

    • getFields

      List<DataResultSet.Field> getFields()
      Retrieve fields for all columns
      Returns:
      the fields for all columns

    • setFields

      void setFields(List<DataResultSet.Field> fields)
      Set the fields for all columns
      Parameters:
      fields - the fields for all columns

    • addField

      void addField(DataResultSet.Field field, String defaultValue)
      Add a new field to the existing list of fields. Will require all row data to be augmented with the given default value. Note: this is an expensive operation; all internal data structures will be updated.
      Parameters:
      field - the field to add
      defaultValue - a default value for the new column in each row

    • removeField

      void removeField(String field)
      Remove a field from all rows by a given field name Note: this is an expensive operation; all internal data structures will be updated.
      Parameters:
      field - the field to remove

    • addRow

      void addRow(DataObject row)
      Add a new row of value. Any field names that are present in the data object but not in the result set field list will be ignored. Any missing fields will be replaced by empty strings.
      Parameters:
      row - a data object with a mapping of the list field names to values

    • addRow

      void addRow(List<String> items)
      Add a new row as an array of string values
      Parameters:
      items - the row values

    • insertRow

      void insertRow(DataObject row, int index)
      Add a new row of data at the given index.
      Parameters:
      index - the index into the list to insert this row
      row - a data object with a mapping of the list field names to values
      See Also:

    • insertRow

      void insertRow(List<String> items, int index)
      Add a new row as an array of string values at the given index.
      Parameters:
      index - the index to insert the row
      items - the row values

    • removeRow

      void removeRow(int row)
      Remove a row at a given index
      Parameters:
      row - the zero-based row index

    • getRows

      List<DataObject> getRows()
      Retrieve values of all rows
      Returns:
      the list of the available data object rows