DataSource (P2J - Progress 4GL to Java Conversion and Runtime)

java.lang.Object
- com.goldencode.p2j.util.HandleResource
- - com.goldencode.p2j.util.HandleChain
  - - com.goldencode.p2j.persist.DataSource

All Implemented Interfaces:

DataSourceInterface, Keyable, QueryAssociable, ADMData, CommonHandle, CommonHandleChain, Deletable, DynamicResource, InstantiatingProcedure, Nameable, WrappedResource, Printable
```
public class DataSource
extends HandleChain
implements ADMData, DataSourceInterface, DynamicResource, Keyable, QueryAssociable
```
A data-source object supports the automatic filling of a DataSet object member table, as well as applying updates back to one or more database tables. There is a distinct data-source object for each member buffer, which allows a single ProDataSet object and a single FILL operation on that object to combine data from multiple databases. A data-source object is defined independently of any DataSet object.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`class`	`DataSource.Builder` Builder class that helps construct a `DataSource` object statically, that is, using the `DEFINE DataSource` statement.
`static class`	`DataSource.FieldReference` A reference to a field of a buffer.

Field Summary

Fields
Modifier and Type	Field and Description
`private java.lang.String`	`_fillWhereString` The current value of `FILL-WHERE-STRING` attribute, if set programmatically.
`private java.lang.String`	`admData` The value of `ADM-DATA` ABL attribute.
`private java.util.List<org.apache.commons.lang3.tuple.Pair<java.lang.String,DataSource.FieldReference>>`	`buf2dsrc` The current mapping between the `datasetBuffer` and fields from this object.
`private java.util.List<BufferImpl>`	`buffers` The list of buffers of this `DataSource`.
`private DataSource.Builder`	`builder` Temporary builder during the DEFINE process.
`private BufferImpl`	`datasetBuffer` The `Buffer` attached to this `DataSource`.
`private boolean`	`deleted` Flag indicating if this resource has been deleted.
`private boolean`	`dynamic` Flags the dynamically constructed objects (using `CREATE` as opposed to statically defined objects, with `DEFINE`).
`private handle`	`hExplicitQuery` The handle to the optional explicit query that defines the buffers for the data-source object.
`private handle`	`hImplicitQuery` The handle to the implicit query that defines the buffers for the data-source object.
`private boolean`	`mergeByField` The current value of the `MERGE-BY-FIELD` attribute.
`private java.util.Map<BufferImpl,java.lang.Long>`	`nextRowids` The current values of NEXT-ROWID attributes.
`private boolean`	`preferDataset` The current value of the `PREFER-DATASET` attribute.
`private long`	`restartRow` The current values of RESTART-ROW attribute.
`private java.util.Map<BufferImpl,java.lang.Long>`	`restartRowids` The current values of RESTART-ROWID attributes.
`private java.util.Map<java.lang.String,java.lang.String>`	`revBuf2src` The reversed `buf2dsrc` map.
`static java.lang.String`	`ROWID_KEY` Marker for added buffers which use their ROWID instead of a field-formed unique key.
`private java.util.Map<Buffer,java.lang.String[]>`	`saveWhereStrings` The values of `SAVE-WHERE-STRING` attribute, mapped by their buffers.

Fields inherited from class com.goldencode.p2j.util.HandleChain
name, nextSibling, prevSibling, wa

Fields inherited from class com.goldencode.p2j.util.HandleResource
instProc, pm

Constructor Summary

Constructors
Modifier Constructor and Description

private DataSource(boolean staticDef)
The private constructor.

Constructors
Modifier	Constructor and Description
`private`	`DataSource(boolean staticDef)` The private constructor.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`_dynamic()` Returns `true` if the buffer is dynamic.
`(package private) int`	`_getNumSourceBuffers()` Obtain the number of source buffers in this data-source object.
`logical`	`addSourceBuffer(Buffer buf)` Adds a database buffer to a data-source object at run time.
`logical`	`addSourceBuffer(handle hBuf, java.lang.String keyFields)` Adds a database buffer to a dynamic data-source object at run time.
`logical`	`addSourceBuffer(handle hBuf, Text keyFields)` Adds a database buffer to a dynamic data-source object at run time.
`private logical`	`addSourceBufferImpl(BufferImpl buffer, java.lang.String[] keyFields)` Actual implementation of `ADD-SOURCE-BUFFER` method.
`(package private) void`	`attach(BufferImpl buffer, java.util.List<org.apache.commons.lang3.tuple.Pair<java.lang.String,DataSource.FieldReference>> buf2dsrc)` Attaches or detaches the dataset buffer to this source (sets the dataset buffer).
`private java.lang.String`	`computeFillWhereString()` Computes the value of `FILL-WHERE-STRING` attribute at this moment.
`static void`	`create(handle dsHandle)` Factory method.
`static void`	`create(handle dsHandle, character widgetPool)` Factory method.
`static void`	`create(handle dsHandle, java.lang.String widgetPool)` Factory method.
`private boolean`	`createImplicitQuery()` Creates and prepares the implicit query.
`static DataSource.Builder`	`define()` Deprecated.
`static DataSource.Builder`	`define(java.lang.String legacyName)` Starts the definition of a new static `DataSource`.
`character`	`getADMData()` Get the value of the ADM-DATA attribute.
`handle`	`getDatasetBuffer()` Gets the handle to the source buffer attached/associated with this `DataSource`.
`character`	`getFillWhereString()` Gets the current `WHERE` expression for a data-source query, beginning with the keyword `WHERE`, and not including the prior `FOR EACH` phrase of an `OPEN QUERY` statement.
`logical`	`getMergeByField()` Checks whether the changes on a field-by-field basis will be merged when saving changes from a `DataSet` temp-table buffer to the associated data source using the `SAVE-ROW-CHANGES()` method.
`rowid`	`getNextRowid()` Gets the `ROWID` of the data source row at which the next `FILL` operation should start.
`rowid`	`getNextRowid(character buffName)` Gets the `ROWID` of the data source row at which the next `FILL` operation should start.
`rowid`	`getNextRowid(long buffNo)` Gets the `ROWID` of the data source row at which the next `FILL` operation should start.
`rowid`	`getNextRowid(NumberType buffNo)` Gets the `ROWID` of the data source row at which the next `FILL` operation should start.
`rowid`	`getNextRowid(java.lang.String buffName)` Gets the `ROWID` of the data source row at which the next `FILL` operation should start.
`handle`	`getNextSibling()` Get the `NEXT-SIBLING` attribute of this DataSource.
`integer`	`getNumSourceBuffers()` Obtain the number of source buffers in this data-source object.
`logical`	`getPreferDataset()` Checks whether the modifications to the data currently in the data source are ignored when saving changes from a `DataSet` temp-table buffer to the associated data source using the `SAVE-ROW-CHANGES()` method.
`handle`	`getPrevSibling()` Get the `PREV-SIBLING` attribute of this DataSource.
`handle`	`getQueryAsHandle()` Get the query associated with the given resource.
`integer`	`getRestartRow()` Gets the current position (absolute row number) for the `FILL` query.
`rowid`	`getRestartRowid()` Obtain the `ROWID` of the data source row at which a `FILL` operation will start.
`rowid`	`getRestartRowid(long buffNum)` Obtain the `ROWID` of the data source row at which a `FILL` operation will start.
`rowid`	`getRestartRowid(NumberType buffNum)` Obtain the `ROWID` of the data source row at which a `FILL` operation will start.
`rowid`	`getRestartRowid(java.lang.String buffName)` Obtain the `ROWID` of the data source row at which a `FILL` operation will start.
`rowid`	`getRestartRowid(Text buffName)` Obtain the `ROWID` of the data source row at which a `FILL` operation will start.
`(package private) java.lang.Long[]`	`getRestartRowids()` Get the list of `RESTART-ROWID`-s for this `DataSource`.
`character`	`getSaveWhereString()` Obtain the `WHERE` clause used to find the database buffer identified by the `buffName` in a data-source object.
`character`	`getSaveWhereString(long buffNum)` Obtain the `WHERE` clause used to find the database buffer identified by the `buffName` in a data-source object.
`character`	`getSaveWhereString(NumberType buffNum)` Obtain the `WHERE` clause used to find the database buffer identified by the `buffName` in a data-source object.
`character`	`getSaveWhereString(java.lang.String buffName)` Obtain the `WHERE` clause used to find the database buffer identified by the `buffName` in a data-source object.
`character`	`getSaveWhereString(Text buffName)` Obtain the `WHERE` clause used to find the database buffer identified by the `buffName` in a data-source object.
`(package private) java.lang.String`	`getSaveWhereStringImpl(Buffer buf, boolean useBefore)` Get the current value of `SAVE-WHERE-STRING` for a specified `Buffer`.
`handle`	`getSourceBuffer()` Gets the handle to the source buffer in the data-source object at the specified index position.
`handle`	`getSourceBuffer(long bufIndex)` Gets the handle to the source buffer in the data-source object at the specified index position.
`handle`	`getSourceBuffer(NumberType bufIndex)` Gets the handle to the source buffer in the data-source object at the specified index position.
`(package private) int`	`getSourceBufferIndex(java.lang.String bufName)` Get a source buffer by its name.
`BufferImpl`	`getSourceBufferNative()` Gets the handle to the source buffer in the data-source object at the specified index position.
`BufferImpl`	`getSourceBufferNative(long bufIndex)` Gets the handle to the source buffer in the data-source object at the specified index position.
`(package private) boolean`	`hasExplicitQuery()` Test whether at current moment this data-source has an explicit query configured.
`protected boolean`	`hasNameConstraints()` Allows each resource to declare whether it has some naming constraints.
`protected boolean`	`hasNameReadOnly()` Check if this resource supports the NAME attribute in read-only mode.
`private boolean`	`isAlterable()` Checks whether this object can be altered (added buffers and relations).
`logical`	`isIgnoreCurrentModified()` Checks whether the to ignores modifications to the data currently in the data source when saving changes from a `DataSet` temp-table buffer to the associated data source using the `Buffer.saveRowChanges()` method.
`character`	`keys()` Obtain the list of key fields of a specified buffer as a comma-separated list.
`character`	`keys(long seqNum)` Obtain the list of key fields of a specified buffer as a comma-separated list.
`character`	`keys(NumberType seqNum)` Obtain the list of key fields of a specified buffer as a comma-separated list.
`protected boolean`	`resourceDelete()` Delete the resource.
`void`	`setADMData(character value)` Set the value of the ADM-DATA attribute.
`void`	`setADMData(java.lang.String value)` Set the value of the ADM-DATA attribute.
`void`	`setFillWhereString(java.lang.String pref)` Sets the current `WHERE` expression for a data-source query, beginning with the keyword `WHERE`, and not including the prior `FOR EACH` phrase of an `OPEN QUERY` statement.
`void`	`setFillWhereString(Text pref)` Sets the current `WHERE` expression for a data-source query, beginning with the keyword `WHERE`, and not including the prior `FOR EACH` phrase of an `OPEN QUERY` statement.
`void`	`setIgnoreCurrentModified(boolean on)` Sets whether the to ignores modifications to the data currently in the data source when saving changes from a `DataSet` temp-table buffer to the associated data source using the `Buffer.saveRowChanges()` method.
`void`	`setIgnoreCurrentModified(logical on)` Sets whether the to ignores modifications to the data currently in the data source when saving changes from a `DataSet` temp-table buffer to the associated data source using the `Buffer.saveRowChanges()` method.
`void`	`setMergeByField(boolean merge)` Configures whether the changes on a field-by-field basis will be merged when saving changes from a `DataSet` temp-table buffer to the associated data source using the `SAVE-ROW-CHANGES()` method.
`void`	`setMergeByField(logical merge)` Configures whether the changes on a field-by-field basis will be merged when saving changes from a `DataSet` temp-table buffer to the associated data source using the `SAVE-ROW-CHANGES()` method.
`void`	`setNextRowid(character buffName, rowid row)` Sets the `ROWID` of the data source row at which the next `FILL` operation should start.
`void`	`setNextRowid(long buffNo, rowid row)` Sets the `ROWID` of the data source row at which the next `FILL` operation should start.
`void`	`setNextRowid(NumberType buffNo, rowid row)` Sets the `ROWID` of the data source row at which the next `FILL` operation should start.
`void`	`setNextRowid(rowid row)` Sets the `ROWID` of the data source row at which the next `FILL` operation should start.
`void`	`setNextRowid(java.lang.String buffName, rowid row)` Sets the `ROWID` of the data source row at which the next `FILL` operation should start.
`void`	`setPreferDataset(boolean pref)` Configures whether the modifications to the data currently in the data source are ignored when saving changes from a `DataSet` temp-table buffer to the associated data source using the `SAVE-ROW-CHANGES()` method.
`void`	`setPreferDataset(logical pref)` Configures whether the modifications to the data currently in the data source are ignored when saving changes from a `DataSet` temp-table buffer to the associated data source using the `SAVE-ROW-CHANGES()` method.
`void`	`setQueryAsHandle(handle qry)` Set the query associated with the given resource.
`void`	`setQueryAsHandle(QueryWrapper qry)` Set the query associated with the given resource.
`private void`	`setQueryImpl(handle hQry)` The implementation of assignation of QUERY attribute.
`void`	`setRestartRow(long newRow)` Reposition the `FILL` query to an absolute row number.
`void`	`setRestartRow(NumberType newRow)` Reposition the `FILL` query to an absolute row number.
`void`	`setRestartRowid(long buffNum, rowid row)` Configures the `ROWID` of the data source row at which a `FILL` operation will start.
`void`	`setRestartRowid(NumberType buffNum, rowid row)` Configures the `ROWID` of the data source row at which a `FILL` operation will start.
`void`	`setRestartRowid(rowid row)` Configures the `ROWID` of the data source row at which a `FILL` operation will start.
`void`	`setRestartRowid(java.lang.String buffName, rowid row)` Configures the `ROWID` of the data source row at which a `FILL` operation will start.
`void`	`setRestartRowid(Text buffName, rowid row)` Configures the `ROWID` of the data source row at which a `FILL` operation will start.
`void`	`setSaveWhereString(long buffNum, java.lang.String val)` Configures the `SAVE-WHERE-STRING` attribute.
`void`	`setSaveWhereString(long buffNum, Text val)` Configures the `SAVE-WHERE-STRING` attribute.
`void`	`setSaveWhereString(NumberType buffNum, java.lang.String val)` Configures the `SAVE-WHERE-STRING` attribute.
`void`	`setSaveWhereString(NumberType buffNum, Text val)` Configures the `SAVE-WHERE-STRING` attribute.
`void`	`setSaveWhereString(java.lang.String val)` Configures the `SAVE-WHERE-STRING` attribute.
`void`	`setSaveWhereString(java.lang.String buffName, java.lang.String val)` Configures the `SAVE-WHERE-STRING` attribute.
`void`	`setSaveWhereString(java.lang.String buffName, Text val)` Configures the `SAVE-WHERE-STRING` attribute.
`void`	`setSaveWhereString(Text val)` Configures the `SAVE-WHERE-STRING` attribute.
`void`	`setSaveWhereString(Text buffName, java.lang.String val)` Configures the `SAVE-WHERE-STRING` attribute.
`void`	`setSaveWhereString(Text buffName, Text val)` Configures the `SAVE-WHERE-STRING` attribute.
`java.lang.String`	`toString()` Gets a string representation of the `DataSource` object which contains the name, the buffers list and some details on the active queries, inlcluding their `FILL-WHERE-STRING` and `PREPARE-STRING`.
`(package private) void`	`updateFillRowidInfo(boolean success)` Updates the FILL internal data, preparing it for the next batch, if any.
`boolean`	`valid()` Reports if this object is valid for use.

Methods inherited from class com.goldencode.p2j.util.HandleChain
_name, delete, firstResource, firstResource, getHead, getNextSibling, getPrevSibling, getPrivateData, getTail, hasName, hasNextSibling, hasParent, hasPrevSibling, hasPrivateData, interlink, isChained, lastResource, lastResource, moveInChain, name, name, name, readOnlyError, readOnlyError, resolveChainType, setHead, setNextSibling, setNextSibling, setPrevSibling, setPrevSibling, setPrivateData, setPrivateData, setPrivateData, validateName

Methods inherited from class com.goldencode.p2j.util.HandleResource
_instantiatingProcedure, addToPool, doDelete, equals, hashCode, id, id, implicitDeletion, incrementTrigger, instantiatingProcedure, invalidAttribute, processResource, registerResource, resourceType, setInstantiatingProcedure, type, unableToAssignUnknown, unknown

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.goldencode.p2j.persist.DataSourceInterface
getPrivateData, setPrivateData, setPrivateData

Methods inherited from interface com.goldencode.p2j.util.DynamicResource
dynamic

Methods inherited from interface com.goldencode.p2j.util.CommonHandle
resourceType

Methods inherited from interface com.goldencode.p2j.util.WrappedResource
id, id, unknown

Methods inherited from interface com.goldencode.util.Printable
asString, print

Methods inherited from interface com.goldencode.p2j.util.Deletable
allowDelete

- Field Detail
  - ROWID_KEY
```
public static final java.lang.String ROWID_KEY
```
    Marker for added buffers which use their ROWID instead of a field-formed unique key.
    
    See Also:
    
    Constant Field Values
  - dynamic
```
private final boolean dynamic
```
    Flags the dynamically constructed objects (using CREATE as opposed to statically defined objects, with DEFINE).
  - deleted
```
private boolean deleted
```
    Flag indicating if this resource has been deleted.
  - builder
```
private DataSource.Builder builder
```
    Temporary builder during the DEFINE process. Defines the DataSource using a chaining set of methods that ends with the registration of the (new) DataSource.
  - admData
```
private java.lang.String admData
```
    The value of ADM-DATA ABL attribute.
  - buffers
```
private final java.util.List<BufferImpl> buffers
```
    The list of buffers of this DataSource.
  - nextRowids
```
private final java.util.Map<BufferImpl,java.lang.Long> nextRowids
```
    The current values of NEXT-ROWID attributes.
  - restartRowids
```
private final java.util.Map<BufferImpl,java.lang.Long> restartRowids
```
    The current values of RESTART-ROWID attributes.
  - restartRow
```
private long restartRow
```
    The current values of RESTART-ROW attribute.
  - datasetBuffer
```
private BufferImpl datasetBuffer
```
    The Buffer attached to this DataSource. It must be a DataSet buffer.
  - hImplicitQuery
```
private handle hImplicitQuery
```
    The handle to the implicit query that defines the buffers for the data-source object.
  - hExplicitQuery
```
private handle hExplicitQuery
```
    The handle to the optional explicit query that defines the buffers for the data-source object. If this is not null and valid, it will take precedence before hImplicitQuery.
  - preferDataset
```
private boolean preferDataset
```
    The current value of the PREFER-DATASET attribute. Default value is false.
  - mergeByField
```
private boolean mergeByField
```
    The current value of the MERGE-BY-FIELD attribute. Default value is true.
  - _fillWhereString
```
private java.lang.String _fillWhereString
```
    The current value of FILL-WHERE-STRING attribute, if set programmatically. The default value is null / unknown, but this value cannot be set programmatically, at runtime.
  - buf2dsrc
```
private java.util.List<org.apache.commons.lang3.tuple.Pair<java.lang.String,DataSource.FieldReference>> buf2dsrc
```
    The current mapping between the datasetBuffer and fields from this object.
  - revBuf2src
```
private java.util.Map<java.lang.String,java.lang.String> revBuf2src
```
    The reversed buf2dsrc map.
  - saveWhereStrings
```
private final java.util.Map<Buffer,java.lang.String[]> saveWhereStrings
```
    The values of SAVE-WHERE-STRING attribute, mapped by their buffers.
- Constructor Detail
  - DataSource
```
private DataSource(boolean staticDef)
```
    The private constructor.
    
    Parameters:
    
    staticDef - true when constructor is called form a static DEFINE DATA-SET statement and false when called from a CREATE DATA-SET statement.
- Method Detail
  - create
```
public static void create(handle dsHandle)
```
    Factory method. Corresponds to CREATE DATASOURCE statement. Creates a new DataSource and stores the object in the supplied handle.
    
    Parameters:
    
    dsHandle - The destination handle.
  - create
```
public static void create(handle dsHandle,
                          java.lang.String widgetPool)
```
    Factory method. Corresponds to CREATE DATASOURCE statement. Creates a new DataSource and stores the object in the supplied handle.
    
    Parameters:
    
    dsHandle - The destination handle.
    
    widgetPool - The widget pool to created the new DataSource into.
  - create
```
public static void create(handle dsHandle,
                          character widgetPool)
```
    Factory method. Corresponds to CREATE DATASOURCE statement. Creates a new DataSource and stores the object in the supplied handle.
    
    Parameters:
    
    dsHandle - The destination handle.
    
    widgetPool - The widget pool to created the new DataSource into.
  - define
```
@Deprecated
public static DataSource.Builder define()
```
    Deprecated.
    
    Starts the definition of a new static DataSource. This corresponds to the static DEFINE DATA-SOURCE statement.
    
    Returns:
    
    A Builder object used to chain the options of the statement.
  - define
```
public static DataSource.Builder define(java.lang.String legacyName)
```
    Starts the definition of a new static DataSource. This corresponds to the static DEFINE DATA-SOURCE statement.
    
    Parameters:
    
    legacyName - The legacy name of the DATA-SOURCE.
    
    Returns:
    
    A Builder object used to chain the options of the statement.
  - hasNameReadOnly
```
protected boolean hasNameReadOnly()
```
    Check if this resource supports the NAME attribute in read-only mode.
    
    Overrides:
    
    hasNameReadOnly in class HandleChain
    
    Returns:
    
    false, allowing the name to be altered.
  - hasNameConstraints
```
protected boolean hasNameConstraints()
```
    Allows each resource to declare whether it has some naming constraints.
    
    Overrides:
    
    hasNameConstraints in class HandleChain
    
    Returns:
    
    This method always returns false, requiring that its name should be validated before assignment.
    
    See Also:
    
    HandleChain.validateName(java.lang.String)
  - _dynamic
```
public boolean _dynamic()
```
    Returns true if the buffer is dynamic.
    This is not emitted by conversion, is used internally by FWD.
    
    Specified by:
    
    _dynamic in interface DynamicResource
    
    Returns:
    
    true if the resource is dynamic, false otherwise.
  - valid
```
public boolean valid()
```
    Reports if this object is valid for use.
    
    Specified by:
    
    valid in interface WrappedResource
    
    Returns:
    
    true if we are valid (can be used).
  - getPrevSibling
```
public handle getPrevSibling()
```
    Get the PREV-SIBLING attribute of this DataSource. Actually always returns null because this attribute is not supported by DataSources. Only NEXT-SIBLING is supported.
    
    Specified by:
    
    getPrevSibling in interface CommonHandleChain
    
    Overrides:
    
    getPrevSibling in class HandleChain
    
    Returns:
    
    Always null.
  - getNextSibling
```
public handle getNextSibling()
```
    Get the NEXT-SIBLING attribute of this DataSource. Actually always returns the super's getPrevSibling() because DataSets are queued in reverse order(!).
    TODO: investigate other handle resource that manifest the same from the point of NEXT/PREV-SIBLING.
    
    Specified by:
    
    getNextSibling in interface CommonHandleChain
    
    Overrides:
    
    getNextSibling in class HandleChain
    
    Returns:
    
    Always null.
  - getADMData
```
public character getADMData()
```
    Get the value of the ADM-DATA attribute.
    
    Specified by:
    
    getADMData in interface ADMData
    
    Returns:
    
    See above.
  - setADMData
```
public void setADMData(java.lang.String value)
```
    Set the value of the ADM-DATA attribute.
    
    Specified by:
    
    setADMData in interface ADMData
    
    Parameters:
    
    value - The new value.
  - setADMData
```
public void setADMData(character value)
```
    Set the value of the ADM-DATA attribute.
    
    Specified by:
    
    setADMData in interface ADMData
    
    Parameters:
    
    value - The new value.
  - getQueryAsHandle
```
public handle getQueryAsHandle()
```
    Get the query associated with the given resource.
    
    Specified by:
    
    getQueryAsHandle in interface QueryAssociable
    
    Returns:
    
    The associated query or unknown if none exists.
  - setQueryAsHandle
```
public void setQueryAsHandle(handle qry)
```
    Set the query associated with the given resource. If an explicit query was previously set and now an unknown handle is use, the implicit handle is restored.
    
    Specified by:
    
    setQueryAsHandle in interface QueryAssociable
    
    Parameters:
    
    qry - The query to associate.
  - setQueryAsHandle
```
public void setQueryAsHandle(QueryWrapper qry)
```
    Set the query associated with the given resource.
    
    Specified by:
    
    setQueryAsHandle in interface QueryAssociable
    
    Parameters:
    
    qry - The query to associate.
  - getPreferDataset
```
public logical getPreferDataset()
```
    Checks whether the modifications to the data currently in the data source are ignored when saving changes from a DataSet temp-table buffer to the associated data source using the SAVE-ROW-CHANGES() method. The default value is FALSE.
    
    Specified by:
    
    getPreferDataset in interface DataSourceInterface
    
    Returns:
    
    the current value of PREFER-DATASET attribute, as described above.
  - setPreferDataset
```
public void setPreferDataset(logical pref)
```
    Configures whether the modifications to the data currently in the data source are ignored when saving changes from a DataSet temp-table buffer to the associated data source using the SAVE-ROW-CHANGES() method.
    This attribute is synonym to IGNORE-CURRENT-MODIFIED. The latter one is deprecated, but its name is reported in exception message.
    
    Specified by:
    
    setPreferDataset in interface DataSourceInterface
    
    Parameters:
    
    pref - the new value of PREFER-DATASET attribute, as described above.
  - setPreferDataset
```
public void setPreferDataset(boolean pref)
```
    Configures whether the modifications to the data currently in the data source are ignored when saving changes from a DataSet temp-table buffer to the associated data source using the SAVE-ROW-CHANGES() method.
    
    Specified by:
    
    setPreferDataset in interface DataSourceInterface
    
    Parameters:
    
    pref - the new value of PREFER-DATASET attribute, as described above.
  - getFillWhereString
```
public character getFillWhereString()
```
    Gets the current WHERE expression for a data-source query, beginning with the keyword WHERE, and not including the prior FOR EACH phrase of an OPEN QUERY statement.
    
    Specified by:
    
    getFillWhereString in interface DataSourceInterface
    
    Returns:
    
    The current value of the FILL-WHERE-STRING attribute, as described above.
  - setFillWhereString
```
public void setFillWhereString(java.lang.String pref)
```
    Sets the current WHERE expression for a data-source query, beginning with the keyword WHERE, and not including the prior FOR EACH phrase of an OPEN QUERY statement.
    
    Specified by:
    
    setFillWhereString in interface DataSourceInterface
    
    Parameters:
    
    pref - The new value of the FILL-WHERE-STRING attribute, as described above.
  - setFillWhereString
```
public void setFillWhereString(Text pref)
```
    Sets the current WHERE expression for a data-source query, beginning with the keyword WHERE, and not including the prior FOR EACH phrase of an OPEN QUERY statement.
    
    Specified by:
    
    setFillWhereString in interface DataSourceInterface
    
    Parameters:
    
    pref - The new value of the FILL-WHERE-STRING attribute, as described above.
  - keys
```
public character keys()
```
    Obtain the list of key fields of a specified buffer as a comma-separated list.
    
    Specified by:
    
    keys in interface Keyable
    
    Returns:
    
    the list of key fields for the requested buffer.
  - keys
```
public character keys(long seqNum)
```
    Obtain the list of key fields of a specified buffer as a comma-separated list.
    
    Specified by:
    
    keys in interface Keyable
    
    Parameters:
    
    seqNum - The index of the buffer in the list of buffer for this DataSource.
    
    Returns:
    
    the list of key fields for the requested buffer.
  - keys
```
public character keys(NumberType seqNum)
```
    Obtain the list of key fields of a specified buffer as a comma-separated list.
    
    Specified by:
    
    keys in interface Keyable
    
    Parameters:
    
    seqNum - The index of the buffer in the list of buffer for this DataSource.
    
    Returns:
    
    the list of key fields for the requested buffer.
  - getMergeByField
```
public logical getMergeByField()
```
    Checks whether the changes on a field-by-field basis will be merged when saving changes from a DataSet temp-table buffer to the associated data source using the SAVE-ROW-CHANGES() method. The default value is TRUE.
    
    Specified by:
    
    getMergeByField in interface DataSourceInterface
    
    Returns:
    
    true if the changes are merged on save on a field-by-field basis.
  - setMergeByField
```
public void setMergeByField(boolean merge)
```
    Configures whether the changes on a field-by-field basis will be merged when saving changes from a DataSet temp-table buffer to the associated data source using the SAVE-ROW-CHANGES() method.
    
    Specified by:
    
    setMergeByField in interface DataSourceInterface
    
    Parameters:
    
    merge - The new value for the MERGE-BY-FIELD attribute.
  - setMergeByField
```
public void setMergeByField(logical merge)
```
    Configures whether the changes on a field-by-field basis will be merged when saving changes from a DataSet temp-table buffer to the associated data source using the SAVE-ROW-CHANGES() method.
    
    Specified by:
    
    setMergeByField in interface DataSourceInterface
    
    Parameters:
    
    merge - The new value for the MERGE-BY-FIELD attribute.
  - getNextRowid
```
public rowid getNextRowid()
```
    Gets the ROWID of the data source row at which the next FILL operation should start. The attribute is set after each FILL operation in a series of FILL operations to retrieve data source rows in batches.
    
    Specified by:
    
    getNextRowid in interface DataSourceInterface
    
    Returns:
    
    The current value of code NEXT-ROWID as described above.
  - getNextRowid
```
public rowid getNextRowid(NumberType buffNo)
```
    Gets the ROWID of the data source row at which the next FILL operation should start. The attribute is set after each FILL operation in a series of FILL operations to retrieve data source rows in batches.
    
    Specified by:
    
    getNextRowid in interface DataSourceInterface
    
    Parameters:
    
    buffNo - the sequence number of a buffer in the list of buffers for the data-source object.
    
    Returns:
    
    The current value of code NEXT-ROWID as described above.
  - getNextRowid
```
public rowid getNextRowid(long buffNo)
```
    Gets the ROWID of the data source row at which the next FILL operation should start. The attribute is set after each FILL operation in a series of FILL operations to retrieve data source rows in batches.
    
    Specified by:
    
    getNextRowid in interface DataSourceInterface
    
    Parameters:
    
    buffNo - the sequence number of a buffer in the list of buffers for the data-source object.
    
    Returns:
    
    The current value of code NEXT-ROWID as described above.
  - getNextRowid
```
public rowid getNextRowid(java.lang.String buffName)
```
    Gets the ROWID of the data source row at which the next FILL operation should start. The attribute is set after each FILL operation in a series of FILL operations to retrieve data source rows in batches.
    
    Specified by:
    
    getNextRowid in interface DataSourceInterface
    
    Parameters:
    
    buffName - The name of a buffer in the list of buffers for the data-source object.
    
    Returns:
    
    The current value of code NEXT-ROWID as described above.
  - getNextRowid
```
public rowid getNextRowid(character buffName)
```
    Gets the ROWID of the data source row at which the next FILL operation should start. The attribute is set after each FILL operation in a series of FILL operations to retrieve data source rows in batches.
    
    Specified by:
    
    getNextRowid in interface DataSourceInterface
    
    Parameters:
    
    buffName - The name of a buffer in the list of buffers for the data-source object.
    
    Returns:
    
    The current value of code NEXT-ROWID as described above.
  - setNextRowid
```
public void setNextRowid(rowid row)
```
    Sets the ROWID of the data source row at which the next FILL operation should start. Typically, the value of this attribute is assigned to the RESTART-ROWID attribute before each FILL operation.
    
    Specified by:
    
    setNextRowid in interface DataSourceInterface
    
    Parameters:
    
    row - The new value of code NEXT-ROWID as described above.
  - setNextRowid
```
public void setNextRowid(NumberType buffNo,
                         rowid row)
```
    Sets the ROWID of the data source row at which the next FILL operation should start. Typically, the value of this attribute is assigned to the RESTART-ROWID attribute before each FILL operation.
    
    Specified by:
    
    setNextRowid in interface DataSourceInterface
    
    Parameters:
    
    buffNo - the sequence number of a buffer in the list of buffers for the data-source object.
    
    row - The new value of code NEXT-ROWID as described above.
  - setNextRowid
```
public void setNextRowid(long buffNo,
                         rowid row)
```
    Sets the ROWID of the data source row at which the next FILL operation should start. Typically, the value of this attribute is assigned to the RESTART-ROWID attribute before each FILL operation.
    
    Specified by:
    
    setNextRowid in interface DataSourceInterface
    
    Parameters:
    
    buffNo - the sequence number of a buffer in the list of buffers for the data-source object.
    
    row - The new value of code NEXT-ROWID as described above.
  - setNextRowid
```
public void setNextRowid(java.lang.String buffName,
                         rowid row)
```
    Sets the ROWID of the data source row at which the next FILL operation should start. Typically, the value of this attribute is assigned to the RESTART-ROWID attribute before each FILL operation.
    
    Specified by:
    
    setNextRowid in interface DataSourceInterface
    
    Parameters:
    
    buffName - The name of a buffer in the list of buffers for the data-source object.
    
    row - The new value of code NEXT-ROWID as described above.
  - setNextRowid
```
public void setNextRowid(character buffName,
                         rowid row)
```
    Sets the ROWID of the data source row at which the next FILL operation should start. Typically, the value of this attribute is assigned to the RESTART-ROWID attribute before each FILL operation.
    
    Specified by:
    
    setNextRowid in interface DataSourceInterface
    
    Parameters:
    
    buffName - The name of a buffer in the list of buffers for the data-source object.
    
    row - The new value of code NEXT-ROWID as described above.
  - getNumSourceBuffers
```
public integer getNumSourceBuffers()
```
    Obtain the number of source buffers in this data-source object.
    
    Specified by:
    
    getNumSourceBuffers in interface DataSourceInterface
    
    Returns:
    
    the number of source buffers in this data-source object.
  - getRestartRow
```
public integer getRestartRow()
```
    Gets the current position (absolute row number) for the FILL query.
    
    Specified by:
    
    getRestartRow in interface DataSourceInterface
    
    Returns:
    
    the current value of RESTART-ROW attribute.
  - setRestartRow
```
public void setRestartRow(long newRow)
```
    Reposition the FILL query to an absolute row number.
    
    Specified by:
    
    setRestartRow in interface DataSourceInterface
    
    Parameters:
    
    newRow - The new row number to reposition the query.
  - setRestartRow
```
public void setRestartRow(NumberType newRow)
```
    Reposition the FILL query to an absolute row number.
    
    Specified by:
    
    setRestartRow in interface DataSourceInterface
    
    Parameters:
    
    newRow - The new row number to reposition the query.
  - getRestartRowid
```
public rowid getRestartRowid()
```
    Obtain the ROWID of the data source row at which a FILL operation will start.
    
    Specified by:
    
    getRestartRowid in interface DataSourceInterface
    
    Returns:
    
    the current value of RESTART-ROWID attribute.
  - getRestartRowid
```
public rowid getRestartRowid(NumberType buffNum)
```
    Obtain the ROWID of the data source row at which a FILL operation will start.
    
    Specified by:
    
    getRestartRowid in interface DataSourceInterface
    
    Parameters:
    
    buffNum - The index of the buffer.
    
    Returns:
    
    the current value of RESTART-ROWID attribute.
  - getRestartRowid
```
public rowid getRestartRowid(long buffNum)
```
    Obtain the ROWID of the data source row at which a FILL operation will start.
    
    Specified by:
    
    getRestartRowid in interface DataSourceInterface
    
    Parameters:
    
    buffNum - The index of the buffer.
    
    Returns:
    
    the current value of RESTART-ROWID attribute.
  - getRestartRowid
```
public rowid getRestartRowid(Text buffName)
```
    Obtain the ROWID of the data source row at which a FILL operation will start.
    
    Specified by:
    
    getRestartRowid in interface DataSourceInterface
    
    Parameters:
    
    buffName - The name of the buffer.
    
    Returns:
    
    the current value of RESTART-ROWID attribute.
  - getRestartRowid
```
public rowid getRestartRowid(java.lang.String buffName)
```
    Obtain the ROWID of the data source row at which a FILL operation will start.
    
    Specified by:
    
    getRestartRowid in interface DataSourceInterface
    
    Parameters:
    
    buffName - The name of the buffer.
    
    Returns:
    
    the current value of RESTART-ROWID attribute.
  - setRestartRowid
```
public void setRestartRowid(rowid row)
```
    Configures the ROWID of the data source row at which a FILL operation will start. Set this attribute before each FILL operation in a series of FILL operations to retrieve data source rows in batches. Typically, this attribute is set by assigning the value of the NEXT-ROWID attribute, after each FILL operation.
    
    Specified by:
    
    setRestartRowid in interface DataSourceInterface
    
    Parameters:
    
    row - The new value for RESTART-ROWID attribute as described above.
  - setRestartRowid
```
public void setRestartRowid(NumberType buffNum,
                            rowid row)
```
    Configures the ROWID of the data source row at which a FILL operation will start. Set this attribute before each FILL operation in a series of FILL operations to retrieve data source rows in batches. Typically, this attribute is set by assigning the value of the NEXT-ROWID attribute, after each FILL operation.
    
    Specified by:
    
    setRestartRowid in interface DataSourceInterface
    
    Parameters:
    
    buffNum - The index of the buffer.
    
    row - The new value for RESTART-ROWID attribute as described above.
  - setRestartRowid
```
public void setRestartRowid(long buffNum,
                            rowid row)
```
    Configures the ROWID of the data source row at which a FILL operation will start. Set this attribute before each FILL operation in a series of FILL operations to retrieve data source rows in batches. Typically, this attribute is set by assigning the value of the NEXT-ROWID attribute, after each FILL operation.
    
    Specified by:
    
    setRestartRowid in interface DataSourceInterface
    
    Parameters:
    
    buffNum - The index of the buffer.
    
    row - The new value for RESTART-ROWID attribute as described above.
  - setRestartRowid
```
public void setRestartRowid(Text buffName,
                            rowid row)
```
    Configures the ROWID of the data source row at which a FILL operation will start. Set this attribute before each FILL operation in a series of FILL operations to retrieve data source rows in batches. Typically, this attribute is set by assigning the value of the NEXT-ROWID attribute, after each FILL operation.
    
    Specified by:
    
    setRestartRowid in interface DataSourceInterface
    
    Parameters:
    
    buffName - The name of the buffer.
    
    row - The new value for RESTART-ROWID attribute as described above.
  - setRestartRowid
```
public void setRestartRowid(java.lang.String buffName,
                            rowid row)
```
    Configures the ROWID of the data source row at which a FILL operation will start. Set this attribute before each FILL operation in a series of FILL operations to retrieve data source rows in batches. Typically, this attribute is set by assigning the value of the NEXT-ROWID attribute, after each FILL operation.
    
    Specified by:
    
    setRestartRowid in interface DataSourceInterface
    
    Parameters:
    
    buffName - The name of the buffer.
    
    row - The new value for RESTART-ROWID attribute as described above.
  - getSaveWhereString
```
public character getSaveWhereString()
```
    Obtain the WHERE clause used to find the database buffer identified by the buffName in a data-source object.
    
    Specified by:
    
    getSaveWhereString in interface DataSourceInterface
    
    Returns:
    
    the WHERE clause used to find the specified buffer.
  - getSaveWhereString
```
public character getSaveWhereString(NumberType buffNum)
```
    Obtain the WHERE clause used to find the database buffer identified by the buffName in a data-source object.
    
    Specified by:
    
    getSaveWhereString in interface DataSourceInterface
    
    Parameters:
    
    buffNum - The buffer index.
    
    Returns:
    
    the WHERE clause used to find the specified buffer.
  - getSaveWhereString
```
public character getSaveWhereString(long buffNum)
```
    Obtain the WHERE clause used to find the database buffer identified by the buffName in a data-source object.
    
    Specified by:
    
    getSaveWhereString in interface DataSourceInterface
    
    Parameters:
    
    buffNum - The buffer index.
    
    Returns:
    
    the WHERE clause used to find the specified buffer.
  - getSaveWhereString
```
public character getSaveWhereString(Text buffName)
```
    Obtain the WHERE clause used to find the database buffer identified by the buffName in a data-source object.
    
    Specified by:
    
    getSaveWhereString in interface DataSourceInterface
    
    Parameters:
    
    buffName - The buffer name.
    
    Returns:
    
    the WHERE clause used to find the specified buffer.
  - getSaveWhereString
```
public character getSaveWhereString(java.lang.String buffName)
```
    Obtain the WHERE clause used to find the database buffer identified by the buffName in a data-source object.
    
    Specified by:
    
    getSaveWhereString in interface DataSourceInterface
    
    Parameters:
    
    buffName - The buffer name.
    
    Returns:
    
    the WHERE clause used to find the specified buffer.
  - setSaveWhereString
```
public void setSaveWhereString(Text val)
```
    Configures the SAVE-WHERE-STRING attribute.
    
    Specified by:
    
    setSaveWhereString in interface DataSourceInterface
    
    Parameters:
    
    val - The new value for SAVE-WHERE-STRING attribute.
  - setSaveWhereString
```
public void setSaveWhereString(NumberType buffNum,
                               Text val)
```
    Configures the SAVE-WHERE-STRING attribute.
    
    Specified by:
    
    setSaveWhereString in interface DataSourceInterface
    
    Parameters:
    
    buffNum - The buffer index.
    
    val - The new value for SAVE-WHERE-STRING attribute.
  - setSaveWhereString
```
public void setSaveWhereString(long buffNum,
                               Text val)
```
    Configures the SAVE-WHERE-STRING attribute.
    
    Specified by:
    
    setSaveWhereString in interface DataSourceInterface
    
    Parameters:
    
    buffNum - The buffer index.
    
    val - The new value for SAVE-WHERE-STRING attribute.
  - setSaveWhereString
```
public void setSaveWhereString(Text buffName,
                               Text val)
```
    Configures the SAVE-WHERE-STRING attribute.
    
    Specified by:
    
    setSaveWhereString in interface DataSourceInterface
    
    Parameters:
    
    buffName - The buffer name.
    
    val - The new value for SAVE-WHERE-STRING attribute.
  - setSaveWhereString
```
public void setSaveWhereString(java.lang.String buffName,
                               Text val)
```
    Configures the SAVE-WHERE-STRING attribute.
    
    Specified by:
    
    setSaveWhereString in interface DataSourceInterface
    
    Parameters:
    
    buffName - The buffer name.
    
    val - The new value for SAVE-WHERE-STRING attribute.
  - setSaveWhereString
```
public void setSaveWhereString(java.lang.String val)
```
    Configures the SAVE-WHERE-STRING attribute.
    
    Specified by:
    
    setSaveWhereString in interface DataSourceInterface
    
    Parameters:
    
    val - The new value for SAVE-WHERE-STRING attribute.
  - setSaveWhereString
```
public void setSaveWhereString(NumberType buffNum,
                               java.lang.String val)
```
    Configures the SAVE-WHERE-STRING attribute.
    
    Specified by:
    
    setSaveWhereString in interface DataSourceInterface
    
    Parameters:
    
    buffNum - The buffer index.
    
    val - The new value for SAVE-WHERE-STRING attribute.
  - setSaveWhereString
```
public void setSaveWhereString(long buffNum,
                               java.lang.String val)
```
    Configures the SAVE-WHERE-STRING attribute.
    
    Specified by:
    
    setSaveWhereString in interface DataSourceInterface
    
    Parameters:
    
    buffNum - The buffer index.
    
    val - The new value for SAVE-WHERE-STRING attribute.
  - setSaveWhereString
```
public void setSaveWhereString(Text buffName,
                               java.lang.String val)
```
    Configures the SAVE-WHERE-STRING attribute.
    
    Specified by:
    
    setSaveWhereString in interface DataSourceInterface
    
    Parameters:
    
    buffName - The buffer name.
    
    val - The new value for SAVE-WHERE-STRING attribute.
  - setSaveWhereString
```
public void setSaveWhereString(java.lang.String buffName,
                               java.lang.String val)
```
    Configures the SAVE-WHERE-STRING attribute.
    
    Specified by:
    
    setSaveWhereString in interface DataSourceInterface
    
    Parameters:
    
    buffName - The buffer name.
    
    val - The new value for SAVE-WHERE-STRING attribute.
  - isIgnoreCurrentModified
```
public logical isIgnoreCurrentModified()
```
    Checks whether the to ignores modifications to the data currently in the data source when saving changes from a DataSet temp-table buffer to the associated data source using the Buffer.saveRowChanges() method.
    This attribute is supported only for backward compatibility. Use the getPreferDataset() method instead.
    
    Specified by:
    
    isIgnoreCurrentModified in interface DataSourceInterface
    
    Returns:
    
    the current value of IGNORE-CURRENT-MODIFIED attribute.
  - setIgnoreCurrentModified
```
public void setIgnoreCurrentModified(boolean on)
```
    Sets whether the to ignores modifications to the data currently in the data source when saving changes from a DataSet temp-table buffer to the associated data source using the Buffer.saveRowChanges() method.
    This attribute is supported only for backward compatibility. Use the setPreferDataset(com.goldencode.p2j.util.logical) method instead.
    
    Specified by:
    
    setIgnoreCurrentModified in interface DataSourceInterface
    
    Parameters:
    
    on - The new value of IGNORE-CURRENT-MODIFIED attribute.
  - setIgnoreCurrentModified
```
public void setIgnoreCurrentModified(logical on)
```
    Sets whether the to ignores modifications to the data currently in the data source when saving changes from a DataSet temp-table buffer to the associated data source using the Buffer.saveRowChanges() method.
    This attribute is supported only for backward compatibility. Use the setPreferDataset(com.goldencode.p2j.util.logical) method instead.
    
    Specified by:
    
    setIgnoreCurrentModified in interface DataSourceInterface
    
    Parameters:
    
    on - The new value of IGNORE-CURRENT-MODIFIED attribute.
  - addSourceBuffer
```
public logical addSourceBuffer(Buffer buf)
```
    Adds a database buffer to a data-source object at run time.
    
    Parameters:
    
    buf - The buffer to be added.
    
    Returns:
    
    true on success.
  - addSourceBuffer
```
public logical addSourceBuffer(handle hBuf,
                               Text keyFields)
```
    Adds a database buffer to a dynamic data-source object at run time.
    
    Specified by:
    
    addSourceBuffer in interface DataSourceInterface
    
    Parameters:
    
    hBuf - The buffer handle to be added.
    
    keyFields - A list of one or more comma-separated database table fields that constitute a unique key
    
    Returns:
    
    true on success.
  - addSourceBuffer
```
public logical addSourceBuffer(handle hBuf,
                               java.lang.String keyFields)
```
    Adds a database buffer to a dynamic data-source object at run time.
    
    Specified by:
    
    addSourceBuffer in interface DataSourceInterface
    
    Parameters:
    
    hBuf - The buffer handle to be added.
    
    keyFields - A list of one or more comma-separated database table fields that constitute a unique key
    
    Returns:
    
    true on success.
  - getSourceBuffer
```
public handle getSourceBuffer()
```
    Gets the handle to the source buffer in the data-source object at the specified index position.
    
    Specified by:
    
    getSourceBuffer in interface DataSourceInterface
    
    Returns:
    
    the handle to the specified buffer.
  - getSourceBufferNative
```
public BufferImpl getSourceBufferNative()
```
    Gets the handle to the source buffer in the data-source object at the specified index position.
    
    Returns:
    
    the specified buffer.
  - getSourceBuffer
```
public handle getSourceBuffer(long bufIndex)
```
    Gets the handle to the source buffer in the data-source object at the specified index position.
    
    Specified by:
    
    getSourceBuffer in interface DataSourceInterface
    
    Parameters:
    
    bufIndex - The index of the requested buffer.
    
    Returns:
    
    the handle to the specified buffer.
  - getSourceBufferNative
```
public BufferImpl getSourceBufferNative(long bufIndex)
```
    Gets the handle to the source buffer in the data-source object at the specified index position.
    
    Parameters:
    
    bufIndex - The index of the requested buffer.
    
    Returns:
    
    the specified buffer.
  - getSourceBuffer
```
public handle getSourceBuffer(NumberType bufIndex)
```
    Gets the handle to the source buffer in the data-source object at the specified index position.
    
    Specified by:
    
    getSourceBuffer in interface DataSourceInterface
    
    Parameters:
    
    bufIndex - The index of the requested buffer.
    
    Returns:
    
    the handle to the specified buffer.
  - getDatasetBuffer
```
public handle getDatasetBuffer()
```
    Gets the handle to the source buffer attached/associated with this DataSource.
    
    Specified by:
    
    getDatasetBuffer in interface DataSourceInterface
    
    Returns:
    
    the handle to the specified buffer.
  - resourceDelete
```
protected boolean resourceDelete()
```
    Delete the resource.
    
    Overrides:
    
    resourceDelete in class HandleResource
    
    Returns:
    
    true if the resource was deleted.
  - getSourceBufferIndex
```
int getSourceBufferIndex(java.lang.String bufName)
```
    Get a source buffer by its name. If not found null is returned.
    
    Parameters:
    
    bufName - The name of the desired source buffer.
    
    Returns:
    
    The 0-base index of the buffer or -1 if no source buffer is found with provided name.
  - _getNumSourceBuffers
```
int _getNumSourceBuffers()
```
    Obtain the number of source buffers in this data-source object.
    
    Returns:
    
    the number of source buffers in this data-source object.
  - attach
```
void attach(BufferImpl buffer,
            java.util.List<org.apache.commons.lang3.tuple.Pair<java.lang.String,DataSource.FieldReference>> buf2dsrc)
```
    Attaches or detaches the dataset buffer to this source (sets the dataset buffer).
    
    Parameters:
    
    buffer - The buffer to be attached. If null is passed, the currently attached buffer is detached.
    
    buf2dsrc - The mapping between the dataset buffer and the fields of this object (these may come from different tables).
  - getRestartRowids
```
java.lang.Long[] getRestartRowids()
```
    Get the list of RESTART-ROWID-s for this DataSource. The order is important, it is the order in which the buffers were added at first.
    
    Returns:
    
    the current list of RESTART-ROWID.
  - updateFillRowidInfo
```
void updateFillRowidInfo(boolean success)
```
    Updates the FILL internal data, preparing it for the next batch, if any. Actually does the following things:
    - reset the list of RESTART-ROWID. All values will become unknown.
    - updates the list of NEXT-ROWID values with the rowids currently selected in buffers. They were not processed yet so they are the 'NEXT' rows.
    If the FILL operation failed, the NEXT-ROWID will be also set to unknown.
    Parameters:
    
    success - true if the fill ended with success.
  - computeFillWhereString
```
private java.lang.String computeFillWhereString()
```
    Computes the value of FILL-WHERE-STRING attribute at this moment. Depending on the active relations from the dataset, this value may change.
    
    Returns:
    
    the value of FILL-WHERE-STRING attribute.
  - setQueryImpl
```
private void setQueryImpl(handle hQry)
```
    The implementation of assignation of QUERY attribute. Validates and link the query.
    
    Parameters:
    
    hQry - The handle to the new query to be assigned.
  - addSourceBufferImpl
```
private logical addSourceBufferImpl(BufferImpl buffer,
                                    java.lang.String[] keyFields)
```
    Actual implementation of ADD-SOURCE-BUFFER method. The addSourceBuffer(com.goldencode.p2j.persist.Buffer) method will call this method after preliminary validating the parameters.
    
    Parameters:
    
    buffer - The buffer to add.
    
    keyFields - The fields set that for a unique index.
    
    Returns:
    
    true on success.
  - isAlterable
```
private boolean isAlterable()
```
    Checks whether this object can be altered (added buffers and relations). Normally, the static defined DataSource s are not alterable, but they can 'altered' by their Builder while the object is being constructed.
    
    Returns:
    
    true if new buffers or relations can be added.
  - getSaveWhereStringImpl
```
java.lang.String getSaveWhereStringImpl(Buffer buf,
                                        boolean useBefore)
```
    Get the current value of SAVE-WHERE-STRING for a specified Buffer. If this is the first time the attribute is accessed, its value is (lazily) computed.
    
    Parameters:
    
    buf - A buffer to obtain its save where string.
    
    useBefore - Use the before-table name to construct the returned SAVE-WHERE-STRING (used for SAVE operation), as opposed to the after-table name (used for DATA-SOURCE-ROWID attribute).
    
    Returns:
    
    Get the current value of SAVE-WHERE-STRING for buf.
  - hasExplicitQuery
```
boolean hasExplicitQuery()
```
    Test whether at current moment this data-source has an explicit query configured.
    
    Returns:
    
    true if a custom query was set for this data-source.
  - createImplicitQuery
```
private boolean createImplicitQuery()
```
    Creates and prepares the implicit query. If a query already exists, does nothing.
    
    Returns:
    
    true if a new query was created and prepared.
  - toString
```
public java.lang.String toString()
```
    Gets a string representation of the DataSource object which contains the name, the buffers list and some details on the active queries, inlcluding their FILL-WHERE-STRING and PREPARE-STRING. This method is a usual debug tool.
    
    Overrides:
    
    toString in class HandleResource
    
    Returns:
    
    a string representation of the DataSource object.

Class DataSource

Nested Class Summary

Field Summary

Fields inherited from class com.goldencode.p2j.util.HandleChain

Fields inherited from class com.goldencode.p2j.util.HandleResource

Constructor Summary

Method Summary

Methods inherited from class com.goldencode.p2j.util.HandleChain

Methods inherited from class com.goldencode.p2j.util.HandleResource

Methods inherited from class java.lang.Object

Methods inherited from interface com.goldencode.p2j.persist.DataSourceInterface

Methods inherited from interface com.goldencode.p2j.util.DynamicResource

Methods inherited from interface com.goldencode.p2j.util.CommonHandle

Methods inherited from interface com.goldencode.p2j.util.WrappedResource

Methods inherited from interface com.goldencode.util.Printable

Methods inherited from interface com.goldencode.p2j.util.Deletable

Field Detail

ROWID_KEY

dynamic

deleted

builder

admData

buffers

nextRowids

restartRowids

restartRow

datasetBuffer

hImplicitQuery

hExplicitQuery

preferDataset

mergeByField

_fillWhereString

buf2dsrc

revBuf2src

saveWhereStrings

Constructor Detail

DataSource

Method Detail

create

create

create

define

define

hasNameReadOnly

hasNameConstraints

_dynamic

valid

getPrevSibling

getNextSibling

getADMData

setADMData

setADMData

getQueryAsHandle

setQueryAsHandle

setQueryAsHandle

getPreferDataset

setPreferDataset

setPreferDataset

getFillWhereString

setFillWhereString

setFillWhereString

keys

keys

keys

getMergeByField

setMergeByField

setMergeByField

getNextRowid

getNextRowid

getNextRowid

getNextRowid

getNextRowid

setNextRowid

setNextRowid

setNextRowid

setNextRowid

setNextRowid

getNumSourceBuffers

getRestartRow

setRestartRow