Package com.sas.rio

# Class MVAAnnotatedResultSet

java.lang.Object
com.sas.rio.MVAResultSet
com.sas.rio.MVAAnnotatedResultSet

All Implemented Interfaces:
  `com.sas.sql.AnnotatedResultSet`, `AutoCloseable`, `ResultSet`, `Wrapper`

@SASScope("ALL") public class MVAAnnotatedResultSet extends MVAResultSet implements com.sas.sql.AnnotatedResultSet

This class defines the methods that get, set, and clear the ResultSet and column annotations for the IOM JDBC Driver. These annotations correspond to the extended attributes of a SAS data set. These methods can be used with a SAS 9.4 or later workspace server and on ResultSets generated by simple "SELECT * FROM lib.foo" query without any clauses.

The methods are implemented in the MVAAnnotatedResultSet class (com.sas.rio package) and the AnnotatedResultSet interface is defined in com.sas.sql (in sas.core.jar).

Since:
  9.4

- ## Field Summary

  ### Fields inherited from class com.sas.rio.MVAResultSet

  `_concurrency, _type, _warnings, _wasNull, CHARACTER, DATE, DATETIME, initialFetchSize, INTEGER, m_columnCount, m_maxRows, m_rowCache, m_statement, MAX_FIELD_SIZE, MAYBE_INTEGER, NOSUBTYPE, NUMERIC, TIME`

  ### Fields inherited from interface java.sql.ResultSet

  `CLOSE_CURSORS_AT_COMMIT, CONCUR_READ_ONLY, CONCUR_UPDATABLE, FETCH_FORWARD, FETCH_REVERSE, FETCH_UNKNOWN, HOLD_CURSORS_OVER_COMMIT, TYPE_FORWARD_ONLY, TYPE_SCROLL_INSENSITIVE, TYPE_SCROLL_SENSITIVE`

- ## Constructor Summary

  Constructors
  Constructor
  Description
  `MVAAnnotatedResultSet(MVAStatement stmt, String libref, String tableName, String[] password, String options, int bindKey, int resultSetConcurrency, String segmentLength)`

- ## Method Summary

  Modifier and Type
  Method
  Description
  `void`
  `clearColumnAnnotation(int columnIndex, String annotationName)`
  `void`
  `clearColumnAnnotation(String columnName, String annotationName)`
  `void`
  `clearColumnAnnotations(int columnIndex)`
  `void`
  `clearColumnAnnotations(String columnName)`
  `void`
  `clearResultSetAnnotation(String annotationName)`
  `void`
  `clearResultSetAnnotations()`
  `Map<String,Object>`
  `getColumnAnnotations(int columnIndex)`
  `Map<String,Object>`
  `getColumnAnnotations(String columnName)`
  `int`
  `getColumnAnnotationType(int columnIndex, String annotationName)`
  `int`
  `getColumnAnnotationType(String columnName, String annotationName)`
  `double`
  `getDoubleColumnAnnotation(int columnIndex, String annotationName)`
  `double`
  `getDoubleColumnAnnotation(String columnName, String annotationName)`
  `double`
  `getDoubleResultSetAnnotation(String annotationName)`
  `Character`
  `getMissingValueColumnAnnotation(int columnIndex, String annotationName)`
  `Character`
  `getMissingValueColumnAnnotation(String columnName, String annotationName)`
  `Character`
  `getMissingValueResultSetAnnotation(String annotationName)`
  `Map<String,Object>`
  `getResultSetAnnotations()`
  `int`
  `getResultSetAnnotationType(String annotationName)`
  `String`
  `getStringColumnAnnotation(int columnIndex, String annotationName)`
  `String`
  `getStringColumnAnnotation(String columnName, String annotationName)`
  `String`
  `getStringResultSetAnnotation(String annotationName)`
  `boolean`
  `hasColumnAnnotation(int columnIndex, String annotationName)`
  `boolean`
  `hasColumnAnnotation(String columnName, String annotationName)`
  `boolean`
  `hasColumnAnnotations(int columnIndex)`
  `boolean`
  `hasColumnAnnotations(String columnName)`
  `boolean`
  `hasResultSetAnnotation(String annotationName)`
  `boolean`
  `hasResultSetAnnotations()`
  `void`
  `setColumnAnnotations(int columnIndex, Map<String,Object> annotations)`
  `void`
  `setColumnAnnotations(String columnName, Map<String,Object> annotations)`
  `void`
  `setDoubleColumnAnnotation(int columnIndex, String annotationName, Double annotationValue)`
  `void`
  `setDoubleColumnAnnotation(String columnName, String annotationName, Double annotationValue)`
  `void`
  `setDoubleResultSetAnnotation(String annotationName, Double annotationValue)`
  `void`
  `setNullColumnAnnotation(int columnIndex, int jdbcType, String annotationName)`
  `void`
  `setNullColumnAnnotation(int columnIndex, int jdbcType, String annotationName, String missingValue)`
  `void`
  `setNullResultSetAnnotation(int jdbcType, String annotationName)`
  `void`
  `setNullResultSetAnnotation(int jdbcType, String annotationName, String missingValue)`
  `void`
  `setResultSetAnnotations(Map<String,Object> annotations)`
  `void`
  `setStringColumnAnnotation(int columnIndex, String annotationName, String annotationValue)`
  `void`
  `setStringColumnAnnotation(String columnName, String annotationName, String annotationValue)`
  `void`
  `setStringResultSetAnnotation(String annotationName, String annotationValue)`
  `boolean`
  `wasAnnotationNull()`
  `String[]`
  `wasAnnotationsNull()`

  ### Methods inherited from class com.sas.rio.MVAResultSet

  `absolute, afterLast, beforeFirst, cancelRowUpdates, clearWarnings, close, deleteRow, findColumn, first, getArray, getArray, getAsciiStream, getAsciiStream, getBigDecimal, getBigDecimal, getBigDecimal, getBigDecimal, getBinaryStream, getBinaryStream, getBlob, getBlob, getBoolean, getBoolean, getByte, getByte, getBytes, getBytes, getCache, getCharacterStream, getCharacterStream, getCharacterStream, getCharacterStream, getClob, getClob, getConcurrency, getCursorName, getDate, getDate, getDate, getDate, getDouble, getDouble, getFetchDirection, getFetchSize, getFloat, getFloat, getHoldability, getInt, getInt, getLong, getLong, getMetaData, getNCharacterStream, getNCharacterStream, getNClob, getNClob, getNString, getNString, getObject, getObject, getObject, getObject, getObject, getObject, getRef, getRef, getRow, getRowCache, getRowId, getRowId, getShort, getShort, getSQLXML, getSQLXML, getStatement, getString, getString, getTime, getTime, getTime, getTime, getTimestamp, getTimestamp, getTimestamp, getTimestamp, getType, getUnicodeStream, getUnicodeStream, getURL, getURL, getWarnings, insertMultipleRows, insertRow, isAfterLast, isBeforeFirst, isClosed, isFirst, isLast, isWrapperFor, last, moveToCurrentRow, moveToInsertRow, next, previous, refreshRow, relative, rowDeleted, rowInserted, rowUpdated, setFetchDirection, setFetchSize, unwrap, updateArray, updateArray, updateAsciiStream, updateAsciiStream, updateAsciiStream, updateAsciiStream, updateAsciiStream, updateAsciiStream, updateBigDecimal, updateBigDecimal, updateBinaryStream, updateBinaryStream, updateBinaryStream, updateBinaryStream, updateBinaryStream, updateBinaryStream, updateBlob, updateBlob, updateBlob, updateBlob, updateBlob, updateBlob, updateBoolean, updateBoolean, updateByte, updateByte, updateBytes, updateBytes, updateCharacterStream, updateCharacterStream, updateCharacterStream, updateCharacterStream, updateCharacterStream, updateCharacterStream, updateClob, updateClob, updateClob, updateClob, updateClob, updateClob, updateDate, updateDate, updateDouble, updateDouble, updateFloat, updateFloat, updateInt, updateInt, updateLong, updateLong, updateNCharacterStream, updateNCharacterStream, updateNCharacterStream, updateNCharacterStream, updateNClob, updateNClob, updateNClob, updateNClob, updateNClob, updateNClob, updateNString, updateNString, updateNull, updateNull, updateObject, updateObject, updateObject, updateObject, updateRef, updateRef, updateRow, updateRowId, updateRowId, updateShort, updateShort, updateSQLXML, updateSQLXML, updateString, updateString, updateTime, updateTime, updateTimestamp, updateTimestamp, wasNull`

  ### Methods inherited from class java.lang.Object

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

  ### Methods inherited from interface java.sql.ResultSet

  `updateObject, updateObject, updateObject, updateObject`

- ## Constructor Details

  - ### MVAAnnotatedResultSet

    public MVAAnnotatedResultSet(MVAStatement stmt, String libref, String tableName, String[] password, String options, int bindKey, int resultSetConcurrency, String segmentLength) throws SQLException
    Throws:
      `SQLException`

- ## Method Details

  - ### clearColumnAnnotations

    public void clearColumnAnnotations(int columnIndex) throws SQLException
    Specified by:
      `clearColumnAnnotations` in interface `com.sas.sql.AnnotatedResultSet`
    Throws:
      `SQLException`

  - ### clearColumnAnnotations

    public void clearColumnAnnotations(String columnName) throws SQLException
    Specified by:
      `clearColumnAnnotations` in interface `com.sas.sql.AnnotatedResultSet`
    Throws:
      `SQLException`

  - ### clearResultSetAnnotations

    public void clearResultSetAnnotations() throws SQLException
    Specified by:
      `clearResultSetAnnotations` in interface `com.sas.sql.AnnotatedResultSet`
    Throws:
      `SQLException`

  - ### getStringColumnAnnotation

    public String getStringColumnAnnotation(int columnIndex, String annotationName) throws SQLException
    Specified by:
      `getStringColumnAnnotation` in interface `com.sas.sql.AnnotatedResultSet`
    Throws:
      `SQLException`

  - ### getStringColumnAnnotation

    public String getStringColumnAnnotation(String columnName, String annotationName) throws SQLException
    Specified by:
      `getStringColumnAnnotation` in interface `com.sas.sql.AnnotatedResultSet`
    Throws:
      `SQLException`

  - ### getColumnAnnotations

    public Map<String,Object> getColumnAnnotations(int columnIndex) throws SQLException
    Specified by:
      `getColumnAnnotations` in interface `com.sas.sql.AnnotatedResultSet`
    Throws:
      `SQLException`

  - ### getColumnAnnotations

    public Map<String,Object> getColumnAnnotations(String columnName) throws SQLException
    Specified by:
      `getColumnAnnotations` in interface `com.sas.sql.AnnotatedResultSet`
    Throws:
      `SQLException`

  - ### getStringResultSetAnnotation

    public String getStringResultSetAnnotation(String annotationName) throws SQLException
    Specified by:
      `getStringResultSetAnnotation` in interface `com.sas.sql.AnnotatedResultSet`
    Throws:
      `SQLException`

  - ### getResultSetAnnotations

    public Map<String,Object> getResultSetAnnotations() throws SQLException
    Specified by:
      `getResultSetAnnotations` in interface `com.sas.sql.AnnotatedResultSet`
    Throws:
      `SQLException`

  - ### hasColumnAnnotation

    public boolean hasColumnAnnotation(int columnIndex, String annotationName) throws SQLException
    Specified by:
      `hasColumnAnnotation` in interface `com.sas.sql.AnnotatedResultSet`
    Throws:
      `SQLException`

  - ### hasColumnAnnotation

    public boolean hasColumnAnnotation(String columnName, String annotationName) throws SQLException
    Specified by:
      `hasColumnAnnotation` in interface `com.sas.sql.AnnotatedResultSet`
    Throws:
      `SQLException`

  - ### hasColumnAnnotations

    public boolean hasColumnAnnotations(int columnIndex) throws SQLException
    Specified by:
      `hasColumnAnnotations` in interface `com.sas.sql.AnnotatedResultSet`
    Throws:
      `SQLException`

  - ### hasColumnAnnotations

    public boolean hasColumnAnnotations(String columnName) throws SQLException
    Specified by:
      `hasColumnAnnotations` in interface `com.sas.sql.AnnotatedResultSet`
    Throws:
      `SQLException`

  - ### hasResultSetAnnotation

    public boolean hasResultSetAnnotation(String annotationName) throws SQLException
    Specified by:
      `hasResultSetAnnotation` in interface `com.sas.sql.AnnotatedResultSet`
    Throws:
      `SQLException`

  - ### hasResultSetAnnotations

    public boolean hasResultSetAnnotations() throws SQLException
    Specified by:
      `hasResultSetAnnotations` in interface `com.sas.sql.AnnotatedResultSet`
    Throws:
      `SQLException`

  - ### setStringColumnAnnotation

    public void setStringColumnAnnotation(int columnIndex, String annotationName, String annotationValue) throws SQLException
    Specified by:
      `setStringColumnAnnotation` in interface `com.sas.sql.AnnotatedResultSet`
    Throws:
      `SQLException`

  - ### setStringColumnAnnotation

    public void setStringColumnAnnotation(String columnName, String annotationName, String annotationValue) throws SQLException
    Specified by:
      `setStringColumnAnnotation` in interface `com.sas.sql.AnnotatedResultSet`
    Throws:
      `SQLException`

  - ### setColumnAnnotations

    public void setColumnAnnotations(int columnIndex, Map<String,Object> annotations) throws SQLException
    Specified by:
      `setColumnAnnotations` in interface `com.sas.sql.AnnotatedResultSet`
    Throws:
      `SQLException`

  - ### setColumnAnnotations

    public void setColumnAnnotations(String columnName, Map<String,Object> annotations) throws SQLException
    Specified by:
      `setColumnAnnotations` in interface `com.sas.sql.AnnotatedResultSet`
    Throws:
      `SQLException`

  - ### setStringResultSetAnnotation

    public void setStringResultSetAnnotation(String annotationName, String annotationValue) throws SQLException
    Specified by:
      `setStringResultSetAnnotation` in interface `com.sas.sql.AnnotatedResultSet`
    Throws:
      `SQLException`

  - ### setResultSetAnnotations

    public void setResultSetAnnotations(Map<String,Object> annotations) throws SQLException
    Specified by:
      `setResultSetAnnotations` in interface `com.sas.sql.AnnotatedResultSet`
    Throws:
      `SQLException`

  - ### getDoubleColumnAnnotation

    public double getDoubleColumnAnnotation(int columnIndex, String annotationName) throws SQLException
    Specified by:
      `getDoubleColumnAnnotation` in interface `com.sas.sql.AnnotatedResultSet`
    Throws:
      `SQLException`

  - ### getDoubleColumnAnnotation

    public double getDoubleColumnAnnotation(String columnName, String annotationName) throws SQLException
    Specified by:
      `getDoubleColumnAnnotation` in interface `com.sas.sql.AnnotatedResultSet`
    Throws:
      `SQLException`

  - ### getDoubleResultSetAnnotation

    public double getDoubleResultSetAnnotation(String annotationName) throws SQLException
    Specified by:
      `getDoubleResultSetAnnotation` in interface `com.sas.sql.AnnotatedResultSet`
    Throws:
      `SQLException`

  - ### setDoubleColumnAnnotation

    public void setDoubleColumnAnnotation(int columnIndex, String annotationName, Double annotationValue) throws SQLException
    Specified by:
      `setDoubleColumnAnnotation` in interface `com.sas.sql.AnnotatedResultSet`
    Throws:
      `SQLException`

  - ### setDoubleColumnAnnotation

    public void setDoubleColumnAnnotation(String columnName, String annotationName, Double annotationValue) throws SQLException
    Specified by:
      `setDoubleColumnAnnotation` in interface `com.sas.sql.AnnotatedResultSet`
    Throws:
      `SQLException`

  - ### setDoubleResultSetAnnotation

    public void setDoubleResultSetAnnotation(String annotationName, Double annotationValue) throws SQLException
    Specified by:
      `setDoubleResultSetAnnotation` in interface `com.sas.sql.AnnotatedResultSet`
    Throws:
      `SQLException`

  - ### wasAnnotationsNull

    public String[] wasAnnotationsNull() throws SQLException
    Specified by:
      `wasAnnotationsNull` in interface `com.sas.sql.AnnotatedResultSet`
    Throws:
      `SQLException`

  - ### wasAnnotationNull

    public boolean wasAnnotationNull() throws SQLException
    Specified by:
      `wasAnnotationNull` in interface `com.sas.sql.AnnotatedResultSet`
    Throws:
      `SQLException`

  - ### setNullColumnAnnotation

    public void setNullColumnAnnotation(int columnIndex, int jdbcType, String annotationName) throws SQLException
    Specified by:
      `setNullColumnAnnotation` in interface `com.sas.sql.AnnotatedResultSet`
    Throws:
      `SQLException`

  - ### setNullColumnAnnotation

    public void setNullColumnAnnotation(int columnIndex, int jdbcType, String annotationName, String missingValue) throws SQLException
    Specified by:
      `setNullColumnAnnotation` in interface `com.sas.sql.AnnotatedResultSet`
    Throws:
      `SQLException`

  - ### setNullResultSetAnnotation

    public void setNullResultSetAnnotation(int jdbcType, String annotationName) throws SQLException
    Specified by:
      `setNullResultSetAnnotation` in interface `com.sas.sql.AnnotatedResultSet`
    Throws:
      `SQLException`

  - ### setNullResultSetAnnotation

    public void setNullResultSetAnnotation(int jdbcType, String annotationName, String missingValue) throws SQLException
    Specified by:
      `setNullResultSetAnnotation` in interface `com.sas.sql.AnnotatedResultSet`
    Throws:
      `SQLException`

  - ### getColumnAnnotationType

    public int getColumnAnnotationType(String columnName, String annotationName) throws SQLException
    Specified by:
      `getColumnAnnotationType` in interface `com.sas.sql.AnnotatedResultSet`
    Throws:
      `SQLException`

  - ### getColumnAnnotationType

    public int getColumnAnnotationType(int columnIndex, String annotationName) throws SQLException
    Specified by:
      `getColumnAnnotationType` in interface `com.sas.sql.AnnotatedResultSet`
    Throws:
      `SQLException`

  - ### getResultSetAnnotationType

    public int getResultSetAnnotationType(String annotationName) throws SQLException
    Specified by:
      `getResultSetAnnotationType` in interface `com.sas.sql.AnnotatedResultSet`
    Throws:
      `SQLException`

  - ### clearColumnAnnotation

    public void clearColumnAnnotation(int columnIndex, String annotationName) throws SQLException
    Specified by:
      `clearColumnAnnotation` in interface `com.sas.sql.AnnotatedResultSet`
    Throws:
      `SQLException`

  - ### clearColumnAnnotation

    public void clearColumnAnnotation(String columnName, String annotationName) throws SQLException
    Specified by:
      `clearColumnAnnotation` in interface `com.sas.sql.AnnotatedResultSet`
    Throws:
      `SQLException`

  - ### clearResultSetAnnotation

    public void clearResultSetAnnotation(String annotationName) throws SQLException
    Specified by:
      `clearResultSetAnnotation` in interface `com.sas.sql.AnnotatedResultSet`
    Throws:
      `SQLException`

  - ### getMissingValueResultSetAnnotation

    public Character getMissingValueResultSetAnnotation(String annotationName) throws SQLException
    Specified by:
      `getMissingValueResultSetAnnotation` in interface `com.sas.sql.AnnotatedResultSet`
    Throws:
      `SQLException`

  - ### getMissingValueColumnAnnotation

    public Character getMissingValueColumnAnnotation(int columnIndex, String annotationName) throws SQLException
    Specified by:
      `getMissingValueColumnAnnotation` in interface `com.sas.sql.AnnotatedResultSet`
    Throws:
      `SQLException`

  - ### getMissingValueColumnAnnotation

    public Character getMissingValueColumnAnnotation(String columnName, String annotationName) throws SQLException
    Specified by:
      `getMissingValueColumnAnnotation` in interface `com.sas.sql.AnnotatedResultSet`
    Throws:
      `SQLException`