org.protempa

Class QuerySession

java.lang.Object

org.protempa.QuerySession

public class QuerySession
extends Object

Models a query followed by data exploration.

Author:

Himanshu Rathod

Method Summary

Modifier and Type	Method and Description
void	drillDown(String propositionId, QueryResultsHandler handler)
void	execute(QueryResultsHandler handler) This method returns the current data for the query session without any filter or drill down.
void	filter(Filter constraints, QueryResultsHandler handler)
List<Proposition>	getDerived(Proposition proposition) Gets the abstract propositions that were derived from the given proposition.
List<Proposition>	getDerived(Proposition proposition, String[] propId) Gets the abstract propositions with the given ids that were derived from the given proposition.
String	getId() Gets the query session's unique identifier.
Query	getQuery() Gets the initial query.
List<Proposition>	getReferences(Proposition prop, String name) Gets the references for a proposition with the specified reference name.
boolean	isCachingEnabled() Returns whether the proposition and derived caches are enabled.

Methods inherited from class java.lang.Object

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

Method Detail

getId

public String getId()

Gets the query session's unique identifier.

Returns:

an id String.

getQuery

public Query getQuery()

Gets the initial query.

Returns:

a Query.

isCachingEnabled

public boolean isCachingEnabled()

Returns whether the proposition and derived caches are enabled.

Returns:

true if enabled, false if disabled.

getReferences

public List<Proposition> getReferences(Proposition prop,
                                       String name)
                                throws DataSourceReadException

Gets the references for a proposition with the specified reference name. Propositions store the unique identifiers of propositions to which they refer. This method resolves those unique identifiers. Caching must be enabled for this to work.

Parameters:

prop - a Proposition.

name - a reference name String.

Returns:

a List of propositions, guaranteed not null.

Throws:

DataSourceReadException - if some of the reference unique identifiers could not be resolved.

UnsupportedOperationException - if caching is disabled.

getDerived

public List<Proposition> getDerived(Proposition proposition)

Gets the abstract propositions that were derived from the given proposition. Caching must be enabled for this to work.

Parameters:

proposition - a Proposition.

Returns:

a newly created list of derived Propositions. Will never be null.

Throws:

UnsupportedOperationException - if caching is disabled.

getDerived

public List<Proposition> getDerived(Proposition proposition,
                                    String[] propId)

Gets the abstract propositions with the given ids that were derived from the given proposition. Caching must be enabled for this to work.

Parameters:

proposition - a Proposition.

propId - a proposition id String[].

Returns:

a newly created list of derived Propositions. Will never be null.

Throws:

UnsupportedOperationException - if caching is disabled.

filter

public void filter(Filter constraints,
                   QueryResultsHandler handler)

drillDown

public void drillDown(String propositionId,
                      QueryResultsHandler handler)

execute

public void execute(QueryResultsHandler handler)

This method returns the current data for the query session without any filter or drill down. NOTE: This method returns the original data set, not the result set from the most recently run query.

Parameters:

handler - The QueryResultsHandler that will be responsible for handling the result set.