*** This class provides Binary Compatibility only, not Source Compatibility ***

com.sas.rio
Class Options

com.sas.rio.Options

public class Options

This is the Options class which defines the SAS options like By clause, while creating a table. This class also defines the SQL options like OrderBy clause and Where clause. This class is used to pass the SAS and SQL options as arguments for table creation and table access, but more than that is also used to disect the SQL statement in case we want to look at the SQL statement that caused a problem. This acts like an archive for SQL queries.

Constructor Summary

Options()
Constructs an Options object.

Method Summary

MVAResultSet	getByGroup() Gets an MVAResultSet object containing rows of a by-group.
java.lang.String	getByStatement() Gets the SAS BY statement text.
java.lang.String	getOptions() Gets the options text.
java.lang.String	getOrderByStatement() Gets the ORDER BY statement text.
java.lang.String	getWhereClause() Gets the Where clause statement text.
void	setByStatement(java.lang.String text, boolean appendFlag) Sets BY statement text.
void	setOptions(java.lang.String text, boolean appendFlag) Sets options string to be passed in while creating a table.
void	setOrderByStatement(java.lang.String text, boolean appendFlag) Sets ORDER BY statement text.
void	setWhereClause(java.lang.String text, boolean appendFlag) Sets WHERE clause text.

Constructor Detail

Options

public Options()

Constructs an Options object.

Method Detail

setOptions

public void setOptions(java.lang.String text,
                       boolean appendFlag)
                throws RIOException

Sets options string to be passed in while creating a table. The options can be any dataset options that are appropriate given the underlying library and engine. The options string may be NULL.

Parameters:

text - An input String of options. Options may be NULL.

appendFlag - A boolean flag to append or not append options text.

Throws:

RIOException - This exception is never thrown.

setByStatement

public void setByStatement(java.lang.String text,
                           boolean appendFlag)
                    throws RIOException

Sets BY statement text.

Parameters:

text - An input String of BY statement text.

appendFlag - A boolean flag to append or not append text.

Throws:

RIOException - This exception is never thrown.

setOrderByStatement

public void setOrderByStatement(java.lang.String text,
                                boolean appendFlag)
                         throws RIOException

Sets ORDER BY statement text.

Parameters:

text - An input String of ORDER BY statement text.

appendFlag - A boolean flag to append or not append text.

Throws:

RIOException - This exception is never thrown.

setWhereClause

public void setWhereClause(java.lang.String text,
                           boolean appendFlag)
                    throws RIOException

Sets WHERE clause text.

Parameters:

text - An input String of WHERE clause statement text.

appendFlag - boolean flag to append or not append text.

Throws:

RIOException - This exception is never thrown.

getByGroup

public MVAResultSet getByGroup()
                        throws RIOException

Gets an MVAResultSet object containing rows of a by-group. Note: Method not yet implemented.

Returns:

MVAResultSet object containing rows of a by-group.

Throws:

RIOException - This exception is thrown if a RIOException is detected.

getOrderByStatement

public java.lang.String getOrderByStatement()
                                     throws RIOException

Gets the ORDER BY statement text.

Returns:

String The ORDER BY statement text.

Throws:

RIOException - This exception is never thrown.

getByStatement

public java.lang.String getByStatement()
                                throws RIOException

Gets the SAS BY statement text.

Returns:

String The SAS BY statement text.

Throws:

RIOException - This exception is never thrown.

getWhereClause

public java.lang.String getWhereClause()
                                throws RIOException

Gets the Where clause statement text.

Returns:

String The Where clause statement text.

Throws:

RIOException - This exception is never thrown.

getOptions

public java.lang.String getOptions()
                            throws RIOException

Gets the options text.

Returns:

String The options text.

Throws:

RIOException - This exception is never thrown.

*** This class provides Binary Compatibility only, not Source Compatibility ***