Overview | Package | Class | Tree | Deprecated | Index | Help

PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## es.upm.gib.aewrapper.queryprocessing
Class QueryProcessorSessions

    java.lang.Object
      es.upm.gib.aewrapper.queryprocessing.QueryProcessorSessions

    public class QueryProcessorSessions

extends java.lang.Object

This class essentially offers the same querying functionality found on the QueryProcessor class. The public methods offered however always return instantly, returning a session identifier for following up the progress of the query, which remains executing on the background.

We can let the library generate the session identifier (in this case the code will make sure that this value is unique) or provide our own value of session identifier (in this case it is responsibility of the client to check that no other query shares this identifier)

The session identifier allows asking for the progress of the submitted query (or asking for the result, if it is complete). The result will be, as usual, the path to the generated results file (or an error message, if it starts with the "@@@" prefix)

Nested Class Summary
`static class` | `QueryProcessorSessions.SessionProgress` This inner class contains progress information about an active query.

Method Summary
`static QueryProcessorSessions.SessionProgress` | `getSessionProgress(java.lang.String id)` Obtains the progress of a previously launched query
`static java.lang.String` | `processQuery(java.lang.String query, java.util.Collection<java.lang.String> keywords)` Executes a SPARQL query against the arrayexpress database, using a set of keywords for extracting the relevant experiment list.
`static java.lang.String` | `processQuery(java.lang.String query, java.lang.String experimentID)` Executes a SPARQL query against the arrayexpress database, using a specific experiment.
`static void` | `processQuery(java.lang.String sessionID, java.lang.String query, java.util.Collection<java.lang.String> keywords)` Executes a SPARQL query against the arrayexpress database, using a set of keywords for extracting the relevant experiment list.
`static void` | `processQuery(java.lang.String sessionID, java.lang.String query, java.lang.String experimentID)` Executes a SPARQL query against the arrayexpress database, using a specific experiment.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Method Detail

### processQuery

    public static java.lang.String processQuery(java.lang.String query,
                                                java.lang.String experimentID)

  Executes a SPARQL query against the arrayexpress database, using a specific experiment. A file containing the results in SPARQL Result format is generated.

  The query is executed in background. A session identifier is generated and returned by this method. This identifier allows following up the progress of the query

  Parameters:
    `query` - the SPARQL query
    `experimentID` - the only experiment to be queried
  Returns:
    the generated session identifier for this query.

### processQuery

    public static java.lang.String processQuery(java.lang.String query,
                                                java.util.Collection<java.lang.String> keywords)

  Executes a SPARQL query against the arrayexpress database, using a set of keywords for extracting the relevant experiment list. A file containing the results in SPARQL Result format is generated.

  The keyword list should be a non-empty list of strings containing the desired keywords. For example, the following keyword list could be submitted: <'organism', 'rattus', 'mammary', 'glands'>.

  The keyword list will be resolved against the arrayexpress database itself, producing a list of experiment identifiers. The provided SPARQL query will be executed against all those experiments, and the individual results will be integrated into a single result.

  The query is executed in background. A session identifier is generated and returned by this method. This identifier allows following up the progress of the query

  Parameters:
    `query` - the SPARQL query
    `keywords` - the keywords for extracting the relevant experiments
  Returns:
    the generated session identifier for this query.

### processQuery

    public static void processQuery(java.lang.String sessionID,
                                    java.lang.String query,
                                    java.lang.String experimentID)

  Executes a SPARQL query against the arrayexpress database, using a specific experiment. A file containing the results in SPARQL Result format is generated.

  The query is executed in background. A session identifier is generated and returned by this method. This identifier allows following up the progress of the query

  Parameters:
    `sessionID` - the session identifier to use for this query. This identifier should never match any previously used session identifier
    `query` - the SPARQL query
    `experimentID` - the only experiment to be queried

### processQuery

    public static void processQuery(java.lang.String sessionID,
                                    java.lang.String query,
                                    java.util.Collection<java.lang.String> keywords)

  Executes a SPARQL query against the arrayexpress database, using a set of keywords for extracting the relevant experiment list. A file containing the results in SPARQL Result format is generated.

  The keyword list should be a non-empty list of strings containing the desired keywords. For example, the following keyword list could be submitted: <'organism', 'rattus', 'mammary', 'glands'>.

  The keyword list will be resolved against the arrayexpress database itself, producing a list of experiment identifiers. The provided SPARQL query will be executed against all those experiments, and the individual results will be integrated into a single result.

  The query is executed in background. A session identifier is generated and returned by this method. This identifier allows following up the progress of the query

  Parameters:
    `sessionID` - the session identifier to use for this query. This identifier should never match any previously used session identifier
    `query` - the SPARQL query
    `keywords` - the keywords for extracting the relevant experiments

### getSessionProgress

    public static QueryProcessorSessions.SessionProgress getSessionProgress(java.lang.String id)

  Obtains the progress of a previously launched query

  Parameters:
    `id` - the session identifier of the query
  Returns:
    a SessionProgress object containing all the information about the progress of the query, or null if the provided id does not correspond to any running or stored query (note that finished queries are stored for progress inquiring during 24 hours)

Overview | Package | Class | Tree | Deprecated | Index | Help

PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD