|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface LexEVSDataService
The caCORE-SDK Data Service Portion of LexEVSAPI. This extends on the caCORE ApplicationService to provide additional Query Options.
Method Summary | ||
---|---|---|
|
getAssociation(java.lang.Object source,
java.lang.String associationName,
QueryOptions queryOptions)
Retrieves an associated object for the example object specified by the source parameter. |
|
java.lang.Integer |
getQueryRowCount(java.lang.Object criteria,
java.lang.String targetClassName,
QueryOptions queryOptions)
Returns the number of records that meet the search criteria. |
|
|
query(CQLQuery cqlQuery,
QueryOptions queryOptions)
Retrieves the result from the data source using the CQL query. |
|
|
query(CQLQuery cqlQuery,
java.lang.String targetClassName,
QueryOptions queryOptions)
Deprecated. |
|
|
query(DetachedCriteria detachedCriteria,
QueryOptions queryOptions)
Retrieves the result from the data source using the DetachedCriteria query. |
|
|
query(DetachedCriteria detachedCriteria,
java.lang.String targetClassName,
QueryOptions queryOptions)
Deprecated. |
|
|
query(gov.nih.nci.cagrid.cqlquery.CQLQuery cqlQuery,
QueryOptions queryOptions)
Retrieves the result from the data source using the caGrid's CQL query. |
|
|
query(java.lang.Object criteria,
java.lang.Integer firstRow,
java.lang.String targetClassName,
QueryOptions queryOptions)
Used by the infrastructure to get next chunk of records in the result set. |
|
|
search(java.lang.Class targetClass,
java.util.List objList,
QueryOptions queryOptions)
Retrieves the result from the data source using the Query by Example. |
|
|
search(java.lang.Class targetClass,
java.lang.Object obj,
QueryOptions queryOptions)
Retrieves the result from the data source using the Query by Example. |
|
|
search(java.lang.String path,
java.util.List objList,
QueryOptions queryOptions)
Retrieves the result from the data source using a Nested Search Criteria. |
|
|
search(java.lang.String path,
java.lang.Object obj,
QueryOptions queryOptions)
Retrieves the result from the data source using the Nested Search Criteria. |
Methods inherited from interface gov.nih.nci.system.applicationservice.ApplicationService |
---|
getAssociation, getMaxRecordsCount, getQueryRowCount, query, query, query, query, query, query, search, search, search, search |
Method Detail |
---|
@Deprecated <E> java.util.List<E> query(CQLQuery cqlQuery, java.lang.String targetClassName, QueryOptions queryOptions) throws ApplicationException
ApplicationService.getMaxRecordsCount()
then the
result set will be partially loaded. The client framework will execute a subsequent query (transparent to the
client application) against the ApplicationService
to load the remaining results in the chunk
no greater than value specified by ApplicationService.getMaxRecordsCount()
.
Note: The targetClassName
parameter will not be interpreted by the system. This parameter
will be determined from the CQLQuery.
cqlQuery
- targetClassName
- queryOptions
-
ApplicationException
#query(CQLQuery)}
<E> java.util.List<E> query(CQLQuery cqlQuery, QueryOptions queryOptions) throws ApplicationException
ApplicationService.getMaxRecordsCount()
then the
result set will be partially loaded. The client framework will execute a subsequent query (transparent to the
client application) against the ApplicationService
to load the remaining results in the chunk
no greater than value specified by ApplicationService.getMaxRecordsCount()
.
cqlQuery
- queryOptions
- Specific Options to be used while processing this query.
ApplicationException
@Deprecated <E> java.util.List<E> query(DetachedCriteria detachedCriteria, java.lang.String targetClassName, QueryOptions queryOptions) throws ApplicationException
ApplicationService.getMaxRecordsCount()
then the
result set will be partially loaded. The client framework will execute a subsequent query (transparent to the
client application) against the ApplicationService
to load the remaining results in the chunk
no greater than value specified by ApplicationService.getMaxRecordsCount()
.
Note: The targetClassName
parameter will not be interpreted by the system. This parameter
will be determined from the DetachedCriteria object.
detachedCriteria
- targetClassName
- queryOptions
- Specific Options to be used while processing this query.
ApplicationException
#query(DetachedCriteria)}
<E> java.util.List<E> query(DetachedCriteria detachedCriteria, QueryOptions queryOptions) throws ApplicationException
ApplicationService.getMaxRecordsCount()
then the
result set will be partially loaded. The client framework will execute a subsequent query (transparent to the
client application) against the ApplicationService
to load the remaining results in the chunk
no greater than value specified by ApplicationService.getMaxRecordsCount()
.
detachedCriteria
- queryOptions
- Specific Options to be used while processing this query.
ApplicationException
<E> java.util.List<E> search(java.lang.Class targetClass, java.util.List objList, QueryOptions queryOptions) throws ApplicationException
targetClass
specifies
the object that the user intends to fetch after executing the query. The targetClass
should be
same as the object specified in the objList or associated object for the example object. Also, all the objects
in the objList
has to be of the same type. The example query is converted into the data source
specific query language. For the Object Relational Mapping based persistence tier, the example query structure
is converted in the Hibernate Query Language (HQL). Hibernate converts the HQL into SQL and executes it against
the relational database.
The retrieved results are converted into a list which may not be completely loaded. If the retrieved results
are more than the maximum number of supported records as indicated by ApplicationService.getMaxRecordsCount()
then the
result set will be partially loaded. The client framework will execute a subsequent query (transparent to the
client application) against the ApplicationService
to load the remaining results in the chunk
no greater than value specified by ApplicationService.getMaxRecordsCount()
.
targetClass
- objList
- queryOptions
- Specific Options to be used while processing this query.
ApplicationException
<E> java.util.List<E> search(java.lang.Class targetClass, java.lang.Object obj, QueryOptions queryOptions) throws ApplicationException
targetClass
specifies
the object that the user intends to fetch after executing the query. The targetClass
should be
same as the example object or associated object for the example object. The example query is converted into
the data source specific query language. For the Object Relational Mapping based persistence tier, the example
query structure is converted in the Hibernate Query Language (HQL). Hibernate converts the HQL into SQL and
executes it against the relational database.
The retrieved results are converted into a list which may not be completely loaded. If the retrieved results
are more than the maximum number of supported records as indicated by ApplicationService.getMaxRecordsCount()
then the
result set will be partially loaded. The client framework will execute a subsequent query (transparent to the
client application) against the ApplicationService
to load the remaining results in the chunk
no greater than value specified by ApplicationService.getMaxRecordsCount()
.
targetClass
- obj
- queryOptions
- Specific Options to be used while processing this query.
ApplicationException
<E> java.util.List<E> search(java.lang.String path, java.util.List objList, QueryOptions queryOptions) throws ApplicationException
path
specifies
the list of objects (separated by commas), which should be used to reach the target object from the example objects
passed in the objList
or associated object for the example object. The Nested Search Criteria
is converted into the data source specific query language. For the Object Relational Mapping based persistence
tier, the query structure is first converted into the Hibernate Query Language (HQL). Hibernate then converts the HQL into
SQL and executes it against the relational database.
The retrieved results are converted into a list which may not be completely loaded. If the retrieved results
are more than the maximum number of supported records as indicated by ApplicationService.getMaxRecordsCount()
then the
result set will be partially loaded. The client framework will execute a subsequent query (transparent to the
client application) against the ApplicationService
to load the remaining results in the chunk
no greater than value specified by ApplicationService.getMaxRecordsCount()
.
path
- objList
- queryOptions
- Specific Options to be used while processing this query.
ApplicationException
<E> java.util.List<E> search(java.lang.String path, java.lang.Object obj, QueryOptions queryOptions) throws ApplicationException
path
specifies
the list of objects (separated by commas) which should be used to reach the target object from the example object
passed as obj
, or the associated object for the example object. Internally, the Nested Search Criteria
is converted into the data source specific query language. For the Object Relational Mapping based persistence
tier, the query structure is first converted into the Hibernate Query Language (HQL). Hibernate then converts the HQL into
SQL and executes it against the relational database.
The retrieved results are converted into a list which may not be completely loaded. If the retrieved results
are more than the maximum number of supported records as indicated by ApplicationService.getMaxRecordsCount()
then the
result set will be partially loaded. The client framework will execute a subsequent query (transparent to the
client application) against the ApplicationService
to load the remaining results in the chunk
no greater than value specified by ApplicationService.getMaxRecordsCount()
.
path
- obj
- queryOptions
- Specific Options to be used while processing this query.
ApplicationException
<E> java.util.List<E> query(java.lang.Object criteria, java.lang.Integer firstRow, java.lang.String targetClassName, QueryOptions queryOptions) throws ApplicationException
ApplicationService.getMaxRecordsCount()
to determine what should be the start of next chunk.
criteria
- firstRow
- targetClassName
-
ApplicationException
java.lang.Integer getQueryRowCount(java.lang.Object criteria, java.lang.String targetClassName, QueryOptions queryOptions) throws ApplicationException
ApplicationService.getMaxRecordsCount()
criteria
- targetClassName
- queryOptions
- Specific Options to be used while processing this query.
ApplicationException
<E> java.util.List<E> getAssociation(java.lang.Object source, java.lang.String associationName, QueryOptions queryOptions) throws ApplicationException
source
parameter.
source
- associationName
- queryOptions
- Specific Options to be used while processing this query.
ApplicationException
<E> java.util.List<E> query(gov.nih.nci.cagrid.cqlquery.CQLQuery cqlQuery, QueryOptions queryOptions) throws ApplicationException
ApplicationService.getMaxRecordsCount()
then the
result set will be partially loaded. The client framework will execute a subsequent query (transparent to the
client application) against the ApplicationService
to load the remaining results in the chunk
no greater than value specified by ApplicationService.getMaxRecordsCount()
.
cqlQuery
- queryOptions
- Specific Options to be used while processing this query.
ApplicationException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |