gov.nih.nci.caarray.services.search
Interface CaArraySearchService


public interface CaArraySearchService

Search API for caArray, based on various types of criteria.

Author:
Rashmi Srinivasa

Field Summary
static java.lang.String JNDI_NAME
          The JNDI name to look up the remote CaArraySearch service.
 
Method Summary
 java.util.List<?> search(gov.nih.nci.cagrid.cqlquery.CQLQuery cqlQuery)
          Searches for entities based on the given CQL query.
<T extends AbstractCaArrayObject>
java.util.List<T>
search(T entityExample)
          Performs a query-by-example search based on the entity passed.
<T extends AbstractCaArrayObject>
java.util.List<T>
search(T entityExample, boolean excludeNulls, boolean excludeZeroes)
          Performs a query-by-example search based on the entity passed.
 

Field Detail

JNDI_NAME

static final java.lang.String JNDI_NAME
The JNDI name to look up the remote CaArraySearch service.

See Also:
Constant Field Values
Method Detail

search

<T extends AbstractCaArrayObject> java.util.List<T> search(T entityExample)
Performs a query-by-example search based on the entity passed. If the id of the given entity is not null, this query will only match by id, ignoring all other fields. This method is equivalent to a call to search(gov.nih.nci.caarray.domain.AbstractCaArrayObject, boolean, boolean) with excludeNulls set to true, and excludeZeroes set to false.

Type Parameters:
T - object type to search for
Parameters:
entityExample - find entities that match the non-null fields and associations of this example.
Returns:
the matching entities.
See Also:
search(gov.nih.nci.caarray.domain.AbstractCaArrayObject, boolean, boolean)

search

<T extends AbstractCaArrayObject> java.util.List<T> search(T entityExample,
                                                           boolean excludeNulls,
                                                           boolean excludeZeroes)
Performs a query-by-example search based on the entity passed. If the id of the given entity is not null, this query will only match by id, ignoring all other fields.

Type Parameters:
T - object type to search for
Parameters:
entityExample - find entities that match the non-null fields and associations of this example.
excludeNulls - when true, null properties are not considered for matching reults.
excludeZeroes - when true, 0 (or unset) primitive properties are not considered for matching reults.
Returns:
the matching entities.

search

java.util.List<?> search(gov.nih.nci.cagrid.cqlquery.CQLQuery cqlQuery)
Searches for entities based on the given CQL query.

Parameters:
cqlQuery - the HQL (Hibernate Query Language) string to use as search criteria.
Returns:
the result for the provided query. May be the list of objects, list of attribute values, or the count, depending upon the query modifiers.