com.sas.services.publish
Class AnnotatedServiceResultSet

com.sas.services.publish.AnnotatedServiceResultSet

All Implemented Interfaces:

com.sas.sql.AnnotatedResultSet, java.sql.ResultSet, java.sql.Wrapper

public class AnnotatedServiceResultSet
implements com.sas.sql.AnnotatedResultSet

This class defines the methods needed to consume column and data set annotations. These annotations correspond to the extended attributes of a SAS data set. These methods can be used with SAS 9.4 or later.

Since:

9.4

Constructor Summary

AnnotatedServiceResultSet(com.sas.services.publish.DatasetEntryCallbackInterface retriever)

AnnotatedServiceResultSet(com.sas.services.publish.DatasetEntryCallbackInterface retriever, int nobs)

Method Summary

void	clearColumnAnnotation(int arg0, java.lang.String arg1)
void	clearColumnAnnotation(java.lang.String arg0, java.lang.String arg1)
void	clearColumnAnnotations(int arg0)
void	clearColumnAnnotations(java.lang.String arg0)
void	clearResultSetAnnotation(java.lang.String annotationName)
void	clearResultSetAnnotations()
java.util.Map<java.lang.String,java.lang.Object>	getColumnAnnotations(int columnIndex)
java.util.Map<java.lang.String,java.lang.Object>	getColumnAnnotations(java.lang.String columnName)
int	getColumnAnnotationType(int columnIndex, java.lang.String annotationName) Gets the SQL type for the column.
int	getColumnAnnotationType(java.lang.String columnName, java.lang.String annotationName)
double	getDoubleColumnAnnotation(int columnIndex, java.lang.String annotationName)
double	getDoubleColumnAnnotation(java.lang.String columnName, java.lang.String annotationName)
double	getDoubleResultSetAnnotation(java.lang.String annotationName)
java.lang.Character	getMissingValueColumnAnnotation(int columnIndex, java.lang.String annotationName)
java.lang.Character	getMissingValueColumnAnnotation(java.lang.String columnName, java.lang.String annotationName)
java.lang.Character	getMissingValueResultSetAnnotation(java.lang.String annotationName)
java.util.Map<java.lang.String,java.lang.Object>	getResultSetAnnotations()
int	getResultSetAnnotationType(java.lang.String annotationName) Gets the SQL type for the ResultSet.
java.lang.String	getStringColumnAnnotation(int columnIndex, java.lang.String annotationName)
java.lang.String	getStringColumnAnnotation(java.lang.String columnName, java.lang.String annotationName)
java.util.Map<java.lang.String,java.lang.Object>	getStringColumnAnnotations(java.lang.String columnName)
java.lang.String	getStringResultSetAnnotation(java.lang.String annotationName)
boolean	hasColumnAnnotation(int columnIndex, java.lang.String annotationName)
boolean	hasColumnAnnotation(java.lang.String columnName, java.lang.String annotationName)
boolean	hasColumnAnnotations(int columnIndex)
boolean	hasColumnAnnotations(java.lang.String columnName)
boolean	hasResultSetAnnotation(java.lang.String annotationName)
boolean	hasResultSetAnnotations()
void	setColumnAnnotations(int arg0, java.util.Map<java.lang.String,java.lang.Object> arg1)
void	setColumnAnnotations(java.lang.String arg0, java.util.Map<java.lang.String,java.lang.Object> arg1)
void	setDoubleColumnAnnotation(int arg0, java.lang.String arg1, java.lang.Double arg2)
void	setDoubleColumnAnnotation(java.lang.String arg0, java.lang.String arg1, java.lang.Double arg2)
void	setDoubleResultSetAnnotation(java.lang.String arg0, java.lang.Double arg1)
void	setNullColumnAnnotation(int arg0, int arg1, java.lang.String arg2)
void	setNullColumnAnnotation(int arg0, int arg1, java.lang.String arg2, java.lang.String arg3)
void	setNullResultSetAnnotation(int arg0, java.lang.String arg1)
void	setNullResultSetAnnotation(int arg0, java.lang.String arg1, java.lang.String arg2)
void	setResultSetAnnotations(java.util.Map<java.lang.String,java.lang.Object> arg0)
void	setStringColumnAnnotation(int arg0, java.lang.String arg1, java.lang.String arg2)
void	setStringColumnAnnotation(java.lang.String arg0, java.lang.String arg1, java.lang.String arg2)
void	setStringResultSetAnnotation(java.lang.String arg0, java.lang.String arg1)
boolean	wasAnnotationNull()
java.lang.String[]	wasAnnotationsNull()

Constructor Detail

AnnotatedServiceResultSet

public AnnotatedServiceResultSet(com.sas.services.publish.DatasetEntryCallbackInterface retriever)

AnnotatedServiceResultSet

public AnnotatedServiceResultSet(com.sas.services.publish.DatasetEntryCallbackInterface retriever,
                                 int nobs)

Method Detail

clearColumnAnnotations

public void clearColumnAnnotations(int arg0)
                            throws java.sql.SQLException

Specified by:

clearColumnAnnotations in interface com.sas.sql.AnnotatedResultSet

Throws:

java.sql.SQLException

clearColumnAnnotations

public void clearColumnAnnotations(java.lang.String arg0)
                            throws java.sql.SQLException

Specified by:

clearColumnAnnotations in interface com.sas.sql.AnnotatedResultSet

Throws:

java.sql.SQLException

clearColumnAnnotation

public void clearColumnAnnotation(java.lang.String arg0,
                                  java.lang.String arg1)
                           throws java.sql.SQLException

Specified by:

clearColumnAnnotation in interface com.sas.sql.AnnotatedResultSet

Throws:

java.sql.SQLException

clearColumnAnnotation

public void clearColumnAnnotation(int arg0,
                                  java.lang.String arg1)
                           throws java.sql.SQLException

Specified by:

clearColumnAnnotation in interface com.sas.sql.AnnotatedResultSet

Throws:

java.sql.SQLException

clearResultSetAnnotation

public void clearResultSetAnnotation(java.lang.String annotationName)
                              throws java.sql.SQLException

Specified by:

clearResultSetAnnotation in interface com.sas.sql.AnnotatedResultSet

Throws:

java.sql.SQLException

clearResultSetAnnotations

public void clearResultSetAnnotations()
                               throws java.sql.SQLException

Specified by:

clearResultSetAnnotations in interface com.sas.sql.AnnotatedResultSet

Throws:

java.sql.SQLException

getMissingValueResultSetAnnotation

public java.lang.Character getMissingValueResultSetAnnotation(java.lang.String annotationName)
                                                       throws java.sql.SQLException

Specified by:

getMissingValueResultSetAnnotation in interface com.sas.sql.AnnotatedResultSet

Throws:

java.sql.SQLException

getMissingValueColumnAnnotation

public java.lang.Character getMissingValueColumnAnnotation(int columnIndex,
                                                           java.lang.String annotationName)
                                                    throws java.sql.SQLException

Specified by:

getMissingValueColumnAnnotation in interface com.sas.sql.AnnotatedResultSet

Throws:

java.sql.SQLException

getMissingValueColumnAnnotation

public java.lang.Character getMissingValueColumnAnnotation(java.lang.String columnName,
                                                           java.lang.String annotationName)
                                                    throws java.sql.SQLException

Specified by:

getMissingValueColumnAnnotation in interface com.sas.sql.AnnotatedResultSet

Throws:

java.sql.SQLException

getColumnAnnotationType

public int getColumnAnnotationType(int columnIndex,
                                   java.lang.String annotationName)
                            throws java.sql.SQLException

Gets the SQL type for the column.

Specified by:

getColumnAnnotationType in interface com.sas.sql.AnnotatedResultSet

Parameters:

columnIndex - The index of the column that is returned by the ResultSetMetaData object.

annotationName - The name of the annotation that is defined for the column.

Returns:

java.sql.Types for the column.

Throws:

java.sql.SQLException - This exception is thrown if the value for column is not valid or the annotation name is not defined.

See Also:

Types

getColumnAnnotationType

public int getColumnAnnotationType(java.lang.String columnName,
                                   java.lang.String annotationName)
                            throws java.sql.SQLException

Specified by:

getColumnAnnotationType in interface com.sas.sql.AnnotatedResultSet

Throws:

java.sql.SQLException

getColumnAnnotations

public java.util.Map<java.lang.String,java.lang.Object> getColumnAnnotations(int columnIndex)
                                                                      throws java.sql.SQLException

Specified by:

getColumnAnnotations in interface com.sas.sql.AnnotatedResultSet

Throws:

java.sql.SQLException

getColumnAnnotations

public java.util.Map<java.lang.String,java.lang.Object> getColumnAnnotations(java.lang.String columnName)
                                                                      throws java.sql.SQLException

Specified by:

getColumnAnnotations in interface com.sas.sql.AnnotatedResultSet

Throws:

java.sql.SQLException

getDoubleColumnAnnotation

public double getDoubleColumnAnnotation(int columnIndex,
                                        java.lang.String annotationName)
                                 throws java.sql.SQLException

Specified by:

getDoubleColumnAnnotation in interface com.sas.sql.AnnotatedResultSet

Throws:

java.sql.SQLException

getDoubleColumnAnnotation

public double getDoubleColumnAnnotation(java.lang.String columnName,
                                        java.lang.String annotationName)
                                 throws java.sql.SQLException

Specified by:

getDoubleColumnAnnotation in interface com.sas.sql.AnnotatedResultSet

Throws:

java.sql.SQLException

getDoubleResultSetAnnotation

public double getDoubleResultSetAnnotation(java.lang.String annotationName)
                                    throws java.sql.SQLException

Specified by:

getDoubleResultSetAnnotation in interface com.sas.sql.AnnotatedResultSet

Throws:

java.sql.SQLException

getResultSetAnnotationType

public int getResultSetAnnotationType(java.lang.String annotationName)
                               throws java.sql.SQLException

Gets the SQL type for the ResultSet.

Specified by:

getResultSetAnnotationType in interface com.sas.sql.AnnotatedResultSet

Parameters:

annotationName - The name of the annotation that is defined for the ResultSet.

Returns:

java.sql.Types for the column.

Throws:

java.sql.SQLException - This exception is thrown if the value for column is not valid or the annotation name is not defined.

See Also:

Types

getResultSetAnnotations

public java.util.Map<java.lang.String,java.lang.Object> getResultSetAnnotations()
                                                                         throws java.sql.SQLException

Specified by:

getResultSetAnnotations in interface com.sas.sql.AnnotatedResultSet

Throws:

java.sql.SQLException

getStringColumnAnnotation

public java.lang.String getStringColumnAnnotation(int columnIndex,
                                                  java.lang.String annotationName)
                                           throws java.sql.SQLException

Specified by:

getStringColumnAnnotation in interface com.sas.sql.AnnotatedResultSet

Throws:

java.sql.SQLException

getStringColumnAnnotation

public java.lang.String getStringColumnAnnotation(java.lang.String columnName,
                                                  java.lang.String annotationName)
                                           throws java.sql.SQLException

Specified by:

getStringColumnAnnotation in interface com.sas.sql.AnnotatedResultSet

Throws:

java.sql.SQLException

getStringColumnAnnotations

public java.util.Map<java.lang.String,java.lang.Object> getStringColumnAnnotations(java.lang.String columnName)
                                                                            throws java.sql.SQLException

Throws:

java.sql.SQLException

getStringResultSetAnnotation

public java.lang.String getStringResultSetAnnotation(java.lang.String annotationName)
                                              throws java.sql.SQLException

Specified by:

getStringResultSetAnnotation in interface com.sas.sql.AnnotatedResultSet

Throws:

java.sql.SQLException

hasColumnAnnotation

public boolean hasColumnAnnotation(int columnIndex,
                                   java.lang.String annotationName)
                            throws java.sql.SQLException

Specified by:

hasColumnAnnotation in interface com.sas.sql.AnnotatedResultSet

Throws:

java.sql.SQLException

hasColumnAnnotation

public boolean hasColumnAnnotation(java.lang.String columnName,
                                   java.lang.String annotationName)
                            throws java.sql.SQLException

Specified by:

hasColumnAnnotation in interface com.sas.sql.AnnotatedResultSet

Throws:

java.sql.SQLException

hasColumnAnnotations

public boolean hasColumnAnnotations(int columnIndex)
                             throws java.sql.SQLException

Specified by:

hasColumnAnnotations in interface com.sas.sql.AnnotatedResultSet

Throws:

java.sql.SQLException

hasColumnAnnotations

public boolean hasColumnAnnotations(java.lang.String columnName)
                             throws java.sql.SQLException

Specified by:

hasColumnAnnotations in interface com.sas.sql.AnnotatedResultSet

Throws:

java.sql.SQLException

hasResultSetAnnotation

public boolean hasResultSetAnnotation(java.lang.String annotationName)
                               throws java.sql.SQLException

Specified by:

hasResultSetAnnotation in interface com.sas.sql.AnnotatedResultSet

Throws:

java.sql.SQLException

hasResultSetAnnotations

public boolean hasResultSetAnnotations()
                                throws java.sql.SQLException

Specified by:

hasResultSetAnnotations in interface com.sas.sql.AnnotatedResultSet

Throws:

java.sql.SQLException

setColumnAnnotations

public void setColumnAnnotations(int arg0,
                                 java.util.Map<java.lang.String,java.lang.Object> arg1)
                          throws java.sql.SQLException

Specified by:

setColumnAnnotations in interface com.sas.sql.AnnotatedResultSet

Throws:

java.sql.SQLException

setColumnAnnotations

public void setColumnAnnotations(java.lang.String arg0,
                                 java.util.Map<java.lang.String,java.lang.Object> arg1)
                          throws java.sql.SQLException

Specified by:

setColumnAnnotations in interface com.sas.sql.AnnotatedResultSet

Throws:

java.sql.SQLException

setDoubleColumnAnnotation

public void setDoubleColumnAnnotation(int arg0,
                                      java.lang.String arg1,
                                      java.lang.Double arg2)
                               throws java.sql.SQLException

Specified by:

setDoubleColumnAnnotation in interface com.sas.sql.AnnotatedResultSet

Throws:

java.sql.SQLException

setDoubleColumnAnnotation

public void setDoubleColumnAnnotation(java.lang.String arg0,
                                      java.lang.String arg1,
                                      java.lang.Double arg2)
                               throws java.sql.SQLException

Specified by:

setDoubleColumnAnnotation in interface com.sas.sql.AnnotatedResultSet

Throws:

java.sql.SQLException

setDoubleResultSetAnnotation

public void setDoubleResultSetAnnotation(java.lang.String arg0,
                                         java.lang.Double arg1)
                                  throws java.sql.SQLException

Specified by:

setDoubleResultSetAnnotation in interface com.sas.sql.AnnotatedResultSet

Throws:

java.sql.SQLException

setNullColumnAnnotation

public void setNullColumnAnnotation(int arg0,
                                    int arg1,
                                    java.lang.String arg2)
                             throws java.sql.SQLException

Specified by:

setNullColumnAnnotation in interface com.sas.sql.AnnotatedResultSet

Throws:

java.sql.SQLException

setNullColumnAnnotation

public void setNullColumnAnnotation(int arg0,
                                    int arg1,
                                    java.lang.String arg2,
                                    java.lang.String arg3)
                             throws java.sql.SQLException

Specified by:

setNullColumnAnnotation in interface com.sas.sql.AnnotatedResultSet

Throws:

java.sql.SQLException

setNullResultSetAnnotation

public void setNullResultSetAnnotation(int arg0,
                                       java.lang.String arg1)
                                throws java.sql.SQLException

Specified by:

setNullResultSetAnnotation in interface com.sas.sql.AnnotatedResultSet

Throws:

java.sql.SQLException

setNullResultSetAnnotation

public void setNullResultSetAnnotation(int arg0,
                                       java.lang.String arg1,
                                       java.lang.String arg2)
                                throws java.sql.SQLException

Specified by:

setNullResultSetAnnotation in interface com.sas.sql.AnnotatedResultSet

Throws:

java.sql.SQLException

setResultSetAnnotations

public void setResultSetAnnotations(java.util.Map<java.lang.String,java.lang.Object> arg0)
                             throws java.sql.SQLException

Specified by:

setResultSetAnnotations in interface com.sas.sql.AnnotatedResultSet

Throws:

java.sql.SQLException

setStringColumnAnnotation

public void setStringColumnAnnotation(int arg0,
                                      java.lang.String arg1,
                                      java.lang.String arg2)
                               throws java.sql.SQLException

Specified by:

setStringColumnAnnotation in interface com.sas.sql.AnnotatedResultSet

Throws:

java.sql.SQLException

setStringColumnAnnotation

public void setStringColumnAnnotation(java.lang.String arg0,
                                      java.lang.String arg1,
                                      java.lang.String arg2)
                               throws java.sql.SQLException

Specified by:

setStringColumnAnnotation in interface com.sas.sql.AnnotatedResultSet

Throws:

java.sql.SQLException

setStringResultSetAnnotation

public void setStringResultSetAnnotation(java.lang.String arg0,
                                         java.lang.String arg1)
                                  throws java.sql.SQLException

Specified by:

setStringResultSetAnnotation in interface com.sas.sql.AnnotatedResultSet

Throws:

java.sql.SQLException

wasAnnotationNull

public boolean wasAnnotationNull()
                          throws java.sql.SQLException

Specified by:

wasAnnotationNull in interface com.sas.sql.AnnotatedResultSet

Throws:

java.sql.SQLException

wasAnnotationsNull

public java.lang.String[] wasAnnotationsNull()
                                      throws java.sql.SQLException

Specified by:

wasAnnotationsNull in interface com.sas.sql.AnnotatedResultSet

Throws:

java.sql.SQLException