com.iplanet.jato.model
Class DatasetModelExecutionContextImpl

java.lang.Object
  |
  +--com.iplanet.jato.model.ModelExecutionContextBase
        |
        +--com.iplanet.jato.model.DatasetModelExecutionContextImpl
All Implemented Interfaces:
DatasetModelExecutionContext, ModelExecutionContext
Direct Known Subclasses:
DatasetSQLModelExecutionContext

public class DatasetModelExecutionContextImpl
extends ModelExecutionContextBase
implements DatasetModelExecutionContext

Execution context implementation used when executing dataset models. The methods in this interface define a dataset "window" which, after model execution, should comprise the entire available datasets of the executed model.

Version:
JATO/1.2.2 $Id: DatasetModelExecutionContextImpl.java,v 1.10 2002/03/16 03:26:30 todd Exp $

Fields inherited from interface com.iplanet.jato.model.DatasetModelExecutionContext
DATASET_OFFSET_BEGINNING, DATASET_OFFSET_END, DATASET_SIZE_ALL_INCREMENTAL, DATASET_SIZE_ALL_PREFETCH
 
Fields inherited from interface com.iplanet.jato.model.ModelExecutionContext
OPERATION_DELETE, OPERATION_EXECUTE, OPERATION_INSERT, OPERATION_RETRIEVE, OPERATION_UPDATE
 
Constructor Summary
DatasetModelExecutionContextImpl()
          Default constructor.
DatasetModelExecutionContextImpl(int datasetOffset, int datasetSize)
          Constructs an instance with the specified dataset offset and size.
DatasetModelExecutionContextImpl(java.lang.String operationName)
          Constructs an instance with the specified operation name.
DatasetModelExecutionContextImpl(java.lang.String operationName, int datasetOffset, int datasetSize)
          Constructs an instance with the specified operation name, dataset offset and size.
 
Method Summary
 int getDatasetOffset()
          Returns the base offset from an implementation- or context-dependent reference location that should used when retrieving a dataset.
 int getDatasetSize()
          Returns the total size of the dataset that should be fetched when retrieving data.
 void setDatasetOffset(int value)
          Sets the base offset from an implementation- or context-dependent reference location that should used when retrieving a dataset.
 void setDatasetSize(int value)
          Sets the total size of the dataset that should be fetched when retrieving data.
 
Methods inherited from class com.iplanet.jato.model.ModelExecutionContextBase
getOperationName, setOperationName
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.iplanet.jato.model.ModelExecutionContext
getOperationName
 

Constructor Detail

DatasetModelExecutionContextImpl

public DatasetModelExecutionContextImpl()
Default constructor. The operation name is implicitly set to ModelExecutionContext.OPERATION_RETRIEVE. The dataset offset is implicitly set to DatasetModelExecutionContext.DATASET_OFFSET_BEGINNING. The dataset size is implicitly set to DatasetModelExecutionContext.DATASET_SIZE_ALL_INCREMENTAL.

DatasetModelExecutionContextImpl

public DatasetModelExecutionContextImpl(java.lang.String operationName)
Constructs an instance with the specified operation name. The dataset offset is implicitly set to DatasetModelExecutionContext.DATASET_OFFSET_BEGINNING. The dataset size is implicitly set to DatasetModelExecutionContext.DATASET_SIZE_ALL_INCREMENTAL.
Parameters:
operationName - The name of the model execution operation

DatasetModelExecutionContextImpl

public DatasetModelExecutionContextImpl(int datasetOffset,
                                        int datasetSize)
Constructs an instance with the specified dataset offset and size. The operation name is implicitly set to ModelExecutionContext.OPERATION_RETRIEVE.
Parameters:
datasetOffset - The positive dataset offset, or one of DatasetModelExecutionContext.DATASET_OFFSET_BEGINNING or DatasetModelExecutionContext.DATASET_OFFSET_END. There may be some significant restrictions on use of these size directives depending on the model implementation.
datasetSize - The total dataset size, or one of the special size directives (one one of DatasetModelExecutionContext.DATASET_SIZE_ALL_PREFETCH or DatasetModelExecutionContext.DATASET_SIZE_ALL_INCREMENTAL . If a non-special size value (a positive number) is specified here, the executing model operates in prefetch mode. If incremental fetch is specified, then the dataset size is not fixed or necessarily known. There may be some significant restrictions on use of these size directives depending on the model implementation.
See Also:
DatasetModelExecutionContext.DATASET_OFFSET_BEGINNING, DatasetModelExecutionContext.DATASET_OFFSET_END, DatasetModelExecutionContext.DATASET_SIZE_ALL_PREFETCH, DatasetModelExecutionContext.DATASET_SIZE_ALL_INCREMENTAL

DatasetModelExecutionContextImpl

public DatasetModelExecutionContextImpl(java.lang.String operationName,
                                        int datasetOffset,
                                        int datasetSize)
Constructs an instance with the specified operation name, dataset offset and size.
Parameters:
operationName - The name of the model execution operation
datasetOffset - The positive dataset offset, or one of DatasetModelExecutionContext.DATASET_OFFSET_BEGINNING or DatasetModelExecutionContext.DATASET_OFFSET_END. There may be some significant restrictions on use of these size directives depending on the model implementation.
datasetSize - The total dataset size, or one of the special size directives (one one of DatasetModelExecutionContext.DATASET_SIZE_ALL_PREFETCH or DatasetModelExecutionContext.DATASET_SIZE_ALL_INCREMENTAL . If a non-special size value (a positive number) is specified here, the executing model operates in prefetch mode. If incremental fetch is specified, then the dataset size is not fixed or necessarily known. There may be some significant restrictions on use of these size directives depending on the model implementation.
See Also:
DatasetModelExecutionContext.DATASET_OFFSET_BEGINNING, DatasetModelExecutionContext.DATASET_OFFSET_END, DatasetModelExecutionContext.DATASET_SIZE_ALL_PREFETCH, DatasetModelExecutionContext.DATASET_SIZE_ALL_INCREMENTAL
Method Detail

getDatasetOffset

public int getDatasetOffset()
Returns the base offset from an implementation- or context-dependent reference location that should used when retrieving a dataset. Normally, after execution of a model with a positive offset, the DatasetModelControl.first() should be positioned at the location defined by the offset.
Specified by:
getDatasetOffset in interface DatasetModelExecutionContext
Returns:
The implementation- or context-dependent offset location, or one of the special offset directives. There may be some significant restrictions on use of these offset directives depending on the model implementation.

setDatasetOffset

public void setDatasetOffset(int value)
Sets the base offset from an implementation- or context-dependent reference location that should used when retrieving a dataset. Normally, after execution of a model with a positive offset, the DatasetModelControl.first() should be positioned at the location defined by the offset.
Parameters:
datasetOffset - The positive dataset offset, or one of DatasetModelExecutionContext.DATASET_OFFSET_BEGINNING or DatasetModelExecutionContext.DATASET_OFFSET_END. There may be some significant restrictions on use of these size directives depending on the model implementation.
See Also:
DatasetModelExecutionContext.DATASET_OFFSET_BEGINNING, DatasetModelExecutionContext.DATASET_OFFSET_END

getDatasetSize

public int getDatasetSize()
Returns the total size of the dataset that should be fetched when retrieving data. For example, this method might specify the number of rows to retrieve from a SQL query.
Specified by:
getDatasetSize in interface DatasetModelExecutionContext
Returns:
The total dataset size, or one of the special size directives (one one of DatasetModelExecutionContext.DATASET_SIZE_ALL_PREFETCH or DatasetModelExecutionContext.DATASET_SIZE_ALL_INCREMENTAL . If a non-special size value (a positive number) is specified here, the executing model operates in prefetch mode. If incremental fetch is specified, then the dataset size is not fixed or necessarily known. There may be some significant restrictions on use of these size directives depending on the model implementation.

setDatasetSize

public void setDatasetSize(int value)
Sets the total size of the dataset that should be fetched when retrieving data. For example, this method might specify the number of rows to retrieve from a SQL query.
Parameters:
value - The total dataset size, or one of the special size directives (one one of DatasetModelExecutionContext.DATASET_SIZE_ALL_PREFETCH or DatasetModelExecutionContext.DATASET_SIZE_ALL_INCREMENTAL . If a non-special size value (a positive number) is specified here, the executing model operates in prefetch mode. If incremental fetch is specified, then the dataset size is not fixed or necessarily known. There may be some significant restrictions on use of these size directives depending on the model implementation.
See Also:
DatasetModelExecutionContext.DATASET_SIZE_ALL_PREFETCH, DatasetModelExecutionContext.DATASET_SIZE_ALL_INCREMENTAL