org.protempa.query

Class Query

java.lang.Object

org.protempa.query.Query

All Implemented Interfaces:

Serializable

public class Query
extends Object
implements Serializable

Base query implementation. Queries are serializable provided that any filters that are set are also serializable (see #setFilters(org.protempa.dsb.filter.Filter)).

Author:

Andrew Post

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static QueryMode	DEFAULT_QUERY_MODE

Constructor Summary

Constructors

Constructor and Description
Query(String[] keyIds, Filter filters, String[] propIds, And<String>[] termIds, PropositionDefinition[] propDefs, QueryMode queryMode) Creates new Query instance with a default identifier.
Query(String id, String[] keyIds, Filter filters, String[] propIds, And<String>[] termIds, PropositionDefinition[] propDefs, QueryMode queryMode) Creates new Query instance.
Query(String id, String username, String[] keyIds, Filter filters, String[] propIds, And<String>[] termIds, PropositionDefinition[] propDefs, QueryMode queryMode)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
Filter	getFilters() Gets the filters to be applied to this query.
String[]	getKeyIds() Returns the key ids to be queried.
String	getName() Returns this query's identifier.
PropositionDefinition[]	getPropositionDefinitions() Returns an optional set of user-specified proposition definitions.
String[]	getPropositionIds() Returns the proposition ids to be queried.
QueryMode	getQueryMode()
And<String>[]	getTermIds() Gets the term ids to be queried in disjunctive normal form.
String	getUsername()
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

DEFAULT_QUERY_MODE

public static QueryMode DEFAULT_QUERY_MODE

Constructor Detail

Query

public Query(String[] keyIds,
             Filter filters,
             String[] propIds,
             And<String>[] termIds,
             PropositionDefinition[] propDefs,
             QueryMode queryMode)

Creates new Query instance with a default identifier.

Parameters:

keyIds - An array of key IDs. If this is null then the query will include all keyIDs.

filters - A chain of filters. The first filter's getAnd method returns the second filter in the chain or null.

propIds - The proposition IDs that the query will try to derive.

termIds -

Query

public Query(String id,
             String[] keyIds,
             Filter filters,
             String[] propIds,
             And<String>[] termIds,
             PropositionDefinition[] propDefs,
             QueryMode queryMode)

Creates new Query instance.

Parameters:

id - An identifier for this query. If null, a default identifier is assigned.

keyIds - An array of key IDs. If this is null then the query will include all keyIDs.

filters - A chain of filters. The first filter's getAnd method returns the second filter in the chain or null.

propIds - The proposition IDs that the query will try to derive.

termIds -

Query

public Query(String id,
             String username,
             String[] keyIds,
             Filter filters,
             String[] propIds,
             And<String>[] termIds,
             PropositionDefinition[] propDefs,
             QueryMode queryMode)

Method Detail

getFilters

public final Filter getFilters()

Gets the filters to be applied to this query.

Returns:

a Filter.

getKeyIds

public final String[] getKeyIds()

Returns the key ids to be queried. An array of length 0 means that all key ids will be queried.

Returns:

a String[]. Never returns null.

getPropositionIds

public final String[] getPropositionIds()

Returns the proposition ids to be queried. An array of length 0 means that all proposition ids will be queried.

Parameters:

propIds - a String[]. Never returns null.

getTermIds

public final And<String>[] getTermIds()

Gets the term ids to be queried in disjunctive normal form. PROTEMPA will navigate these terms' subsumption hierarchy, find proposition definitions that have been annotated with each term, and add those to the query. And'd term ids will only match a proposition definition if it is annotated with all of the specified term ids (or terms in their subsumption hierarchies).

Returns:

a String[] of term ids representing disjunctive normal form.

getPropositionDefinitions

public final PropositionDefinition[] getPropositionDefinitions()

Returns an optional set of user-specified proposition definitions.

Returns:

an array of PropositionDefinitions.

getName

public final String getName()

Returns this query's identifier. Guaranteed not null.

Returns:

an identifier String.

getUsername

public String getUsername()

getQueryMode

public QueryMode getQueryMode()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object