gov.nih.nci.cagrid.data.sdk32query
Class HQLCoreQueryProcessor

java.lang.Object
  gov.nih.nci.cagrid.data.cql.CQLQueryProcessor
      gov.nih.nci.cagrid.data.cql.LazyCQLQueryProcessor
          gov.nih.nci.cagrid.data.sdk32query.HQLCoreQueryProcessor

public class HQLCoreQueryProcessor
extends LazyCQLQueryProcessor

HQLCoreQueryProcessor Implementation of CQL against a caCORE data source using HQL queries

Version:

$Id: HQLCoreQueryProcessor.java,v 1.9 2007/06/07 14:36:18 dervin Exp $

Author:

David W. Ervin

Field Summary

static java.lang.String	APPLICATION_SERVICE_URL
static java.lang.String	CASE_INSENSITIVE_QUERYING
static java.lang.String	CSM_CONFIGURATION_FILENAME
static java.lang.String	CSM_CONTEXT_NAME
static java.lang.String	DEFAULT_LOCALHOST_CACORE_URL
static java.lang.String	DEFAULT_USE_CSM_FLAG
static java.lang.String	USE_CASE_INSENSITIVE_DEFAULT
static java.lang.String	USE_CSM_FLAG
static java.lang.String	USE_LOCAL_APPSERVICE
static java.lang.String	USE_LOCAL_APPSERVICE_DEFAULT

Constructor Summary

HQLCoreQueryProcessor()

Method Summary

java.lang.String	getConfigurationUiClassname() Get the classname of the configuration user interface for this CQL Query Processor.
java.util.Set<java.lang.String>	getPropertiesFromEtc() Get a set of property names whose values should be file names prepended with the location of the service's etc directory.
java.util.Properties	getRequiredParameters() Get a Properties object of parameters the query processor will require on initialization.
CQLQueryResults	processQuery(CQLQuery cqlQuery) Processes the CQL Query
java.util.Iterator	processQueryLazy(CQLQuery cqlQuery)
protected java.util.List	queryCoreService(CQLQuery query)

Methods inherited from class gov.nih.nci.cagrid.data.cql.CQLQueryProcessor

getConfiguredParameters, getConfiguredWsddStream, initialize

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

APPLICATION_SERVICE_URL

public static final java.lang.String APPLICATION_SERVICE_URL

See Also:

Constant Field Values

DEFAULT_LOCALHOST_CACORE_URL

public static final java.lang.String DEFAULT_LOCALHOST_CACORE_URL

See Also:

Constant Field Values

USE_CSM_FLAG

public static final java.lang.String USE_CSM_FLAG

See Also:

Constant Field Values

DEFAULT_USE_CSM_FLAG

public static final java.lang.String DEFAULT_USE_CSM_FLAG

CSM_CONFIGURATION_FILENAME

public static final java.lang.String CSM_CONFIGURATION_FILENAME

See Also:

Constant Field Values

CSM_CONTEXT_NAME

public static final java.lang.String CSM_CONTEXT_NAME

See Also:

Constant Field Values

CASE_INSENSITIVE_QUERYING

public static final java.lang.String CASE_INSENSITIVE_QUERYING

See Also:

Constant Field Values

USE_CASE_INSENSITIVE_DEFAULT

public static final java.lang.String USE_CASE_INSENSITIVE_DEFAULT

USE_LOCAL_APPSERVICE

public static final java.lang.String USE_LOCAL_APPSERVICE

See Also:

Constant Field Values

USE_LOCAL_APPSERVICE_DEFAULT

public static final java.lang.String USE_LOCAL_APPSERVICE_DEFAULT

Constructor Detail

HQLCoreQueryProcessor

public HQLCoreQueryProcessor()

Method Detail

processQuery

public CQLQueryResults processQuery(CQLQuery cqlQuery)
                             throws MalformedQueryException,
                                    QueryProcessingException

Description copied from class: CQLQueryProcessor

Processes the CQL Query

Specified by:

processQuery in class CQLQueryProcessor

Returns:

The results of processing a CQL query

Throws:

MalformedQueryException - Should be thrown when the query itself does not conform to the CQL standard or attempts to perform queries outside of the exposed domain model

QueryProcessingException - Thrown for all exceptions in query processing not related to the query being malformed

processQueryLazy

public java.util.Iterator processQueryLazy(CQLQuery cqlQuery)
                                    throws MalformedQueryException,
                                           QueryProcessingException

Specified by:

processQueryLazy in class LazyCQLQueryProcessor

Throws:

MalformedQueryException

QueryProcessingException

getConfigurationUiClassname

public java.lang.String getConfigurationUiClassname()

Description copied from class: CQLQueryProcessor

Get the classname of the configuration user interface for this CQL Query Processor. This class should exist in the same JAR as the query processor, as well as any (non-java / caGrid) classes it depends on. This class MUST implement the abstract base class gov.nih.nci.cagrid.data.cql.ui.CQLQueryProcessorConfigUI

Overrides:

getConfigurationUiClassname in class CQLQueryProcessor

Returns:

The class name of the configuration user interface, or null if no UI is provided

queryCoreService

protected java.util.List queryCoreService(CQLQuery query)
                                   throws MalformedQueryException,
                                          QueryProcessingException

Throws:

MalformedQueryException

QueryProcessingException

getRequiredParameters

public java.util.Properties getRequiredParameters()

Description copied from class: CQLQueryProcessor

Get a Properties object of parameters the query processor will require on initialization. Subclasses can override this method to return a map describing paramters their implementation needs. The keys are the names of parameters the query processor requires, the values are the defaults for those properties. The default value of a property may be an empty string if it is an optional paramter. The keys MUST be valid java variable names. They MUST NOT contain spaces or punctuation. They may begin with an uppercase character.

Overrides:

getRequiredParameters in class CQLQueryProcessor

Returns:

The required properties for the query processor with their default values

getPropertiesFromEtc

public java.util.Set<java.lang.String> getPropertiesFromEtc()

Description copied from class: CQLQueryProcessor

Get a set of property names whose values should be file names prepended with the location of the service's etc directory. Potential uses include locating config files, storing logs, etc. Subclasses can override this method to return a Set of Strings which are the names of property keys from the getRequiredParameters() method.

Overrides:

getPropertiesFromEtc in class CQLQueryProcessor

Returns:

The set of property names