com.sas.models
Class IMDBTable

com.sas.models.IMDBTable

All Implemented Interfaces:

com.sas.beans.PropertyChangeSource, com.sas.beans.VetoableChangeSource, com.sas.collection.ContentsChangedListener, com.sas.collection.ContentsChangedSource, StaticCollectionInterface, StaticOrderedCollectionInterface, ComponentInterface, LinkPropertiesInterface, ModelInterface, NodeIconInterface, NodeInterface, SimpleNodeInterface, TreeInterface, com.sas.PublicClonable, com.sas.sasserver.dataset.DataSetInterface, com.sas.sasserver.dataset.LevelDataSetInterface, com.sas.sasserver.dataset.RemoteDataSetInterface, RemoteSASListInterface, ColumnLabelInterface, DataTableInterface, FormatInterface, FormattedDataInterface, RowLabelInterface, RowTemplateTableInterface, SortableTableInterface, com.sas.table.StaticColumnInfoInterface, StaticColumnLabelInterface, StaticFormattedDataInterface, com.sas.table.StaticRowLabelInterface, StaticRowTemplateTableInterface, StaticTableInterface, StaticTableStyleInterface, TableInterface, com.sas.util.Countable, com.sas.util.Enumerable, com.sas.util.EventGateInterface, IndexedGetInterface, ViewInterface, MultipleValueEventSourceInterface, java.beans.PropertyChangeListener, java.io.ObjectInputValidation, java.io.Serializable, java.lang.Cloneable, java.util.EventListener

public class IMDBTable
implements com.sas.sasserver.dataset.DataSetInterface

See Also:

Serialized Form

Field Summary

protected boolean	clearModel
protected OrderedCollection	columnInfos
protected java.lang.String	columnInfoUsed
protected java.lang.String	currentQuery
protected OrderedCollection	dataSetIDs
protected OrderedCollection	dataSetNames
protected boolean	readOnly
protected OrderedCollection	updates
protected java.lang.String[][]	updateTable
protected boolean	updateTableOnly

Fields inherited from class com.sas.models.SimpleTable

allContentsChangedListeners, columnLabelsSupported, columnsLabel, columnsLabelSupported, rowLabelsSupported, rowsLabel, rowsLabelSupported

Fields inherited from interface com.sas.table.RowTemplateTableInterface

DEFAULT_INDEX

Constructor Summary

IMDBTable()

IMDBTable(java.lang.String host, java.lang.String port, java.lang.String userName, java.lang.String password)

Method Summary

int	_addRow(com.sas.collection.hlist.HListInterface p1, com.sas.collection.hlist.HListInterface p2) This method is for internal implementation only and should not be called by the user.
int	_close() This method is for internal implementation only and should not be called by the user.
void	_commitRow() This method is for internal implementation only and should not be called by the user.
int	_countRows(int p1) Count the number of rows in the dataset, but don't read more than maxRows observations.
int	_deleteRow(int p1) This method is for internal implementation only and should not be called by the user.
com.sas.collection.hlist.HListInterface	_finfo() Fast info retrieval for dataset.
com.sas.collection.hlist.HListInterface	_fopen(java.lang.String p1, java.lang.String p2) Fast open for dataset.
com.sas.collection.hlist.HListInterface	_formatValues(java.lang.String p1, com.sas.collection.hlist.HListInterface p2) This method is for internal implementation only and should not be called by the user.
com.sas.collection.hlist.HListInterface	_getColumnAttributes(int p1) This method is for internal implementation only and should not be called by the user.
int	_getColumnCount() This method is for internal implementation only and should not be called by the user.
com.sas.collection.hlist.HListInterface	_getFormattedRows(int p1, int p2) This method is for internal implementation only and should not be called by the user.
com.sas.collection.hlist.HListInterface	_getMembers() Returns the list of members in the remote SCL object.
com.sas.collection.hlist.HListInterface	_getPartialFormattedRows(int p1, int p2) This method is for internal implementation only and should not be called by the user.
com.sas.collection.hlist.HListInterface	_getPartialRows(int p1, int p2) This method is for internal implementation only and should not be called by the user.
int	_getRowCount() This method is for internal implementation only and should not be called by the user.
com.sas.collection.hlist.HListInterface	_getRows(int p1, int p2) This method is for internal implementation only and should not be called by the user.
int	_setDataSet(java.lang.String p1, java.lang.String p2) This method is for internal implementation only and should not be called by the user.
void	_setDisplayedColumns(com.sas.collection.hlist.HListInterface p1) This method is for internal implementation only and should not be called by the user.
int	_setEntry(java.lang.String p1) This method is for internal implementation only and should not be called by the user.
int	_setFormattedRow(int p1, com.sas.collection.hlist.HListInterface p2, com.sas.collection.hlist.HListInterface p3) This method is for internal implementation only and should not be called by the user.
int	_setRow(int p1, com.sas.collection.hlist.HListInterface p2, com.sas.collection.hlist.HListInterface p3) This method is for internal implementation only and should not be called by the user.
int	_setSource(java.lang.String p1) This method is for internal implementation only and should not be called by the user.
void	_setWhere(com.sas.collection.hlist.HListInterface p1) This method is for internal implementation only and should not be called by the user.
void	addColumn(int p1, java.lang.Class p2, java.lang.Object p3) Throws an exception since columns are not extendable
void	addRow(int rowIndex, java.lang.Object[] cells) Adds a row.
void	apply(com.sas.util.ApplyInterface p1) Applies the action to every item in the collection.
protected void	clearAllData() Clear all the data fields Note that this method clears all the local collections, while the initializeAllData method reallocates the collections.
void	close() Closes the SAS data set if it is currently open.
void	commitRow() Commits whatever the current row in the data set is.
boolean	contains(java.lang.Object p1) Test for the presence of an object in this collection
void	contentsChanged(com.sas.collection.ContentsChangedEvent p1)
int	count()
int	countNodeChildren(int p1) Counts the children of the current node.
void	deleteColumn(int p1) Column deletion is not supported by this model.
void	deleteRow(int rowIndex) Deleting the row will delete any associated row labels as well.
void	deleteRow(int rowIndex, OrderedCollection filesIncludedInDeletion)
void	enableEventsSilently(boolean p1) Reenables events, but does so without sending an event, which enableEvents will do.
boolean	equals(StaticOrderedCollectionInterface p1) Compare the current items with those in another collection and tell whether the collections are identical.
java.lang.String[]	formatValues(int p1, java.lang.Object[] p2) Formats a set of values using the pre-defined format associated with a given identifier.
java.lang.Object	get(int p1) Get a value via an integer index.
int	getBufferBlocks() Returns the numbr of buffer blocks.
int	getBufferSize() Returns the number of rows which the data set caching fetches a look-ahead read.
int	getColumnIndex(java.lang.String columnName) Returns the index of the specified column.
java.lang.Object	getColumnInfo(int index, java.lang.String columnInfoName)
java.lang.String[]	getColumnInfoNames()
java.lang.String	getColumnInfoUsed() Returns the column information that is currently being returned as the column label.
java.lang.String	getDataSet() Returns the SAS data set name.
java.lang.String	getDataSetName()
java.lang.String	getDataSetOptions() Returns any options passed into setDataSet() with the data set name.
com.sas.visuals.IconInterface	getDefaultIcon() Returns the default icon for the current node.
java.lang.String[]	getDisplayedColumns() Returns which columns in the model are displayed, or null for all columns (the default).
java.lang.String	getEntry() Returns the name of the dataform entry associated with the model.
com.sas.visuals.IconInterface	getExpandedIcon() Returns the expanded icon for the current node.
com.sas.visuals.IconInterface	getExpandedSelectedIcon() Returns the expandedSelected icon for the current node.
java.lang.String	getFormattedCell(int p1, int p2) Returns the formatted value of a cell.
java.lang.String[][]	getFormattedCells(int p1, int p2, int p3, int p4) Returns the formatted values for a block of cells.
java.lang.String[]	getFormattedColumn(int p1) Returns the formatted values of all the cells in a column.
java.lang.String[]	getFormattedRow(int rowIndex) Returns the formatted values of all the cells in a row.
IMDB	getIMDB()
int	getIndex(java.lang.Object p1, int p2) Returns the index of the first occurrence of the item.
int	getIndexColumn() Returns the index column index in the dataset.
java.util.Enumeration	getItems()
java.util.Enumeration	getItems(int p1, int p2) Returns an enumeration of a subset of the items from a collection.
int	getLastIndex(java.lang.Object p1, int p2) Returns the index of the last occurrence of the item.
int	getLevelColumn() Returns the level column index in the dataset.
SimpleNodeInterface	getNodeChild(int p1) Returns the child node at the specified index.
int	getNodeChildCount() Returns the number of children.
SimpleNodeInterface[]	getNodeChildren(int p1, int p2) Returns the specified range of children for the current node.
java.lang.String	getNodeExpandedText() Returns the value of the nodeExpandedText property.
java.lang.String	getNodeText() Returns the value of the nodeText property.
java.lang.String	getNodeType() Returns the value of the nodeType property.
java.lang.String	getQuery()
NodeInterface	getRoot() Returns a NodeInterface object to serve as the root node.
java.lang.String	getRootText() Returns the root node text if it has been set through the setRootText method.
com.sas.visuals.IconInterface	getSelectedIcon() Returns the selected icon for the current node.
java.lang.String	getSource() Returns the name of the SCL source entry associated with the model.
int	getTextColumn() Returns the text column index in the dataset.
java.lang.String	getWhere() Returns the where clause applied to the data set.
protected void	initializeAllData() Initialize all the local data fields Note that this method reallocates all the local collections, while the clearAllData method clears the existing collections.
boolean	isCellsModifiable() In this model, the cells are always modifiable, so this method always returns true.
boolean	isColumnsDeletable() Column deletion is not supported in this model.
boolean	isColumnsExtendable() Column extension is not supported in this model.
boolean	isColumnsInsertable() Column insertion is not supported in this model.
boolean	isColumnsRedefinable() Column redefinition is not supported in this model.
boolean	isLeafNode() Indicates whether the current node is a leaf.
boolean	isMultipleRowUpdateSupported() In this model, multiple row update is always supported, so this method always returns true.
boolean	isReadOnly() Returns whether the data set is read only or editable.
boolean	isRowsDeletable() Row deletion is supported if the data set is open in update mode.
boolean	isRowsExtendable() Row addition is supported if the data set is open in update mode.
boolean	isRowsInsertable() Column insertion is not supported in this model.
boolean	isRowsLabelSupported() This model never returns a columns label.
void	refresh() refresh() causes the data in the dataset to be re-read from the SAS server.
void	serverConnect(java.lang.String host, java.lang.String port, java.lang.String userName, java.lang.String password)
void	serverDisconnect()
void	setBufferBlocks(int p1) Sets the data set row cache block size.
void	setBufferSize(int p1) Sets the SAS data set buffering look-ahead size.
void	setCell(int rowIndex, int columnIndex, java.lang.Object cell) Specifies the value of a cell.
void	setCells(int startRowIndex, int startColumnIndex, int rowCount, int columnCount, java.lang.Object[][] cells) Specifies the values for a block of cells.
void	setColumn(int columnIndex, java.lang.Object[] cells) Specifies the values of all the cells in a column.
void	setColumnInfoUsed(java.lang.String p1) Sets the column information that is currently being returned as the column label.
void	setDataSet(java.lang.String dataSetName) Specifies the SAS data set name.
void	setDisplayedColumns(java.lang.String[] p1) Sets which columns in the model are displayed, or returned to the user.
void	setEntry(java.lang.String p1) Specifies the name of the dataform entry associated with the model.
void	setFormattedCell(int rowIndex, int columnIndex, java.lang.String cell) Specifies the formatted value of a cell.
void	setFormattedCells(int p1, int p2, int p3, int p4, java.lang.String[][] p5) Specifies the formatted values for a block of cells.
void	setFormattedColumn(int columnIndex, java.lang.String[] cells) Specifies the formatted values of all the cells in a column.
void	setFormattedRow(int rowIndex, java.lang.String[] cells) Specifies the formatted values of all the cells in a row.
void	setIMDB(IMDB imdb)
void	setIndexColumn(int p1) Specifies the index column index in the dataset.
void	setLeafNode(boolean p1) Specifies whether this node is the leaf node of a TreeInterface implementation.
void	setLevelColumn(int p1) Specifies the level column index in the dataset.
void	setPendingDataSet(java.lang.String p1) Specifies the SAS data set name, but the data set is not actually read until necessary for other method calls.
void	setQuery(java.lang.String request)
void	setReadOnly(boolean readOnly) Specifies whether the data set is read only or editable.
void	setRootText(java.lang.String p1) Sets the root node text that will be used when the DataSetInterface is the model for a tree.
void	setRow(int rowIndex, java.lang.Object[] cells) Specifies the values of all the cells in a row.
void	setSource(java.lang.String p1) Specifies the name of the SCL source entry associated with the model.
void	setTextColumn(int p1) Specifies the text column index in the dataset.
void	setWhere(java.lang.String request) Specifies the where clause to apply to the data set.
void	useBufferHints(com.sas.models.BufferHints p1) Ask the local data set object to use a set of buffering hints.

Methods inherited from class com.sas.models.SimpleTable

addColumn, addContentsChangedListener, addRow, anyContentsChangedListeners, calculateTotalColumns, calculateTotalRows, clone, countColumns, countRows, deleteAllColumns, deleteAllRows, deleteRows, disableEvents, enableEvents, enableEvents, equals, equals, fireContentsChanged, fireContentsChanged, getCell, getCell, getCellClass, getCellClasses, getCells, getCellStyle, getColumn, getColumnClass, getColumnClasses, getColumnClasses, getColumnComparator, getColumnCount, getColumnDefaultValue, getColumnDefaultValues, getColumnLabel, getColumnLabels, getColumnLabelStyle, getColumnStyle, getDefaultCellStyle, getDefaultColumnStyle, getDefaultLabelStyle, getDefaultRowStyle, getExtendedBeanInfo, getRow, getRowCount, getRowLabel, getRowLabels, getRowLabelStyle, getRowStyle, isCellStylesSupported, isColumnLabelsModifiable, isColumnLabelsSupported, isColumnLabelStylesSupported, isColumnsLabelSupported, isColumnStylesSupported, isMultipleColumnUpdateSupported, isRowLabelsModifiable, isRowLabelsSupported, isRowLabelStylesSupported, isRowStylesSupported, newColumnComparator, newCompositeComparator, newRowComparator, normalizeEndRow, normalizeStartRow, permute, populate, populate, populate, populate, removeContentsChangedListener, removeDuplicates, removeDuplicates, removeDuplicates, removeDuplicates, removeDuplicates, removeDuplicates, removeWastedSpace, reverseColumnComparator, setColumnClass, setColumnComparator, setColumnComparators, setColumnCount, setColumnDefaultValue, setColumnLabel, setColumnLabelsSupported, setDefaultCellStyle, setDefaultColumnStyle, setDefaultLabelStyle, setDefaultRowStyle, setDefaultValues, setRowCount, setRowLabel, setRowLabelsSupported, setSize, sort, sort, sort, sort, sort, sort

Methods inherited from class com.sas.Component

addLink, addPropertyChangeListener, addVetoableChangeListener, anyPropertyChangeListeners, attachModel, attachView, beansIsDesignTime, beansSetDesignTime, clone, detachModel, detachView, dumpComponent, firePropertyChange, firePropertyChange, fireVetoableChange, getComponentDescription, getComponentSupportInfo, getEventMethod, getEventValues, getLinkInfo, getModelInterface, getRequiredInterfaces, getResources, getStringResource, getViewInterfaceSupportInfo, initialize, initializeComponent, isDesignTime, isLinked, propertyChange, queryLinks, queryLinks, refresh, removeAllLinks, removeInterfaceTraps, removeLink, removePropertyChangeListener, removeVetoableChangeListener, setComponentDescription, setComponentSupportInfo, setLinkInfo, setModelInterface, setRequiredInterfaces, setViewInterfaceSupportInfo, supportsListenerInterface, supportsRequiredInterfaces, trapInterfaceEvents, validateObject

Methods inherited from interface com.sas.ComponentInterface

addPropertyChangeListener, addVetoableChangeListener, anyPropertyChangeListeners, dumpComponent, firePropertyChange, firePropertyChange, fireVetoableChange, getComponentDescription, getComponentSupportInfo, initialize, initializeComponent, isDesignTime, removePropertyChangeListener, removeVetoableChangeListener, setComponentDescription, setComponentSupportInfo, setDefaultValues

Methods inherited from interface com.sas.ViewInterface

attachModel, detachModel, getModelInterface, getRequiredInterfaces, getViewInterfaceSupportInfo, refresh, removeInterfaceTraps, setModelInterface, setRequiredInterfaces, setViewInterfaceSupportInfo, supportsRequiredInterfaces, trapInterfaceEvents

Methods inherited from interface com.sas.ModelInterface

attachView, detachView

Methods inherited from interface com.sas.LinkPropertiesInterface

addLink, getLinkInfo, isLinked, queryLinks, queryLinks, removeAllLinks, removeLink, setLinkInfo

Methods inherited from interface com.sas.table.RowTemplateTableInterface

addRow, getColumnDefaultValue, getColumnDefaultValues, setColumnClass, setColumnDefaultValue

Methods inherited from interface com.sas.table.StaticRowTemplateTableInterface

getColumnClass, getColumnClasses

Methods inherited from interface com.sas.table.TableInterface

isMultipleColumnUpdateSupported

Methods inherited from interface com.sas.table.StaticTableInterface

countColumns, countRows, getCell, getCellClass, getCellClasses, getCells, getColumn, getColumnCount, getRow, getRowCount

Methods inherited from interface com.sas.table.StaticRowLabelInterface

getRowLabel, getRowLabels, isRowLabelsSupported

Methods inherited from interface com.sas.table.StaticColumnLabelInterface

getColumnLabel, getColumnLabels, isColumnLabelsSupported, isColumnsLabelSupported

Methods inherited from interface com.sas.collection.StaticOrderedCollectionInterface

clone

Methods inherited from interface com.sas.collection.ContentsChangedSource

addContentsChangedListener, removeContentsChangedListener

Methods inherited from interface com.sas.util.EventGateInterface

disableEvents, enableEvents

Field Detail

dataSetNames

protected transient OrderedCollection dataSetNames

dataSetIDs

protected transient OrderedCollection dataSetIDs

updates

protected transient OrderedCollection updates

columnInfos

protected transient OrderedCollection columnInfos

readOnly

protected transient boolean readOnly

clearModel

protected transient boolean clearModel

updateTable

protected transient java.lang.String[][] updateTable

currentQuery

protected transient java.lang.String currentQuery

columnInfoUsed

protected transient java.lang.String columnInfoUsed

updateTableOnly

protected transient boolean updateTableOnly

Constructor Detail

IMDBTable

public IMDBTable()

IMDBTable

public IMDBTable(java.lang.String host,
                 java.lang.String port,
                 java.lang.String userName,
                 java.lang.String password)

Method Detail

getIMDB

public IMDB getIMDB()

setIMDB

public void setIMDB(IMDB imdb)

serverConnect

public void serverConnect(java.lang.String host,
                          java.lang.String port,
                          java.lang.String userName,
                          java.lang.String password)

serverDisconnect

public void serverDisconnect()

getNodeChildCount

public int getNodeChildCount()

Description copied from interface: SimpleNodeInterface

Returns the number of children. If the number of children is unknown, -1 should be returned.

Specified by:

getNodeChildCount in interface SimpleNodeInterface

Returns:

the number of children or -1 if unknown

getFormattedCells

public java.lang.String[][] getFormattedCells(int p1,
                                              int p2,
                                              int p3,
                                              int p4)
                                       throws com.sas.table.TableException

Description copied from interface: StaticFormattedDataInterface

Returns the formatted values for a block of cells. The block is identified by the intersection of a range of rows with a range of columns. startRowIndex and rowCount define the start and extent of the row range while startColumnIndex and columnCount define the column range. The set of values is returned as a two-dimensional array, new Object[rowCount][colCount], with values[0][0] containing the formatted value of the cell at (startRowIndex, startColumnIndex).

Specified by:

getFormattedCells in interface StaticFormattedDataInterface

Parameters:

p1 - A one-based index that identifies the start of the row range.

p2 - A one-based index that identifies the start of the column range.

p3 - The number of rows in the row range.

p4 - The number of columns in the column range.

Returns:

The specified cells' values.

Throws:

TableException - Thrown if the query can not be satisfied (e.g. i/o-failure).

See Also:

StaticFormattedDataInterface.getFormattedCell(int, int), StaticTableInterface.getColumnCount(), StaticTableInterface.getRowCount()

setRow

public void setRow(int rowIndex,
                   java.lang.Object[] cells)

Description copied from interface: TableInterface

Specifies the values of all the cells in a row. The row is identified by the given index. The set of values is specified as an array with each element of the array corresponding to a cell in the row. Usually, the implementation will require that the class of each new value match what's returned by getCellClass() for the corresponding cell, but a common exception to this will be implementations that allow values to be instances of com.sas.MissingValues.

Specified by:

setRow in interface TableInterface

Overrides:

setRow in class SimpleTable

Parameters:

rowIndex - A one-based index that identifies the row.

cells - The new values for each cell in the row.

See Also:

TableInterface.setRow(int, java.lang.Object[])

getNodeType

public java.lang.String getNodeType()

Description copied from interface: NodeInterface

Returns the value of the nodeType property. The type can be used for categorizing nodes.

Specified by:

getNodeType in interface NodeInterface

Returns:

the nodeType property

setCell

public void setCell(int rowIndex,
                    int columnIndex,
                    java.lang.Object cell)

Description copied from interface: TableInterface

Specifies the value of a cell. The cell is identified by the given row and column indices.

Specified by:

setCell in interface TableInterface

Overrides:

setCell in class SimpleTable

Parameters:

rowIndex - A one-based index that identifies the cell's row.

columnIndex - A one-based index that identifies the cell's column.

cell - The cell's new value.

See Also:

TableInterface.setCell(int, int, java.lang.Object)

equals

public boolean equals(StaticOrderedCollectionInterface p1)

Description copied from interface: StaticOrderedCollectionInterface

Compare the current items with those in another collection and tell whether the collections are identical. The equals() method is used to compare collection items.

Specified by:

equals in interface StaticOrderedCollectionInterface

Parameters:

p1 - Another ordered collection to be compared to.

Returns:

true if this collection has the same size and same elements as the other collection, false otherwise.

_setEntry

public int _setEntry(java.lang.String p1)

Description copied from interface: RemoteDataSetInterface

This method is for internal implementation only and should not be called by the user. setEntry should be called instead.

Specified by:

_setEntry in interface com.sas.sasserver.dataset.RemoteDataSetInterface

See Also:

DataSetInterface.setEntry(java.lang.String)

_formatValues

public com.sas.collection.hlist.HListInterface _formatValues(java.lang.String p1,
                                                             com.sas.collection.hlist.HListInterface p2)

Description copied from interface: RemoteDataSetInterface

This method is for internal implementation only and should not be called by the user. formatValues should be called instead.

Specified by:

_formatValues in interface com.sas.sasserver.dataset.RemoteDataSetInterface

See Also:

FormatInterface.formatValues(int, java.lang.Object[])

apply

public void apply(com.sas.util.ApplyInterface p1)

Description copied from interface: StaticCollectionInterface

Applies the action to every item in the collection. This is a general way to modify all the items in a collection.

Specified by:

apply in interface StaticCollectionInterface

Parameters:

p1 - An object that provides a function which takes an object as an argument and then does something to it. action.apply(pair) is excecuted on successive values in this collection until all values have been operated on, or until the method returns ApplyInterface.ABORT

isRowsInsertable

public boolean isRowsInsertable()

Column insertion is not supported in this model.

Specified by:

isRowsInsertable in interface RowTemplateTableInterface

Overrides:

isRowsInsertable in class SimpleTable

Returns:

Always returns false since column insertion is not supported.

See Also:

RowTemplateTableInterface.isColumnsInsertable()

_countRows

public int _countRows(int p1)

Description copied from interface: RemoteDataSetInterface

Count the number of rows in the dataset, but don't read more than maxRows observations.

Specified by:

_countRows in interface com.sas.sasserver.dataset.RemoteDataSetInterface

Parameters:

p1 - the maximum number of rows to read.

_addRow

public int _addRow(com.sas.collection.hlist.HListInterface p1,
                   com.sas.collection.hlist.HListInterface p2)

Description copied from interface: RemoteDataSetInterface

This method is for internal implementation only and should not be called by the user. addRow should be called instead.

Specified by:

_addRow in interface com.sas.sasserver.dataset.RemoteDataSetInterface

See Also:

RowTemplateTableInterface.addRow(int, java.lang.Object[])

enableEventsSilently

public void enableEventsSilently(boolean p1)

Description copied from interface: DataSetInterface

Reenables events, but does so without sending an event, which enableEvents will do.

Specified by:

enableEventsSilently in interface com.sas.sasserver.dataset.DataSetInterface

Parameters:

p1 - If true, marks the component as dirty and needing refresh

See Also:

EventGateInterface.enableEvents()

getColumnInfoUsed

public java.lang.String getColumnInfoUsed()

Description copied from interface: DataTableInterface

Returns the column information that is currently being returned as the column label. The default is to return the NAME of the column.

Specified by:

getColumnInfoUsed in interface DataTableInterface

Returns:

A String indicating the type of information to use as the column label.

See Also:

DataTableInterface.setColumnInfoUsed(java.lang.String)

getNodeChildren

public SimpleNodeInterface[] getNodeChildren(int p1,
                                             int p2)

Description copied from interface: SimpleNodeInterface

Returns the specified range of children for the current node. If there are less children than are queried for, an implementation can return an array whose size if representative of the actual number of children being returned or an array whose size is the same as the number of children asked for. If the resulting array's size is the same as the number asked for and there are fewer children returned than asked for the implementation should assign the unused values in the array to null. If the leafNode property value is true then this method should return null.

Specified by:

getNodeChildren in interface SimpleNodeInterface

Parameters:

p1 - 0-based index which identifies the start of the range

p2 - the amount of children to get

Returns:

an array containing the specified range of children or null if the leafNode property value is true.

getFormattedCell

public java.lang.String getFormattedCell(int p1,
                                         int p2)
                                  throws com.sas.table.TableException

Description copied from interface: StaticFormattedDataInterface

Returns the formatted value of a cell. The cell is identified by the given row and column indices.

Specified by:

getFormattedCell in interface StaticFormattedDataInterface

Parameters:

p1 - A one-based index that identifies the cell's row.

p2 - A one-based index that identifies the cell's column.

Returns:

The specified cell's formatted value.

Throws:

TableException - Thrown if the query can not be satisfied (e.g. i/o-failure).

See Also:

StaticFormattedDataInterface.getFormattedCells(int, int, int, int), StaticFormattedDataInterface.getFormattedColumn(int), StaticFormattedDataInterface.getFormattedRow(int)

setFormattedRow

public void setFormattedRow(int rowIndex,
                            java.lang.String[] cells)

Description copied from interface: FormattedDataInterface

Specifies the formatted values of all the cells in a row. The row is identified by the given index. The set of formatted values is specified as an array with each element of the array corresponding to a cell in the row.

Specified by:

setFormattedRow in interface FormattedDataInterface

Parameters:

rowIndex - A one-based index that identifies the row.

cells - The new formatted values for each cell in the row.

See Also:

FormattedDataInterface.setFormattedCell(int, int, java.lang.String)

_setWhere

public void _setWhere(com.sas.collection.hlist.HListInterface p1)

Description copied from interface: RemoteDataSetInterface

This method is for internal implementation only and should not be called by the user. setWhere should be called instead.

Specified by:

_setWhere in interface com.sas.sasserver.dataset.RemoteDataSetInterface

See Also:

DataTableInterface.setWhere(java.lang.String)

_finfo

public com.sas.collection.hlist.HListInterface _finfo()

Description copied from interface: RemoteDataSetInterface

Fast info retrieval for dataset.

Specified by:

_finfo in interface com.sas.sasserver.dataset.RemoteDataSetInterface

setPendingDataSet

public void setPendingDataSet(java.lang.String p1)

Description copied from interface: DataSetInterface

Specifies the SAS data set name, but the data set is not actually read until necessary for other method calls. setDataSet should be used instead for most cases since calling setPendingDataSet will not send the expected property change events.

Specified by:

setPendingDataSet in interface com.sas.sasserver.dataset.DataSetInterface

Parameters:

p1 - The SAS data set name.

See Also:

DataSetInterface.setDataSet(java.lang.String)

getColumnIndex

public int getColumnIndex(java.lang.String columnName)
                   throws com.sas.table.TableException,
                          java.lang.IllegalArgumentException

Description copied from interface: DataTableInterface

Returns the index of the specified column.

Specified by:

getColumnIndex in interface DataTableInterface

Parameters:

columnName - The name of the column to return the index of. Case does not matter.

Throws:

com.sas.table.TableException - if the column information cannot be retrieved.

java.lang.IllegalArgumentException - if the column is not in the data set.

getItems

public java.util.Enumeration getItems()

Specified by:

getItems in interface com.sas.util.Enumerable

getNodeText

public java.lang.String getNodeText()

Description copied from interface: NodeInterface

Returns the value of the nodeText property.

Specified by:

getNodeText in interface NodeInterface

Returns:

the nodeText property

getNodeExpandedText

public java.lang.String getNodeExpandedText()

Description copied from interface: NodeInterface

Returns the value of the nodeExpandedText property. The expanded text is usually a more descriptive version of the nodeText property. For example, a node that represents a file can return the file name for the nodeText property and the full path name for the nodeExpandedText property.

Specified by:

getNodeExpandedText in interface NodeInterface

Returns:

the nodeExpandedText property

setTextColumn

public void setTextColumn(int p1)

Description copied from interface: LevelDataSetInterface

Specifies the text column index in the dataset. The text column is the column which contains the data for the observation, which can be either numeric or character.

Specified by:

setTextColumn in interface com.sas.sasserver.dataset.LevelDataSetInterface

Parameters:

p1 - The column index of the text column.

setFormattedColumn

public void setFormattedColumn(int columnIndex,
                               java.lang.String[] cells)

Description copied from interface: FormattedDataInterface

Specifies the formatted values of all the cells in a column. The column is identified by the given index. The set of formatted values is specified as an array with each element of the array corresponding to a cell in the column.

Specified by:

setFormattedColumn in interface FormattedDataInterface

Parameters:

columnIndex - A one-based index that identifies the column.

cells - The new formatted values for each cell in the column.

See Also:

FormattedDataInterface.setFormattedCell(int, int, java.lang.String)

isColumnsRedefinable

public boolean isColumnsRedefinable()

Column redefinition is not supported in this model.

Specified by:

isColumnsRedefinable in interface RowTemplateTableInterface

Overrides:

isColumnsRedefinable in class SimpleTable

Returns:

Always returns false since column redefinition is not supported.

See Also:

RowTemplateTableInterface.isColumnsRedefinable()

_setSource

public int _setSource(java.lang.String p1)

Description copied from interface: RemoteDataSetInterface

This method is for internal implementation only and should not be called by the user. setSource should be called instead.

Specified by:

_setSource in interface com.sas.sasserver.dataset.RemoteDataSetInterface

See Also:

DataSetInterface.setSource(java.lang.String)

_fopen

public com.sas.collection.hlist.HListInterface _fopen(java.lang.String p1,
                                                      java.lang.String p2)

Description copied from interface: RemoteDataSetInterface

Fast open for dataset.

Specified by:

_fopen in interface com.sas.sasserver.dataset.RemoteDataSetInterface

getSource

public java.lang.String getSource()

Description copied from interface: DataSetInterface

Returns the name of the SCL source entry associated with the model.

Specified by:

getSource in interface com.sas.sasserver.dataset.DataSetInterface

Returns:

source The SCL entry's three or four level name.

See Also:

DataSetInterface.setSource(java.lang.String)

setBufferBlocks

public void setBufferBlocks(int p1)

Description copied from interface: DataTableInterface

Sets the data set row cache block size. The client side data set object maintains in a local memory cache, equal to bufferBlock * bufferSize The cache size allows more efficient back-and-forth reading behavior, such as scrolling a small window of rows in a table view. With a buffer block setting larger than a window, the data set can keep more than one page of data locally, so that moving back a forth between two or three pages does not require rereading the data from the remote model. This is especially critical when the data set is a SAS data view or otherwise cannot back up to a previously read observation without rewinding to the beginning and reading all preceeding observations.

Also settable via useBufferHints() with a bufferHint.how = BufferHintsInterface.CACHE_SIZE

Specified by:

setBufferBlocks in interface DataTableInterface

Parameters:

p1 - Blocking factor. This number is multiplied by the bufferSize to determine the cache size, the number of rows to store locally in the client.

See Also:

DataTableInterface.getBufferBlocks(), DataTableInterface.setBufferSize(int), DataTableInterface.getBufferSize()

getColumnInfo

public java.lang.Object getColumnInfo(int index,
                                      java.lang.String columnInfoName)
                               throws com.sas.table.TableException

Specified by:

getColumnInfo in interface com.sas.table.StaticColumnInfoInterface

Throws:

com.sas.table.TableException

formatValues

public java.lang.String[] formatValues(int p1,
                                       java.lang.Object[] p2)
                                throws com.sas.table.TableException

Description copied from interface: FormatInterface

Formats a set of values using the pre-defined format associated with a given identifier.

Specified by:

formatValues in interface FormatInterface

Parameters:

p1 - Identifies the format to use. This will be implementation defined. For example, a one-based index that identifies a row or column in a table.

p2 - The set of values to format.

Returns:

An array of formatted values.

Throws:

TableException - Thrown if the query can not be satisfied (e.g. i/o-failure).

_getColumnAttributes

public com.sas.collection.hlist.HListInterface _getColumnAttributes(int p1)

Description copied from interface: RemoteDataSetInterface

This method is for internal implementation only and should not be called by the user. getColumnInfo should be called instead.

Specified by:

_getColumnAttributes in interface com.sas.sasserver.dataset.RemoteDataSetInterface

See Also:

StaticColumnInfoInterface.getColumnInfo(int, java.lang.String)

commitRow

public void commitRow()

Description copied from interface: DataTableInterface

Commits whatever the current row in the data set is.

Specified by:

commitRow in interface DataTableInterface

setDataSet

public void setDataSet(java.lang.String dataSetName)

Description copied from interface: DataSetInterface

Specifies the SAS data set name. The data set name is not case sensitive.

You may also pass in options to use when the dataset is opened : ds.setDataSetName("sasuser.class(pw=" + password + ")");

If an error occurs opening the data set (missing data set, bad password, etc...), an IllegalArgumentException will be thrown.

Specified by:

setDataSet in interface com.sas.sasserver.dataset.DataSetInterface

Parameters:

dataSetName - The SAS data set name and any options to use when opening the data set.

See Also:

DataSetInterface.getDataSet()

getDataSetOptions

public java.lang.String getDataSetOptions()

Description copied from interface: DataSetInterface

Returns any options passed into setDataSet() with the data set name. For example, if a call is made to setDataSet like : ds.setDataSet( "sasuser.pwprot(pw=\"password\")" ); then, getDataSetOptions() will return (pw="password").

Specified by:

getDataSetOptions in interface com.sas.sasserver.dataset.DataSetInterface

Returns:

The options specified on the setDataSet() call.

contains

public boolean contains(java.lang.Object p1)

Description copied from interface: StaticCollectionInterface

Test for the presence of an object in this collection

Specified by:

contains in interface StaticCollectionInterface

Parameters:

p1 - the item to search for

Returns:

True if and only if the item exists

isMultipleRowUpdateSupported

public boolean isMultipleRowUpdateSupported()

Description copied from class: SimpleTable

In this model, multiple row update is always supported, so this method always returns true.

Specified by:

isMultipleRowUpdateSupported in interface TableInterface

Overrides:

isMultipleRowUpdateSupported in class SimpleTable

Returns:

true if multiple rows can be simultaneously updated, and false otherwise.

See Also:

TableInterface.isMultipleRowUpdateSupported()

getExpandedIcon

public com.sas.visuals.IconInterface getExpandedIcon()

Description copied from interface: NodeIconInterface

Returns the expanded icon for the current node. If the expanded icon is null then the result of getDefaultIcon should be returned.

Specified by:

getExpandedIcon in interface NodeIconInterface

Returns:

the expanded icon for the current node

setLevelColumn

public void setLevelColumn(int p1)

Description copied from interface: LevelDataSetInterface

Specifies the level column index in the dataset. The level column is the column which contains the hierarchical level for the observation. The level column must be a numeric column. The value for the level may be 1 or greater.

Specified by:

setLevelColumn in interface com.sas.sasserver.dataset.LevelDataSetInterface

Parameters:

p1 - The column index of the level column.

addRow

public void addRow(int rowIndex,
                   java.lang.Object[] cells)

Description copied from interface: RowTemplateTableInterface

Adds a row. The new row is inserted at the given index and its cells are assigned the given values. The class of each element in the values array must be the same as or derived from the class of its corresponding column.

Some implementations may not allow rows to be added. This can be determined through isRowsExtendable. Some implementations may allow rows to be added, but not inserted; check isRowsInsertable. If this is the case, only DEFAULT_INDEX can be specified for index.

Specified by:

addRow in interface RowTemplateTableInterface

Overrides:

addRow in class SimpleTable

Parameters:

rowIndex - The one-based position at which to insert the row; rows already at or above that position will be shifted-up. If DEFAULT_INDEX is specified the position of the new row is implementation defined, but should be at the end if possible.

cells - The values for each of the row's cells.

See Also:

RowTemplateTableInterface.addRow(int, java.lang.Object[])

_deleteRow

public int _deleteRow(int p1)

Description copied from interface: RemoteDataSetInterface

This method is for internal implementation only and should not be called by the user. deleteRow should be called instead.

Specified by:

_deleteRow in interface com.sas.sasserver.dataset.RemoteDataSetInterface

See Also:

RowTemplateTableInterface.deleteRow(int)

_getColumnCount

public int _getColumnCount()

Description copied from interface: RemoteDataSetInterface

This method is for internal implementation only and should not be called by the user. getColumnCount should be called instead.

Specified by:

_getColumnCount in interface com.sas.sasserver.dataset.RemoteDataSetInterface

See Also:

StaticTableInterface.getColumnCount()

setEntry

public void setEntry(java.lang.String p1)

Description copied from interface: DataSetInterface

Specifies the name of the dataform entry associated with the model. This is the dataform entry used by the DATA_M model, and it must already exist on the server. A dataform entry is created by configuring a SAS/AF Data Table or Data Form object after specifying the name of a dataform entry on the object attributes window. See the Help for these objects for more information.

The DataSetInterface supports setting a dataform entry because it is the way to create computed columns on the DATA_M model. However, there can be a great deal of other customizing information contained within a dataform entry. These customizations are always applied to the DATA_M model, but may cause problems from the client side. For example, it causes problems if some columns are set to hidden within the dataform. For best results, only use the dataform entry to define computed columns. Implement other features, like data validation or column display on the client side.

If the dataform entry contains definitions of one or more computed columns, you should also create an associated SCL source entry containing the SCL code for calculating the computed column values. The computed columns defined in the dataform entry will show missing values until _setSource() is called. That method associates the DATA_M model with the SCL code for computing the column values.

Specified by:

setEntry in interface com.sas.sasserver.dataset.DataSetInterface

Parameters:

p1 - The dataform entry's three or four level name.

See Also:

DataSetInterface.setSource(java.lang.String), DataSetInterface.getEntry()

getEntry

public java.lang.String getEntry()

Description copied from interface: DataSetInterface

Returns the name of the dataform entry associated with the model.

Specified by:

getEntry in interface com.sas.sasserver.dataset.DataSetInterface

Returns:

entry The dataform entry's three or four level name.

See Also:

DataSetInterface.setEntry(java.lang.String)

setColumnInfoUsed

public void setColumnInfoUsed(java.lang.String p1)
                       throws com.sas.table.TableException

Description copied from interface: DataTableInterface

Sets the column information that is currently being returned as the column label.

Specified by:

setColumnInfoUsed in interface DataTableInterface

Parameters:

p1 - A String indicating the type of information to use as the column label. Case does not matter.

Throws:

com.sas.table.TableException

See Also:

DataTableInterface.getColumnInfoUsed()

setCells

public void setCells(int startRowIndex,
                     int startColumnIndex,
                     int rowCount,
                     int columnCount,
                     java.lang.Object[][] cells)

Description copied from interface: TableInterface

Specifies the values for a block of cells. The block is identified by the intersection of a range of rows with a range of columns. startRowIndex and rowCount define the start and extent of the row range while startColumnIndex and columnCount define the column range. The set of values is specified as a two-dimensional array, new Object[rowCount][colCount], with values[0][0] containing the value of the cell at (startRowIndex, startColumnIndex). Usually, the implementation will require that the class of each new value match what's returned by getCellClass() for the corresponding cell, but a common exception to this will be implementations that allow values to be instances of com.sas.MissingValues.

Specified by:

setCells in interface TableInterface

Overrides:

setCells in class SimpleTable

Parameters:

startRowIndex - A one-based index that identifies the start of the row range.

startColumnIndex - A one-based index that identifies the start of the column range.

rowCount - The number of rows in the row range.

columnCount - The number of columns in the column range.

cells - The new values for each cell in the block.

See Also:

TableInterface.setCells(int, int, int, int, java.lang.Object[][])

isCellsModifiable

public boolean isCellsModifiable()

Description copied from class: SimpleTable

In this model, the cells are always modifiable, so this method always returns true.

Specified by:

isCellsModifiable in interface TableInterface

Overrides:

isCellsModifiable in class SimpleTable

Returns:

true if cells can be modified, and false otherwise.

See Also:

TableInterface.isCellsModifiable()

getExpandedSelectedIcon

public com.sas.visuals.IconInterface getExpandedSelectedIcon()

Description copied from interface: NodeIconInterface

Returns the expandedSelected icon for the current node. If the expandedSelected icon is null then the result of getExpandedIcon should be returned.

Specified by:

getExpandedSelectedIcon in interface NodeIconInterface

Returns:

the expandedSelected icon for the current node

setFormattedCell

public void setFormattedCell(int rowIndex,
                             int columnIndex,
                             java.lang.String cell)

Description copied from interface: FormattedDataInterface

Specifies the formatted value of a cell. The cell is identified by the given row and column indices.

Specified by:

setFormattedCell in interface FormattedDataInterface

Parameters:

rowIndex - A one-based index that identifies the cell's row.

columnIndex - A one-based index that identifies the cell's column.

cell - The cell's new formatted value.

See Also:

FormattedDataInterface.setFormattedCells(int, int, int, int, java.lang.String[][]), FormattedDataInterface.setFormattedColumn(int, java.lang.String[]), FormattedDataInterface.setFormattedRow(int, java.lang.String[])

isRowsLabelSupported

public boolean isRowsLabelSupported()

This model never returns a columns label.

Specified by:

isRowsLabelSupported in interface com.sas.table.StaticRowLabelInterface

Overrides:

isRowsLabelSupported in class SimpleTable

Returns:

false since columns label are never supported

See Also:

StaticRowLabelInterface.isRowsLabelSupported()

isRowsDeletable

public boolean isRowsDeletable()

Row deletion is supported if the data set is open in update mode. Returns true if isCellsModifiable() returns true, indicating that the data set is open in update mode, false otherwise.

Specified by:

isRowsDeletable in interface RowTemplateTableInterface

Specified by:

isRowsDeletable in interface SortableTableInterface

Overrides:

isRowsDeletable in class SimpleTable

Returns:

Whether or not the data set is open in update mode

See Also:

RowTemplateTableInterface.isRowsDeletable()

isColumnsDeletable

public boolean isColumnsDeletable()

Column deletion is not supported in this model.

Specified by:

isColumnsDeletable in interface RowTemplateTableInterface

Overrides:

isColumnsDeletable in class SimpleTable

Returns:

Always returns false since column deletion is not supported.

See Also:

RowTemplateTableInterface.isColumnsDeletable()

_getPartialFormattedRows

public com.sas.collection.hlist.HListInterface _getPartialFormattedRows(int p1,
                                                                        int p2)

Description copied from interface: RemoteDataSetInterface

This method is for internal implementation only and should not be called by the user. getFormattedCells should be called instead.

Specified by:

_getPartialFormattedRows in interface com.sas.sasserver.dataset.RemoteDataSetInterface

See Also:

StaticFormattedDataInterface.getFormattedCells(int, int, int, int)

_getPartialRows

public com.sas.collection.hlist.HListInterface _getPartialRows(int p1,
                                                               int p2)

Description copied from interface: RemoteDataSetInterface

This method is for internal implementation only and should not be called by the user. getRow should be called instead.

Specified by:

_getPartialRows in interface com.sas.sasserver.dataset.RemoteDataSetInterface

See Also:

StaticTableInterface.getRow(int)

setLeafNode

public void setLeafNode(boolean p1)

Description copied from interface: DataSetInterface

Specifies whether this node is the leaf node of a TreeInterface implementation.

Specified by:

setLeafNode in interface com.sas.sasserver.dataset.DataSetInterface

Parameters:

p1 - Whether this node is a leaf node

getWhere

public java.lang.String getWhere()

Description copied from interface: DataTableInterface

Returns the where clause applied to the data set. The where clause is of the syntax for standard SAS data set where clauses.

Specified by:

getWhere in interface DataTableInterface

Returns:

whereClause The where clause.

See Also:

DataTableInterface.getWhere()

getQuery

public java.lang.String getQuery()

countNodeChildren

public int countNodeChildren(int p1)

Description copied from interface: SimpleNodeInterface

Counts the children of the current node. countNodeChildren differs from getNodeChildCount when the number of children is unknown, i.e. when getNodeChildCount returns -1. If your implementation of getNodeChildCount never returns -1, then simply define countNodeChildren as a return of getNodeChildCount, otherwise read-on.

countNodeChildren is an instruction to determine the number of children even though that number is not readily known. To limit the potential overhead of this determination, the maximum number of children to read may be specified.

Specified by:

countNodeChildren in interface SimpleNodeInterface

Returns:

The number of children known to be available.

setColumn

public void setColumn(int columnIndex,
                      java.lang.Object[] cells)

Description copied from interface: TableInterface

Specifies the values of all the cells in a column. The column is identified by the given index. The set of values is specified as an array with each element of the array corresponding to a cell in the column. Usually, the implementation will require that the class of each new value match what's returned by getCellClass() for the corresponding cell, but a common exception to this will be implementations that allow values to be instances of com.sas.MissingValues.

Specified by:

setColumn in interface TableInterface

Overrides:

setColumn in class SimpleTable

Parameters:

columnIndex - A one-based index that identifies the column.

cells - The new values for each cell in the column.

See Also:

TableInterface.setColumn(int, java.lang.Object[])

getIndexColumn

public int getIndexColumn()

Description copied from interface: LevelDataSetInterface

Returns the index column index in the dataset. The index column is the column which contains the row number for the observation. The index column must be a numeric column.

Specified by:

getIndexColumn in interface com.sas.sasserver.dataset.LevelDataSetInterface

Returns:

The column index of the index column.

getItems

public java.util.Enumeration getItems(int p1,
                                      int p2)

Description copied from interface: StaticOrderedCollectionInterface

Returns an enumeration of a subset of the items from a collection.

Specified by:

getItems in interface StaticOrderedCollectionInterface

Parameters:

p1 - the index of the first item, zero based.

p2 - one past the index of the last item to include in the enumeration, zero based, or -1 to indicate the enumeration should include all remaining elements. Note that the range of elements returned in the Enumeration does not include the end item; this is consistent with String.substring(start, end) for example.

Returns:

an enumeration of the requested elements.

deleteRow

public void deleteRow(int rowIndex)

Description copied from class: SimpleTable

Deleting the row will delete any associated row labels as well.

Specified by:

deleteRow in interface RowTemplateTableInterface

Overrides:

deleteRow in class SimpleTable

Parameters:

rowIndex - A one-based index that identifies the row.

See Also:

RowTemplateTableInterface.deleteRow(int)

deleteRow

public void deleteRow(int rowIndex,
                      OrderedCollection filesIncludedInDeletion)

_setRow

public int _setRow(int p1,
                   com.sas.collection.hlist.HListInterface p2,
                   com.sas.collection.hlist.HListInterface p3)

Description copied from interface: RemoteDataSetInterface

This method is for internal implementation only and should not be called by the user. setRow should be called instead.

Specified by:

_setRow in interface com.sas.sasserver.dataset.RemoteDataSetInterface

See Also:

TableInterface.setRow(int, java.lang.Object[])

getLevelColumn

public int getLevelColumn()

Description copied from interface: LevelDataSetInterface

Returns the level column index in the dataset. The level column is the column which contains the hierarchical level for the observation.

Specified by:

getLevelColumn in interface com.sas.sasserver.dataset.LevelDataSetInterface

Returns:

The column index of the level column.

_setDisplayedColumns

public void _setDisplayedColumns(com.sas.collection.hlist.HListInterface p1)

Description copied from interface: RemoteDataSetInterface

This method is for internal implementation only and should not be called by the user. setDisplayedColumns should be called instead.

Specified by:

_setDisplayedColumns in interface com.sas.sasserver.dataset.RemoteDataSetInterface

See Also:

DataTableInterface.setDisplayedColumns(java.lang.String[])

_getFormattedRows

public com.sas.collection.hlist.HListInterface _getFormattedRows(int p1,
                                                                 int p2)

Description copied from interface: RemoteDataSetInterface

This method is for internal implementation only and should not be called by the user. getFormattedCells should be called instead.

Specified by:

_getFormattedRows in interface com.sas.sasserver.dataset.RemoteDataSetInterface

See Also:

StaticFormattedDataInterface.getFormattedCells(int, int, int, int)

_setDataSet

public int _setDataSet(java.lang.String p1,
                       java.lang.String p2)

Description copied from interface: RemoteDataSetInterface

This method is for internal implementation only and should not be called by the user. setDataSet should be called instead.

Specified by:

_setDataSet in interface com.sas.sasserver.dataset.RemoteDataSetInterface

See Also:

DataSetInterface.setDataSet(java.lang.String)

setSource

public void setSource(java.lang.String p1)

Description copied from interface: DataSetInterface

Specifies the name of the SCL source entry associated with the model. This is the SCL entry used by the DATA_M model for computed columns or other data validation. It must already exist on the server. It is created by by configuring a SAS/AF Data Table or Data Form object after specifying the name of a source entry on the object attributes window. It is refered to as "model SCL". See the Help for these objects for more information.

There should also be an associated dataform entry that contains the definition of the computed columns in the model SCL entry. The computed columns will not appear until _setEntry() is called, setting this corresponding dataform entry.

The model SCL for a computed column must compute the value for each row as the row is displayed in the viewer and when related column values are edited. Here is an example of computing a variance between actual and predicted results for a table containing numeric columns names "actual" and "predict". The model SCL will compute values for the computed column named "variance".

INIT:

ACTUAL:

PREDICT:
 * Set the value of VARIANCE during initialization ;
 * or if values are modified in the ACTUAL or      ;
 * PREDICT columns.                                ;
variance=actual-predict;

return;

Specified by:

setSource in interface com.sas.sasserver.dataset.DataSetInterface

Parameters:

p1 - The model SCL entry's three or four level name.

See Also:

DataSetInterface.setEntry(java.lang.String), DataSetInterface.getSource()

isLeafNode

public boolean isLeafNode()

Description copied from interface: SimpleNodeInterface

Indicates whether the current node is a leaf. A value of true indicates that the current node is a leaf and hence will not have any children.

Specified by:

isLeafNode in interface SimpleNodeInterface

Returns:

true if the current node is a leaf, otherwise false

getFormattedRow

public java.lang.String[] getFormattedRow(int rowIndex)

Description copied from interface: StaticFormattedDataInterface

Returns the formatted values of all the cells in a row. The row is identified by the given index. The set of values is returned as an array with each element of the array corresponding to a cell in the row.

Specified by:

getFormattedRow in interface StaticFormattedDataInterface

Parameters:

rowIndex - A one-based index that identifies the row.

Returns:

The values of the specified row's cells.

See Also:

StaticFormattedDataInterface.getFormattedCell(int, int)

getIndex

public int getIndex(java.lang.Object p1,
                    int p2)

Description copied from interface: StaticOrderedCollectionInterface

Returns the index of the first occurrence of the item. The search proceeds from startIndex to the end of the list; the index of the first item that matches the element is returned.

Specified by:

getIndex in interface StaticOrderedCollectionInterface

Parameters:

p1 - item to search for

p2 - the position where the search should start

Returns:

the zero-based index where the list item was first found, or -1 if the item is not found.

isColumnsExtendable

public boolean isColumnsExtendable()

Column extension is not supported in this model.

Specified by:

isColumnsExtendable in interface RowTemplateTableInterface

Overrides:

isColumnsExtendable in class SimpleTable

Returns:

Always returns false since column extension is not supported.

See Also:

RowTemplateTableInterface.isColumnsExtendable()

addColumn

public void addColumn(int p1,
                      java.lang.Class p2,
                      java.lang.Object p3)

Throws an exception since columns are not extendable

Specified by:

addColumn in interface RowTemplateTableInterface

Overrides:

addColumn in class SimpleTable

Parameters:

p1 - The one-based position at which to insert the column; columns already at or above that position will be shifted-up. If DEFAULT_INDEX is specified the position of the new column is implementation defined, but should be at the end if possible.

p2 - The class of the column's cells.

p3 - The default value for the column's cells.

Throws:

com.sas.table.TableException - since columns are not exendable

See Also:

RowTemplateTableInterface.addColumn(int, java.lang.Class, java.lang.Object)

useBufferHints

public void useBufferHints(com.sas.models.BufferHints p1)

Description copied from interface: DataTableInterface

Ask the local data set object to use a set of buffering hints. Use this to configure the number of rows to read ahead when doing buffered reads, or how many rows to maintain in the local client-side cache.

The DataSet object currently supports only caching of sequential reads, and row-based caching.

Specified by:

useBufferHints in interface DataTableInterface

getNodeChild

public SimpleNodeInterface getNodeChild(int p1)

Description copied from interface: SimpleNodeInterface

Returns the child node at the specified index. If the leafNode property value is true then this method should return null.

Specified by:

getNodeChild in interface SimpleNodeInterface

Parameters:

p1 - the 0-based index of the child node to retrieve

Returns:

the child at index or null if the leafNode property value is true.

getFormattedColumn

public java.lang.String[] getFormattedColumn(int p1)
                                      throws com.sas.table.TableException

Description copied from interface: StaticFormattedDataInterface

Returns the formatted values of all the cells in a column. The column is identified by the given index. The set of values is returned as an array with each element of the array corresponding to a cell in the column.

Specified by:

getFormattedColumn in interface StaticFormattedDataInterface

Parameters:

p1 - A one-based index that identifies the column.

Returns:

The values of the specified column's cells.

Throws:

TableException - Thrown if the query can not be satisfied (e.g. i/o-failure).

See Also:

StaticFormattedDataInterface.getFormattedCell(int, int)

getDefaultIcon

public com.sas.visuals.IconInterface getDefaultIcon()

Description copied from interface: NodeIconInterface

Returns the default icon for the current node.

Specified by:

getDefaultIcon in interface NodeIconInterface

Returns:

the default icon for the current node

deleteColumn

public void deleteColumn(int p1)

Column deletion is not supported by this model.

Specified by:

deleteColumn in interface RowTemplateTableInterface

Overrides:

deleteColumn in class SimpleTable

Parameters:

p1 - A one-based index that identifies the column.

Throws:

com.sas.table.TableException - Thrown since columns are not deletable in this model

See Also:

RowTemplateTableInterface.deleteColumn(int)

_setFormattedRow

public int _setFormattedRow(int p1,
                            com.sas.collection.hlist.HListInterface p2,
                            com.sas.collection.hlist.HListInterface p3)

Description copied from interface: RemoteDataSetInterface

This method is for internal implementation only and should not be called by the user. setFormattedCells should be called instead.

Specified by:

_setFormattedRow in interface com.sas.sasserver.dataset.RemoteDataSetInterface

See Also:

FormattedDataInterface.setFormattedCells(int, int, int, int, java.lang.String[][])

setReadOnly

public void setReadOnly(boolean readOnly)

Description copied from interface: DataTableInterface

Specifies whether the data set is read only or editable.

Specified by:

setReadOnly in interface DataTableInterface

Parameters:

readOnly - true for read only, false for editable.

See Also:

DataTableInterface.setReadOnly(boolean)

get

public java.lang.Object get(int p1)

Description copied from interface: IndexedGetInterface

Get a value via an integer index. This is like an array reference.

Specified by:

get in interface IndexedGetInterface

Parameters:

p1 - the index of the item to fetch.

Returns:

Object the object associated with the index.

setIndexColumn

public void setIndexColumn(int p1)

Description copied from interface: LevelDataSetInterface

Specifies the index column index in the dataset. The index column is the column which contains the row number for the observation. The index column must be a numeric column. The value for the index may be 1 or greater.

Specified by:

setIndexColumn in interface com.sas.sasserver.dataset.LevelDataSetInterface

Parameters:

p1 - The column index of the index column.

getRoot

public NodeInterface getRoot()

Description copied from interface: TreeInterface

Returns a NodeInterface object to serve as the root node.

Specified by:

getRoot in interface TreeInterface

Returns:

the root node as type NodeInterface

contentsChanged

public void contentsChanged(com.sas.collection.ContentsChangedEvent p1)

Specified by:

contentsChanged in interface com.sas.collection.ContentsChangedListener

getLastIndex

public int getLastIndex(java.lang.Object p1,
                        int p2)

Description copied from interface: StaticOrderedCollectionInterface

Returns the index of the last occurrence of the item. The search proceeds from the startIndex to the start of the list until an item is found.

Specified by:

getLastIndex in interface StaticOrderedCollectionInterface

Parameters:

p1 - the item to search for

p2 - the position where the search should start

Returns:

the zero-based index of the last item matching element, or -1 if the item is not found.

close

public void close()

Description copied from interface: DataTableInterface

Closes the SAS data set if it is currently open.

Specified by:

close in interface DataTableInterface

_getMembers

public com.sas.collection.hlist.HListInterface _getMembers()

Description copied from interface: RemoteSASListInterface

Returns the list of members in the remote SCL object.

Specified by:

_getMembers in interface RemoteSASListInterface

Returns:

members The list of members.

getSelectedIcon

public com.sas.visuals.IconInterface getSelectedIcon()

Description copied from interface: NodeIconInterface

Returns the selected icon for the current node. If the selected icon is null then the result of getDefaultIcon should be returned.

Specified by:

getSelectedIcon in interface NodeIconInterface

Returns:

the selected icon for the current node

getTextColumn

public int getTextColumn()

Description copied from interface: LevelDataSetInterface

Returns the text column index in the dataset. The text column is the column which contains the data for the observation, which can be either numeric or character.

Specified by:

getTextColumn in interface com.sas.sasserver.dataset.LevelDataSetInterface

Returns:

The column index of the text column.

isColumnsInsertable

public boolean isColumnsInsertable()

Column insertion is not supported in this model.

Specified by:

isColumnsInsertable in interface RowTemplateTableInterface

Overrides:

isColumnsInsertable in class SimpleTable

Returns:

Always returns false since column insertion is not supported.

See Also:

RowTemplateTableInterface.isColumnsInsertable()

_getRows

public com.sas.collection.hlist.HListInterface _getRows(int p1,
                                                        int p2)

Description copied from interface: RemoteDataSetInterface

This method is for internal implementation only and should not be called by the user. getRow should be called instead.

Specified by:

_getRows in interface com.sas.sasserver.dataset.RemoteDataSetInterface

See Also:

StaticTableInterface.getRow(int)

_getRowCount

public int _getRowCount()

Description copied from interface: RemoteDataSetInterface

This method is for internal implementation only and should not be called by the user. getRowCount should be called instead.

Specified by:

_getRowCount in interface com.sas.sasserver.dataset.RemoteDataSetInterface

See Also:

StaticTableInterface.getRowCount()

setRootText

public void setRootText(java.lang.String p1)

Description copied from interface: DataSetInterface

Sets the root node text that will be used when the DataSetInterface is the model for a tree. By default, the data set name is returned as the root node. To change this behavior, call setRootText to return this new text from the getRoot method. To reset to the default behavior, set the root text to null.

Specified by:

setRootText in interface com.sas.sasserver.dataset.DataSetInterface

Parameters:

p1 - Text to return from the getRoot method

See Also:

DataSetInterface.getRootText()

setDisplayedColumns

public void setDisplayedColumns(java.lang.String[] p1)

Description copied from interface: DataTableInterface

Sets which columns in the model are displayed, or returned to the user. When displayed columns are specified, only those columns from the data set will be returned.

Specified by:

setDisplayedColumns in interface DataTableInterface

Parameters:

p1 - an array of column names to be displayed. The array should be in the order in which the columns should be returned.

getDataSetName

public java.lang.String getDataSetName()

Specified by:

getDataSetName in interface com.sas.sasserver.dataset.DataSetInterface

count

public int count()

Specified by:

count in interface com.sas.util.Countable

getBufferBlocks

public int getBufferBlocks()

Description copied from interface: DataTableInterface

Returns the numbr of buffer blocks. Each block is bufferSize rows from the data sets.

Specified by:

getBufferBlocks in interface DataTableInterface

Returns:

The number of buffer blocks.

See Also:

DataTableInterface.setBufferBlocks(int), DataTableInterface.setBufferSize(int), DataTableInterface.getBufferSize()

getBufferSize

public int getBufferSize()

Description copied from interface: DataTableInterface

Returns the number of rows which the data set caching fetches a look-ahead read.

Specified by:

getBufferSize in interface DataTableInterface

Returns:

The number of rows read per look-ahead read.

See Also:

DataTableInterface.setBufferSize(int), DataTableInterface.setBufferBlocks(int), DataTableInterface.getBufferBlocks()

setBufferSize

public void setBufferSize(int p1)

Description copied from interface: DataTableInterface

Sets the SAS data set buffering look-ahead size. When reading data from a (remote) SAS data set, reads are done a block at a time, to reduce the number of separate network method calls, then the rows are stored locally until they are purged from the internal cache. This parameter controls how many rows are read when doing this look-ahead reading. If it is critical that the data set not perform look-ahead reads, set this to 1. However, this may degrade performance.

Also settable via useBufferHints() with a bufferHint.how = BufferHintsInterface.LOOKAHEAD_SIZE

Specified by:

setBufferSize in interface DataTableInterface

See Also:

DataTableInterface.setBufferBlocks(int), DataTableInterface.getBufferSize(), DataTableInterface.setBufferSize(int)

getDisplayedColumns

public java.lang.String[] getDisplayedColumns()

Description copied from interface: DataTableInterface

Returns which columns in the model are displayed, or null for all columns (the default). When displayed columns are specified, only those columns from the data set will be returned.

Specified by:

getDisplayedColumns in interface DataTableInterface

Returns:

displayedColumns an array of column names which are displayed. The array will be in the order in which the columns are returned.

refresh

public void refresh()

Description copied from interface: DataTableInterface

refresh() causes the data in the dataset to be re-read from the SAS server.

Specified by:

refresh in interface DataTableInterface

getColumnInfoNames

public java.lang.String[] getColumnInfoNames()
                                      throws com.sas.table.TableException

Specified by:

getColumnInfoNames in interface com.sas.table.StaticColumnInfoInterface

Throws:

com.sas.table.TableException

_commitRow

public void _commitRow()

Description copied from interface: RemoteDataSetInterface

This method is for internal implementation only and should not be called by the user. commitRow should be called instead.

Specified by:

_commitRow in interface com.sas.sasserver.dataset.RemoteDataSetInterface

See Also:

DataTableInterface.commitRow()

_close

public int _close()

Description copied from interface: RemoteDataSetInterface

This method is for internal implementation only and should not be called by the user. close() should be called instead.

Specified by:

_close in interface com.sas.sasserver.dataset.RemoteDataSetInterface

See Also:

DataTableInterface.close()

isReadOnly

public boolean isReadOnly()

Description copied from interface: DataTableInterface

Returns whether the data set is read only or editable.

Specified by:

isReadOnly in interface DataTableInterface

Returns:

true for read only, false for editable.

See Also:

DataTableInterface.isReadOnly()

getDataSet

public java.lang.String getDataSet()

Description copied from interface: DataSetInterface

Returns the SAS data set name.

Specified by:

getDataSet in interface com.sas.sasserver.dataset.DataSetInterface

Returns:

dataSetName The SAS data set name.

See Also:

DataSetInterface.setDataSet(java.lang.String)

setFormattedCells

public void setFormattedCells(int p1,
                              int p2,
                              int p3,
                              int p4,
                              java.lang.String[][] p5)
                       throws com.sas.table.TableException

Description copied from interface: FormattedDataInterface

Specifies the formatted values for a block of cells. The block is identified by the intersection of a range of rows with a range of columns. startRowIndex and rowCount define the start and extent of the row range while startColumnIndex and columnCount define the column range. The set of formatted values is specified as a two-dimensional array, new Object[rowCount][colCount], with values[0][0] containing the value of the cell at (startRowIndex, startColumnIndex).

Specified by:

setFormattedCells in interface FormattedDataInterface

Parameters:

p1 - A one-based index that identifies the start of the row range.

p2 - A one-based index that identifies the start of the column range.

p3 - The number of rows in the row range.

p4 - The number of columns in the column range.

p5 - The new formatted values for each cell in the block.

Throws:

TableException - Thrown if the query can not be satisfied (e.g. i/o-failure).

See Also:

FormattedDataInterface.setFormattedCell(int, int, java.lang.String)

isRowsExtendable

public boolean isRowsExtendable()

Row addition is supported if the data set is open in update mode. Returns true if isCellsModifiable() returns true, indicating that the data set is open in update mode, false otherwise.

Specified by:

isRowsExtendable in interface RowTemplateTableInterface

Overrides:

isRowsExtendable in class SimpleTable

Returns:

Whether or not the data set is open in update mode

See Also:

RowTemplateTableInterface.isRowsExtendable()

getRootText

public java.lang.String getRootText()

Description copied from interface: DataSetInterface

Returns the root node text if it has been set through the setRootText method. If setRootText has not been called, the data set name is returned as the root node, and getRootText will return null indicating the default value. If setRootText has been called to change the default root node text, getRootText will return the new value. When getRootText returns null, call getRoot to retrieve the default root node.

Specified by:

getRootText in interface com.sas.sasserver.dataset.DataSetInterface

Returns:

rootText Text to return from the getRoot method

See Also:

DataSetInterface.setRootText(java.lang.String)

setWhere

public void setWhere(java.lang.String request)

Description copied from interface: DataTableInterface

Specifies the where clause to apply to the data set. The where clause is of the syntax for standard SAS data set where clauses and is not case sensitive.

Specified by:

setWhere in interface DataTableInterface

Parameters:

request - The where clause.

See Also:

DataTableInterface.getWhere()

setQuery

public void setQuery(java.lang.String request)

initializeAllData

protected void initializeAllData()

Initialize all the local data fields Note that this method reallocates all the local collections, while the clearAllData method clears the existing collections.

See Also:

clearAllData()

clearAllData

protected void clearAllData()

Clear all the data fields Note that this method clears all the local collections, while the initializeAllData method reallocates the collections.

See Also:

initializeAllData()