Qore jni Module
1.2.0
|
Java wrapper for the DataProvider::AbstractDataProvider class in Qore. More...
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 | |
Java wrapper for the DataProvider::AbstractDataProvider class in Qore.
|
inline |
Commits data written to the data provider.
Has no effect if the data provider does not support transaction management
|
inline |
Creates the given record in the data provider.
rec | a hash representing a single input record |
INVALID-OPERATION | the data provider does not support record creation |
|
inline |
Creates the given record in the data provider.
rec | a hash representing a single input record |
create_options | the create options; will be processed by validateCreateOptions() |
INVALID-OPERATION | the data provider does not support record creation |
|
inline |
Deletes zero or more records.
where_cond | a hash for identifying the record(s) to be deleted |
INVALID-OPERATION | the data provider does not support record deletion |
|
inline |
Deletes zero or more records.
where_cond | a hash for identifying the record(s) to be deleted |
search_options | the search options; will be processed by validateSearchOptions() |
INVALID-OPERATION | the data provider does not support record deletion |
|
inline |
Makes a request and returns the response.
req | the request to serialize and make according to the request type |
INVALID-OPERATION | the data provider does not support the request API |
|
inline |
Makes a request and returns the response.
req | the request to serialize and make according to the request type |
request_options | the request options; will be processed by validateRequestOptions() |
INVALID-OPERATION | the data provider does not support the request API |
|
inline |
Returns a bulk insert operation object for the data provider.
INVALID-OPERATION | the data provider does not support create operations |
|
inline |
Returns an iterator iterating all records with the bulk read API.
INVALID-BLOCK-SIZE | the block size must be a positive number |
INVALID-OPERATION | the data provider does not support reading |
|
inline |
Returns an iterator iterating all records with the bulk read API.
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() |
INVALID-BLOCK-SIZE | the block size must be a positive number |
INVALID-OPERATION | the data provider does not support reading |
|
inline |
Returns an iterator iterating all records with the bulk read API.
search_options | the search options; will be processed by validateSearchOptions() |
INVALID-BLOCK-SIZE | the block size must be a positive number |
INVALID-OPERATION | the data provider does not support reading |
|
inline |
Returns a bulk upsert operation object for the data provider.
INVALID-OPERATION | the data provider does not support upsert operations |
|
inline |
Returns the given child provider or nothing if the given child is unknown.
INVALID-CHILD-PROVIDER | unknown child provider |
|
inline |
Returns the given child provider or throws an exception if the given child is unknown.
INVALID-CHILD-PROVIDER | unknown child provider |
|
inline |
Returns a list of child data provider names, if any.
|
inline |
Returns the given child provider from a "/"
separated path String; throws an exception if any element in the path is unknown.
path | a String giving a path to the target provider where child elements are separated by "/" characters |
INVALID-CHILD-PROVIDER | unknown child provider |
|
inline |
Returns options that can be used for creating records.
|
inline |
Returns the type for the given error code.
error_code | the error code for the response; must be a known error code, or an UNKNOWN-ERROR-RESPONSE exception is thrown |
INVALID-OPERATION | the data provider does not support the request API |
UNKNOWN-ERROR-RESPONSE | the error response given is not known |
|
inline |
Returns a hash of error responses, if any.
INVALID-OPERATION | the data provider does not support the request API |
|
inline |
Returns static provider information as data; no objects are returned.
name
and children
attributes are not returned as they are dynamic attributes
|
inline |
Returns custom data mapper runtime keys.
This base method returns nothing; reimplment in child classes to return a value
|
inline |
Returns an iterator iterating all records.
INVALID-OPERATION | the data provider does not support reading |
|
inline |
Returns an iterator iterating all records.
search_options | the search options; will be processed by validateSearchOptions() |
INVALID-OPERATION | the data provider does not support reading |
|
inline |
Returns the description of the record type, if any.
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 |
Throwable | any exception thrown by the data provider |
|
inline |
Returns options that can be used for requests.
|
inline |
Returns the description of a successful request message, if any.
INVALID-OPERATION | the data provider does not support the request API |
|
inline |
Returns the description of a response message, if this object represents a response message.
INVALID-OPERATION | the data provider does not support the request API |
|
inline |
Returns options that can be used for searching.
|
inline |
Returns the description of the record type with soft types, if any.
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 |
Throwable | any exception thrown by the data provider |
|
inline |
Returns options that can be used for upserting records.
|
inline |
Returns true if the data provider has a record type.
|
inline |
Returns an iterator for zero or more records matching the search options according to an API request.
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
INVALID-OPERATION | the data provider does not support reading records or the request / response API |
|
inline |
Returns an iterator for zero or more records matching the search options according to an API request.
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
INVALID-OPERATION | the data provider does not support reading records or the request / response API |
|
inline |
Returns True if the data provider supports transaction management.
|
inline |
Rolls back data written to the data provider.
Has no effect if the data provider does not support transaction management
|
inline |
Returns the first record matching the search options.
where_cond | the search criteria; will be processed by processFieldValues() |
INVALID-OPERATION | the data provider does not support reading |
|
inline |
Returns the first record matching the search options.
where_cond | the search criteria; will be processed by processFieldValues() |
search_options | the search options; will be processed by validateSearchOptions() |
INVALID-OPERATION | the data provider does not support reading |
|
inline |
Returns an iterator for zero or more records matching the search options.
where_cond | the search criteria; will be processed by processFieldValues() |
INVALID-OPERATION | the data provider does not support reading |
|
inline |
Returns an iterator for zero or more records matching the search options.
where_cond | the search criteria; will be processed by processFieldValues() |
search_options | the search options; will be processed by validateSearchOptions() |
INVALID-OPERATION | the data provider does not support reading |
|
inline |
Returns an iterator for zero or more records matching the search options.
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() |
INVALID-BLOCK-SIZE | the block size must be a positive number |
INVALID-OPERATION | the data provider does not support reading |
|
inline |
Returns an iterator for zero or more records matching the search options.
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() |
INVALID-BLOCK-SIZE | the block size must be a positive number |
INVALID-OPERATION | the data provider does not support reading |
|
inline |
Returns an iterator for zero or more records matching the search options.
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() |
INVALID-BLOCK-SIZE | the block size must be a positive number |
INVALID-OPERATION | the data provider does not support reading |
|
inline |
Returns a single record matching the search options.
where_cond | the search criteria; will be processed by processFieldValues() |
INVALID-OPERATION | the data provider does not support reading |
MULTIPLE-RECORDS-ERROR | multiple records found |
|
inline |
Returns a single record matching the search options.
where_cond | the search criteria; will be processed by processFieldValues() |
search_options | the search options; will be processed by validateSearchOptions() |
INVALID-OPERATION | the data provider does not support reading |
MULTIPLE-RECORDS-ERROR | multiple records found |
|
inline |
Updates zero or more records matching the search options.
set | the hash of field data to set |
where_cond | a hash for identifying the record(s) to be updated |
INVALID-OPERATION | the data provider does not support record updating |
|
inline |
Updates zero or more records matching the search options.
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() |
INVALID-OPERATION | the data provider does not support record updating |
|
inline |
Updates a single record matching the search options.
set | the hash of field data to set; will be processed by processFieldValues() |
where_cond | the search criteria; will be processed by processFieldValues() |
INVALID-OPERATION | the data provider does not support record updating |
|
inline |
Updates a single record matching the search options.
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() |
INVALID-OPERATION | the data provider does not support record updating |
|
inline |
Upserts the given record in the data provider.
rec | a hash representing a single input record |
INVALID-OPERATION | the data provider does not support upsert operations |
|
inline |
Upserts the given record in the data provider.
rec | a hash representing a single input record |
upsert_options | the upsert options; will be processed by validateUpsertOptions() |
INVALID-OPERATION | the data provider does not support upsert operations |