Java wrapper for the DataProvider::AbstractDataProvider class in Qore. More...

Inheritance diagram for org.qore.lang.dataprovider.AbstractDataProvider:

Public Member Methods
	AbstractDataProvider (QoreObject obj) throws Throwable
	creates the object as a wrapper for the Qore object

HashMap< String, Object >	getInfoAsData () throws Throwable
	Returns static provider information as data; no objects are returned. More...

HashMap< String, Object >	getInfo () throws Throwable
	Returns data provider info.

HashMap< String, Object >	createRecord (Map< String, Object > rec, Map< String, Object > create_options) throws Throwable
	Creates the given record in the data provider. More...

HashMap< String, Object >	createRecord (Map< String, Object > rec) throws Throwable
	Creates the given record in the data provider. More...

String	upsertRecord (Map< String, Object > rec, Map< String, Object > upsert_options) throws Throwable
	Upserts the given record in the data provider. More...

String	upsertRecord (Map< String, Object > rec) throws Throwable
	Upserts the given record in the data provider. More...

HashMap< String, Object >	searchFirstRecord (Map< String, Object > where_cond, HashMap< String, Object > search_options) throws Throwable
	Returns the first record matching the search options. More...

HashMap< String, Object >	searchFirstRecord (Map< String, Object > where_cond) throws Throwable
	Returns the first record matching the search options. More...

HashMap< String, Object >	searchSingleRecord (Map< String, Object > where_cond, HashMap< String, Object > search_options) throws Throwable
	Returns a single record matching the search options. More...

HashMap< String, Object >	searchSingleRecord (Map< String, Object > where_cond) throws Throwable
	Returns a single record matching the search options. More...

AbstractDataProviderRecordIterator	getRecordIterator (Map< String, Object > search_options) throws Throwable
	Returns an iterator iterating all records. More...

AbstractDataProviderRecordIterator	getRecordIterator () throws Throwable
	Returns an iterator iterating all records. More...

AbstractDataProviderBulkRecordInterface	getBulkRecordInterface (int block_size, HashMap< String, Object > search_options) throws Throwable
	Returns an iterator iterating all records with the bulk read API. More...

AbstractDataProviderBulkRecordInterface	getBulkRecordInterface (Map< String, Object > search_options) throws Throwable
	Returns an iterator iterating all records with the bulk read API. More...

AbstractDataProviderBulkRecordInterface	getBulkRecordInterface () throws Throwable
	Returns an iterator iterating all records with the bulk read API. More...

AbstractDataProviderBulkRecordInterface	searchRecordsBulk (int block_size, HashMap< String, Object > where_cond, Map< String, Object > search_options) throws Throwable
	Returns an iterator for zero or more records matching the search options. More...

AbstractDataProviderBulkRecordInterface	searchRecordsBulk (Map< String, Object > where_cond, HashMap< String, Object > search_options) throws Throwable
	Returns an iterator for zero or more records matching the search options. More...

AbstractDataProviderBulkRecordInterface	searchRecordsBulk (Map< String, Object > where_cond) throws Throwable
	Returns an iterator for zero or more records matching the search options. More...

AbstractDataProviderRecordIterator	searchRecords (Map< String, Object > where_cond, HashMap< String, Object > search_options) throws Throwable
	Returns an iterator for zero or more records matching the search options. More...

AbstractDataProviderRecordIterator	searchRecords (Map< String, Object > where_cond) throws Throwable
	Returns an iterator for zero or more records matching the search options. More...

AbstractDataProviderRecordIterator	requestSearchRecords (Object req, Map< String, Object > where_cond, HashMap< String, Object > search_options) throws Throwable
	Returns an iterator for zero or more records matching the search options according to an API request. More...

AbstractDataProviderRecordIterator	requestSearchRecords (Object req, Map< String, Object > where_cond) throws Throwable
	Returns an iterator for zero or more records matching the search options according to an API request. More...

boolean	updateSingleRecord (Map< String, Object > set, Map< String, Object > where_cond, HashMap< String, Object > search_options) throws Throwable
	Updates a single record matching the search options. More...

boolean	updateSingleRecord (Map< String, Object > set, Map< String, Object > where_cond) throws Throwable
	Updates a single record matching the search options. More...

int	updateRecords (Map< String, Object > set, Map< String, Object > where_cond, HashMap< String, Object > search_options) throws Throwable
	Updates zero or more records matching the search options. More...

int	updateRecords (Map< String, Object > set, Map< String, Object > where_cond) throws Throwable
	Updates zero or more records matching the search options. More...

int	deleteRecords (Map< String, Object > where_cond, Map< String, Object > search_options) throws Throwable
	Deletes zero or more records. More...

int	deleteRecords (Map< String, Object > where_cond) throws Throwable
	Deletes zero or more records. More...

Object	doRequest (Object req, Map< String, Object > request_options) throws Throwable
	Makes a request and returns the response. More...

Object	doRequest (Object req) throws Throwable
	Makes a request and returns the response. More...

AbstractDataProviderType	getRequestType () throws Throwable
	Returns the description of a successful request message, if any. More...

AbstractDataProviderType	getResponseType () throws Throwable
	Returns the description of a response message, if this object represents a response message. More...

HashMap< String, AbstractDataProviderType >	getErrorResponseTypes () throws Throwable
	Returns a hash of error responses, if any. More...

AbstractDataProviderType	getErrorResponseType (String error_code) throws Throwable
	Returns the type for the given error code. More...

String[]	getChildProviderNames () throws Throwable
	Returns a list of child data provider names, if any. More...

AbstractDataProvider	getChildProvider (String name) throws Throwable
	Returns the given child provider or nothing if the given child is unknown. More...

AbstractDataProvider	getChildProviderEx (String name) throws Throwable
	Returns the given child provider or throws an exception if the given child is unknown. More...

AbstractDataProvider	getChildProviderPath (String path) throws Throwable
	Returns the given child provider from a `"/"` separated path String; throws an exception if any element in the path is unknown. More...

boolean	requiresTransactionManagement () throws Throwable
	Returns True if the data provider supports transaction management. More...

void	commit () throws Throwable
	Commits data written to the data provider. More...

void	rollback () throws Throwable
	Rolls back data written to the data provider. More...

AbstractDataProviderBulkOperation	getBulkInserter () throws Throwable
	Returns a bulk insert operation object for the data provider. More...

AbstractDataProviderBulkOperation	getBulkUpserter () throws Throwable
	Returns a bulk upsert operation object for the data provider. More...

HashMap< String, HashMap< String, Object > >	getMapperRuntimeKeys () throws Throwable
	Returns custom data mapper runtime keys. More...

HashMap< String, AbstractDataField >	getRecordType (Map< String, Object > search_options) throws Throwable
	Returns the description of the record type, if any. More...

HashMap< String, AbstractDataField >	getRecordType () throws Throwable
	Returns the description of the record type, if any.

HashMap< String, AbstractDataField >	getSoftRecordType (Map< String, Object > search_options) throws Throwable
	Returns the description of the record type with soft types, if any. More...

HashMap< String, AbstractDataField >	getSoftRecordType () throws Throwable
	Returns the description of the record type with soft types, if any.

HashMap< String, HashMap< String, Object > >	getSearchOptions () throws Throwable
	Returns options that can be used for searching. More...

HashMap< String, HashMap< String, Object > >	getCreateOptions () throws Throwable
	Returns options that can be used for creating records. More...

HashMap< String, HashMap< String, Object > >	getUpsertOptions () throws Throwable
	Returns options that can be used for upserting records. More...

HashMap< String, HashMap< String, Object > >	getRequestOptions () throws Throwable
	Returns options that can be used for requests. More...

boolean	supportsRead () throws Throwable
	Returns True if the data provider supports reading.

boolean	supportsBulkRead () throws Throwable
	Returns True if the data provider supports native bulk reading.

boolean	supportsCreate () throws Throwable
	Returns True if the data provider supports the record creation API.

boolean	supportsUpdate () throws Throwable
	Returns True if the data provider supports the record update API.

boolean	supportsUpsert () throws Throwable
	Returns True if the data provider supports the record upsert API.

boolean	supportsDelete () throws Throwable
	Returns True if the data provider supports the record deletion API.

boolean	supportsNativeSearch () throws Throwable
	Returns True if the data provider supports the record search API natively.

boolean	supportsBulkCreate () throws Throwable
	Returns True if the data provider supports bulk creation output.

boolean	supportsBulkUpsert () throws Throwable
	Returns True if the data provider supports bulk upserts.

boolean	supportsRequest () throws Throwable
	Returns True if the data provider supports requests.

boolean	recordRequiresSearchOptions () throws Throwable
	Returns true if the data provider requires search options to retrieve the record type.

boolean	hasRecord () throws Throwable
	Returns true if the data provider has a record type. More...

Public Member Methods inherited from org.qore.jni.QoreObjectWrapper
	QoreObjectWrapper (QoreObject obj)
	creates the wrapper object with the Qore object

void	release ()
	releases the Qore object; do not call any further methods on the object after this call

QoreObject	getQoreObject ()
	returns the Qore object

String	className ()
	returns the class name for the Qore object

boolean	instanceOf (String class_name)
	returns true if the object is an instance of the given class

Additional Inherited Members
Private Attributes inherited from org.qore.jni.QoreObjectWrapper
QoreObject	obj
	the wrapper Qore object

Detailed Description

Java wrapper for the DataProvider::AbstractDataProvider class in Qore.

Note: Loads and initializes the Qore library and the jni module in static initialization if necessary

Member Function Documentation

◆ commit()

void org.qore.lang.dataprovider.AbstractDataProvider.commit ( ) throws Throwable

inline

Commits data written to the data provider.

Has no effect if the data provider does not support transaction management

◆ createRecord() [1/2]

HashMap<String, Object> org.qore.lang.dataprovider.AbstractDataProvider.createRecord ( Map< String, Object > rec ) throws Throwable

inline

Creates the given record in the data provider.

Parameters

rec	a hash representing a single input record

Returns: the data written to the data provider

Exceptions

INVALID-OPERATION the data provider does not support record creation

◆ createRecord() [2/2]

HashMap<String, Object> org.qore.lang.dataprovider.AbstractDataProvider.createRecord	(	Map< String, Object >	rec,
		Map< String, Object >	create_options
	)		throws Throwable

inline

Creates the given record in the data provider.

Parameters

rec	a hash representing a single input record
create_options	the create options; will be processed by validateCreateOptions()

Returns: the data written to the data provider

Exceptions

INVALID-OPERATION the data provider does not support record creation

◆ deleteRecords() [1/2]

int org.qore.lang.dataprovider.AbstractDataProvider.deleteRecords ( Map< String, Object > where_cond ) throws Throwable

inline

Deletes zero or more records.

Parameters

where_cond a hash for identifying the record(s) to be deleted

Returns: the number of records deleted

Exceptions

INVALID-OPERATION the data provider does not support record deletion

◆ deleteRecords() [2/2]

int org.qore.lang.dataprovider.AbstractDataProvider.deleteRecords	(	Map< String, Object >	where_cond,
		Map< String, Object >	search_options
	)		throws Throwable

inline

Deletes zero or more records.

Parameters

where_cond	a hash for identifying the record(s) to be deleted
search_options	the search options; will be processed by validateSearchOptions()

Returns: the number of records deleted

Exceptions

INVALID-OPERATION the data provider does not support record deletion

◆ doRequest() [1/2]

Object org.qore.lang.dataprovider.AbstractDataProvider.doRequest ( Object req ) throws Throwable

inline

Makes a request and returns the response.

Parameters

req	the request to serialize and make according to the request type

Returns: the response to the request

Exceptions

INVALID-OPERATION the data provider does not support the request API

◆ doRequest() [2/2]

Object org.qore.lang.dataprovider.AbstractDataProvider.doRequest	(	Object	req,
		Map< String, Object >	request_options
	)		throws Throwable

inline

Makes a request and returns the response.

Parameters

req	the request to serialize and make according to the request type
request_options	the request options; will be processed by validateRequestOptions()

Returns: the response to the request

Exceptions

INVALID-OPERATION the data provider does not support the request API

◆ getBulkInserter()

AbstractDataProviderBulkOperation org.qore.lang.dataprovider.AbstractDataProvider.getBulkInserter ( ) throws Throwable

inline

Returns a bulk insert operation object for the data provider.

Returns: a bulk insert operation object for the data provider

Exceptions

INVALID-OPERATION the data provider does not support create operations

◆ getBulkRecordInterface() [1/3]

AbstractDataProviderBulkRecordInterface org.qore.lang.dataprovider.AbstractDataProvider.getBulkRecordInterface ( ) throws Throwable

inline

Returns an iterator iterating all records with the bulk read API.

Returns: a bulk record interface object that will return the records in bulk format

Exceptions

INVALID-BLOCK-SIZE	the block size must be a positive number
INVALID-OPERATION	the data provider does not support reading

◆ getBulkRecordInterface() [2/3]

AbstractDataProviderBulkRecordInterface org.qore.lang.dataprovider.AbstractDataProvider.getBulkRecordInterface	(	int	block_size,
		HashMap< String, Object >	search_options
	)		throws Throwable

inline

Returns an iterator iterating all records with the bulk read API.

Parameters

block_size	the number of records in a read block; must be a positive number
search_options	the search options; will be processed by validateSearchOptions()

Returns: a bulk record interface object that will return the records in bulk format

Exceptions

INVALID-BLOCK-SIZE	the block size must be a positive number
INVALID-OPERATION	the data provider does not support reading

◆ getBulkRecordInterface() [3/3]

AbstractDataProviderBulkRecordInterface org.qore.lang.dataprovider.AbstractDataProvider.getBulkRecordInterface ( Map< String, Object > search_options ) throws Throwable

inline

Returns an iterator iterating all records with the bulk read API.

Parameters

search_options the search options; will be processed by validateSearchOptions()

Returns: a bulk record interface object that will return the records in bulk format

Exceptions

INVALID-BLOCK-SIZE	the block size must be a positive number
INVALID-OPERATION	the data provider does not support reading

◆ getBulkUpserter()

AbstractDataProviderBulkOperation org.qore.lang.dataprovider.AbstractDataProvider.getBulkUpserter ( ) throws Throwable

inline

Returns a bulk upsert operation object for the data provider.

Returns: a bulk upsert operation object for the data provider

Exceptions

INVALID-OPERATION the data provider does not support upsert operations

◆ getChildProvider()

AbstractDataProvider org.qore.lang.dataprovider.AbstractDataProvider.getChildProvider ( String name ) throws Throwable

inline

Returns the given child provider or nothing if the given child is unknown.

Returns: the given child provider or nothing if the given child is unknown

Exceptions

INVALID-CHILD-PROVIDER unknown child provider

See also: getChildProviderEx()

◆ getChildProviderEx()

AbstractDataProvider org.qore.lang.dataprovider.AbstractDataProvider.getChildProviderEx ( String name ) throws Throwable

inline

Returns the given child provider or throws an exception if the given child is unknown.

Returns: the given child provider or throws an exception if the given child is unknown

Exceptions

INVALID-CHILD-PROVIDER unknown child provider

See also: getChildProvider()

◆ getChildProviderNames()

String [] org.qore.lang.dataprovider.AbstractDataProvider.getChildProviderNames ( ) throws Throwable

inline

Returns a list of child data provider names, if any.

Returns: a list of child data provider names, if any

◆ getChildProviderPath()

AbstractDataProvider org.qore.lang.dataprovider.AbstractDataProvider.getChildProviderPath ( String path ) throws Throwable

inline

Returns the given child provider from a "/" separated path String; throws an exception if any element in the path is unknown.

Parameters

path	a String giving a path to the target provider where child elements are separated by `"/"` characters

Returns: the target child provider; throws an exception if any element in the path is unknown

Exceptions

INVALID-CHILD-PROVIDER unknown child provider

◆ getCreateOptions()

HashMap<String, HashMap<String, Object> > org.qore.lang.dataprovider.AbstractDataProvider.getCreateOptions ( ) throws Throwable

inline

Returns options that can be used for creating records.

Returns: a hash of options that can be used for creating records; keys are option names, values describe the option; if nothing is returned, then the provider does not support any creation options

◆ getErrorResponseType()

AbstractDataProviderType org.qore.lang.dataprovider.AbstractDataProvider.getErrorResponseType ( String error_code ) throws Throwable

inline

Returns the type for the given error code.

Parameters

error_code the error code for the response; must be a known error code, or an UNKNOWN-ERROR-RESPONSE exception is thrown

Returns: the type for the given error code

Exceptions

INVALID-OPERATION	the data provider does not support the request API
UNKNOWN-ERROR-RESPONSE	the error response given is not known

◆ getErrorResponseTypes()

HashMap<String, AbstractDataProviderType> org.qore.lang.dataprovider.AbstractDataProvider.getErrorResponseTypes ( ) throws Throwable

inline

Returns a hash of error responses, if any.

Returns: a hash of error responses, if any, keyed by response code or String

Exceptions

INVALID-OPERATION the data provider does not support the request API

◆ getInfoAsData()

HashMap<String, Object> org.qore.lang.dataprovider.AbstractDataProvider.getInfoAsData ( ) throws Throwable

inline

Returns static provider information as data; no objects are returned.

Note: the name and children attributes are not returned as they are dynamic attributes

◆ getMapperRuntimeKeys()

HashMap<String, HashMap<String, Object> > org.qore.lang.dataprovider.AbstractDataProvider.getMapperRuntimeKeys ( ) throws Throwable

inline

Returns custom data mapper runtime keys.

Returns: custom data mapper runtime keys

This base method returns nothing; reimplment in child classes to return a value

◆ getRecordIterator() [1/2]

AbstractDataProviderRecordIterator org.qore.lang.dataprovider.AbstractDataProvider.getRecordIterator ( ) throws Throwable

inline

Returns an iterator iterating all records.

Exceptions

INVALID-OPERATION the data provider does not support reading

◆ getRecordIterator() [2/2]

AbstractDataProviderRecordIterator org.qore.lang.dataprovider.AbstractDataProvider.getRecordIterator ( Map< String, Object > search_options ) throws Throwable

inline

Returns an iterator iterating all records.

Parameters

search_options the search options; will be processed by validateSearchOptions()

Exceptions

INVALID-OPERATION the data provider does not support reading

◆ getRecordType()

HashMap<String, AbstractDataField> org.qore.lang.dataprovider.AbstractDataProvider.getRecordType ( Map< String, Object > search_options ) throws Throwable

inline

Returns the description of the record type, if any.

Parameters

search_options to be included and processed by validateSearchOptions() if recordRequiresSearchOptions() is true for this provider, otherwise any value provided in this argument is ignored

Returns: the description of the record type, if any

Exceptions

Throwable any exception thrown by the data provider

◆ getRequestOptions()

HashMap<String, HashMap<String, Object> > org.qore.lang.dataprovider.AbstractDataProvider.getRequestOptions ( ) throws Throwable

inline

Returns options that can be used for requests.

Returns: a hash of options that can be used for requests; keys are request option names, values describe the request option; if nothing is returned, then the provider does not support any request options

◆ getRequestType()

AbstractDataProviderType org.qore.lang.dataprovider.AbstractDataProvider.getRequestType ( ) throws Throwable

inline

Returns the description of a successful request message, if any.

Returns: the request type for this provider

Exceptions

INVALID-OPERATION the data provider does not support the request API

◆ getResponseType()

AbstractDataProviderType org.qore.lang.dataprovider.AbstractDataProvider.getResponseType ( ) throws Throwable

inline

Returns the description of a response message, if this object represents a response message.

Returns: the response type for this response message

Exceptions

INVALID-OPERATION the data provider does not support the request API

◆ getSearchOptions()

HashMap<String, HashMap<String, Object> > org.qore.lang.dataprovider.AbstractDataProvider.getSearchOptions ( ) throws Throwable

inline

Returns options that can be used for searching.

Returns: a hash of options that can be used for searching; keys are search option names, values describe the search option; if nothing is returned, then the provider does not support any search options

◆ getSoftRecordType()

HashMap<String, AbstractDataField> org.qore.lang.dataprovider.AbstractDataProvider.getSoftRecordType ( Map< String, Object > search_options ) throws Throwable

inline

Returns the description of the record type with soft types, if any.

Parameters

search_options to be included and processed by validateSearchOptions() if recordRequiresSearchOptions() is true for this provider, otherwise any value provided in this argument is ignored

Returns: the description of the record type with soft types, if any

Exceptions

Throwable any exception thrown by the data provider

◆ getUpsertOptions()

HashMap<String, HashMap<String, Object> > org.qore.lang.dataprovider.AbstractDataProvider.getUpsertOptions ( ) throws Throwable

inline

Returns options that can be used for upserting records.

Returns: a hash of options that can be used for upserting records; keys are option names, values describe the option; if nothing is returned, then the provider does not support any upsert options

◆ hasRecord()

boolean org.qore.lang.dataprovider.AbstractDataProvider.hasRecord ( ) throws Throwable

inline

Returns true if the data provider has a record type.

Returns: true if the data provider has a record type

◆ requestSearchRecords() [1/2]

AbstractDataProviderRecordIterator org.qore.lang.dataprovider.AbstractDataProvider.requestSearchRecords	(	Object	req,
		Map< String, Object >	where_cond
	)		throws Throwable

inline

Returns an iterator for zero or more records matching the search options according to an API request.

Parameters

req	the request to serialize and make according to the request type
where_cond	the search criteria; will be processed by processFieldValues()

This will execute the request and perform a default search on any record(s) returned

Exceptions

INVALID-OPERATION the data provider does not support reading records or the request / response API

◆ requestSearchRecords() [2/2]

AbstractDataProviderRecordIterator org.qore.lang.dataprovider.AbstractDataProvider.requestSearchRecords	(	Object	req,
		Map< String, Object >	where_cond,
		HashMap< String, Object >	search_options
	)		throws Throwable

inline

Returns an iterator for zero or more records matching the search options according to an API request.

Parameters

req	the request to serialize and make according to the request type
where_cond	the search criteria; will be processed by processFieldValues()
search_options	the search options after processing by validateSearchOptions()

This will execute the request and perform a default search on any record(s) returned

Exceptions

INVALID-OPERATION the data provider does not support reading records or the request / response API

◆ requiresTransactionManagement()

boolean org.qore.lang.dataprovider.AbstractDataProvider.requiresTransactionManagement ( ) throws Throwable

inline

Returns True if the data provider supports transaction management.

Returns: True if the data provider supports transaction management, in which case commit() or rollback() must be called to flush or discard data written to the data provider

◆ rollback()

void org.qore.lang.dataprovider.AbstractDataProvider.rollback ( ) throws Throwable

inline

Rolls back data written to the data provider.

Has no effect if the data provider does not support transaction management

◆ searchFirstRecord() [1/2]

HashMap<String, Object> org.qore.lang.dataprovider.AbstractDataProvider.searchFirstRecord ( Map< String, Object > where_cond ) throws Throwable

inline

Returns the first record matching the search options.

Parameters

where_cond the search criteria; will be processed by processFieldValues()

Exceptions

INVALID-OPERATION the data provider does not support reading

◆ searchFirstRecord() [2/2]

HashMap<String, Object> org.qore.lang.dataprovider.AbstractDataProvider.searchFirstRecord	(	Map< String, Object >	where_cond,
		HashMap< String, Object >	search_options
	)		throws Throwable

inline

Returns the first record matching the search options.

Parameters

where_cond	the search criteria; will be processed by processFieldValues()
search_options	the search options; will be processed by validateSearchOptions()

Exceptions

INVALID-OPERATION the data provider does not support reading

◆ searchRecords() [1/2]

AbstractDataProviderRecordIterator org.qore.lang.dataprovider.AbstractDataProvider.searchRecords ( Map< String, Object > where_cond ) throws Throwable

inline

Returns an iterator for zero or more records matching the search options.

Parameters

where_cond the search criteria; will be processed by processFieldValues()

Exceptions

INVALID-OPERATION the data provider does not support reading

◆ searchRecords() [2/2]

AbstractDataProviderRecordIterator org.qore.lang.dataprovider.AbstractDataProvider.searchRecords	(	Map< String, Object >	where_cond,
		HashMap< String, Object >	search_options
	)		throws Throwable

inline

Returns an iterator for zero or more records matching the search options.

Parameters

where_cond	the search criteria; will be processed by processFieldValues()
search_options	the search options; will be processed by validateSearchOptions()

Exceptions

INVALID-OPERATION the data provider does not support reading

◆ searchRecordsBulk() [1/3]

AbstractDataProviderBulkRecordInterface org.qore.lang.dataprovider.AbstractDataProvider.searchRecordsBulk	(	int	block_size,
		HashMap< String, Object >	where_cond,
		Map< String, Object >	search_options
	)		throws Throwable

inline

Returns an iterator for zero or more records matching the search options.

Parameters

block_size	the number of records in a read block; must be a positive number
where_cond	the search criteria; will be processed by processFieldValues()
search_options	the search options; will be processed by validateSearchOptions()

Returns: a bulk record interface object that will return the records in bulk format

Exceptions

INVALID-BLOCK-SIZE	the block size must be a positive number
INVALID-OPERATION	the data provider does not support reading

◆ searchRecordsBulk() [2/3]

AbstractDataProviderBulkRecordInterface org.qore.lang.dataprovider.AbstractDataProvider.searchRecordsBulk ( Map< String, Object > where_cond ) throws Throwable

inline

Returns an iterator for zero or more records matching the search options.

Parameters

block_size	the number of records in a read block; must be a positive number
where_cond	the search criteria; will be processed by processFieldValues()
search_options	the search options; will be processed by validateSearchOptions()

Returns: a bulk record interface object that will return the records in bulk format

Exceptions

INVALID-BLOCK-SIZE	the block size must be a positive number
INVALID-OPERATION	the data provider does not support reading

◆ searchRecordsBulk() [3/3]

AbstractDataProviderBulkRecordInterface org.qore.lang.dataprovider.AbstractDataProvider.searchRecordsBulk	(	Map< String, Object >	where_cond,
		HashMap< String, Object >	search_options
	)		throws Throwable

inline

Returns an iterator for zero or more records matching the search options.

Parameters

block_size	the number of records in a read block; must be a positive number
where_cond	the search criteria; will be processed by processFieldValues()
search_options	the search options; will be processed by validateSearchOptions()

Returns: a bulk record interface object that will return the records in bulk format

Exceptions

INVALID-BLOCK-SIZE	the block size must be a positive number
INVALID-OPERATION	the data provider does not support reading

◆ searchSingleRecord() [1/2]

HashMap<String, Object> org.qore.lang.dataprovider.AbstractDataProvider.searchSingleRecord ( Map< String, Object > where_cond ) throws Throwable

inline

Returns a single record matching the search options.

Parameters

where_cond the search criteria; will be processed by processFieldValues()

Exceptions

INVALID-OPERATION	the data provider does not support reading
MULTIPLE-RECORDS-ERROR	multiple records found

◆ searchSingleRecord() [2/2]

HashMap<String, Object> org.qore.lang.dataprovider.AbstractDataProvider.searchSingleRecord	(	Map< String, Object >	where_cond,
		HashMap< String, Object >	search_options
	)		throws Throwable

inline

Returns a single record matching the search options.

Parameters

where_cond	the search criteria; will be processed by processFieldValues()
search_options	the search options; will be processed by validateSearchOptions()

Exceptions

INVALID-OPERATION	the data provider does not support reading
MULTIPLE-RECORDS-ERROR	multiple records found

◆ updateRecords() [1/2]

int org.qore.lang.dataprovider.AbstractDataProvider.updateRecords	(	Map< String, Object >	set,
		Map< String, Object >	where_cond
	)		throws Throwable

inline

Updates zero or more records matching the search options.

Parameters

set	the hash of field data to set
where_cond	a hash for identifying the record(s) to be updated

Returns: the number of records updated

Exceptions

INVALID-OPERATION the data provider does not support record updating

◆ updateRecords() [2/2]

int org.qore.lang.dataprovider.AbstractDataProvider.updateRecords	(	Map< String, Object >	set,
		Map< String, Object >	where_cond,
		HashMap< String, Object >	search_options
	)		throws Throwable

inline

Updates zero or more records matching the search options.

Parameters

set	the hash of field data to set
where_cond	a hash for identifying the record(s) to be updated
search_options	the search options; will be processed by validateSearchOptions()

Returns: the number of records updated

Exceptions

INVALID-OPERATION the data provider does not support record updating

◆ updateSingleRecord() [1/2]

boolean org.qore.lang.dataprovider.AbstractDataProvider.updateSingleRecord	(	Map< String, Object >	set,
		Map< String, Object >	where_cond
	)		throws Throwable

inline

Updates a single record matching the search options.

Parameters

set	the hash of field data to set; will be processed by processFieldValues()
where_cond	the search criteria; will be processed by processFieldValues()

Returns: True if the record was updated, False if not (no record found)

Exceptions

INVALID-OPERATION the data provider does not support record updating

◆ updateSingleRecord() [2/2]

boolean org.qore.lang.dataprovider.AbstractDataProvider.updateSingleRecord	(	Map< String, Object >	set,
		Map< String, Object >	where_cond,
		HashMap< String, Object >	search_options
	)		throws Throwable

inline

Updates a single record matching the search options.

Parameters

set	the hash of field data to set; will be processed by processFieldValues()
where_cond	the search criteria; will be processed by processFieldValues()
search_options	the search options; will be processed by validateSearchOptions()

Returns: True if the record was updated, False if not (no record found)

Exceptions

INVALID-OPERATION the data provider does not support record updating

◆ upsertRecord() [1/2]

String org.qore.lang.dataprovider.AbstractDataProvider.upsertRecord ( Map< String, Object > rec ) throws Throwable

inline

Upserts the given record in the data provider.

Parameters

rec	a hash representing a single input record

Returns: see db_provider_upsert_results for possible values

Exceptions

INVALID-OPERATION the data provider does not support upsert operations

◆ upsertRecord() [2/2]

String org.qore.lang.dataprovider.AbstractDataProvider.upsertRecord	(	Map< String, Object >	rec,
		Map< String, Object >	upsert_options
	)		throws Throwable

inline

Upserts the given record in the data provider.

Parameters

rec	a hash representing a single input record
upsert_options	the upsert options; will be processed by validateUpsertOptions()

Returns: see db_provider_upsert_results for possible values

Exceptions

INVALID-OPERATION the data provider does not support upsert operations

The documentation for this class was generated from the following file:

/tmp/module-jni/src/java/org/qore/lang/dataprovider/AbstractDataProvider.java

Public Member Methods

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ commit()

◆ createRecord() [1/2]

◆ createRecord() [2/2]

◆ deleteRecords() [1/2]

◆ deleteRecords() [2/2]

◆ doRequest() [1/2]

◆ doRequest() [2/2]

◆ getBulkInserter()

◆ getBulkRecordInterface() [1/3]

◆ getBulkRecordInterface() [2/3]

◆ getBulkRecordInterface() [3/3]

◆ getBulkUpserter()

◆ getChildProvider()

◆ getChildProviderEx()

◆ getChildProviderNames()

◆ getChildProviderPath()

◆ getCreateOptions()

◆ getErrorResponseType()

◆ getErrorResponseTypes()

◆ getInfoAsData()

◆ getMapperRuntimeKeys()

◆ getRecordIterator() [1/2]

◆ getRecordIterator() [2/2]

◆ getRecordType()

◆ getRequestOptions()

◆ getRequestType()

◆ getResponseType()

◆ getSearchOptions()

◆ getSoftRecordType()

◆ getUpsertOptions()

◆ hasRecord()

◆ requestSearchRecords() [1/2]

◆ requestSearchRecords() [2/2]

◆ requiresTransactionManagement()

◆ rollback()

◆ searchFirstRecord() [1/2]

◆ searchFirstRecord() [2/2]

◆ searchRecords() [1/2]

◆ searchRecords() [2/2]

◆ searchRecordsBulk() [1/3]

◆ searchRecordsBulk() [2/3]

◆ searchRecordsBulk() [3/3]

◆ searchSingleRecord() [1/2]

◆ searchSingleRecord() [2/2]

◆ updateRecords() [1/2]

◆ updateRecords() [2/2]

◆ updateSingleRecord() [1/2]

◆ updateSingleRecord() [2/2]

◆ upsertRecord() [1/2]

◆ upsertRecord() [2/2]