org.protempa.query

Class DefaultQueryBuilder

java.lang.Object

org.protempa.query.DefaultQueryBuilder

All Implemented Interfaces:

Serializable, QueryBuilder

public class DefaultQueryBuilder
extends Object
implements QueryBuilder, Serializable

Author:

Andrew Post

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
DefaultQueryBuilder()

Method Summary

Modifier and Type	Method and Description
void	addPropertyChangeListener(PropertyChangeListener listener) Adds listeners for changes to this Query's properties.
void	addPropertyChangeListener(String propertyName, PropertyChangeListener listener) Adds listeners for changes to the specified property.
Query	build(KnowledgeSource knowledgeSource, AlgorithmSource algorithmSource) Builds a Query.
Filter	getFilters() Gets the filters to be applied to this query.
String[]	getKeyIds() Returns the key ids to be queried.
String	getName()
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()
static boolean	isValidatePropositionIds()
void	removePropertyChangeListener(PropertyChangeListener listener) Removes listeners for changes to this Query's properties.
void	removePropertyChangeListener(String propertyName, PropertyChangeListener listener) Removes listeners for changes to the specified property.
void	setFilters(Filter filters) Sets the filters to apply to this query.
void	setKeyIds(String[] keyIds) Sets the key ids to be queried.
void	setName(String name)
void	setPropositionDefinitions(PropositionDefinition[] propDefs) Returns an optional set of user-specified proposition definitions.
void	setPropositionIds(String[] propIds) Sets the proposition ids to be queried.
void	setQueryMode(QueryMode queryMode)
void	setTermIds(And<String>[] termIds) Sets the term ids to be queried in disjunctive normal form.
void	setUsername(String username)
static void	setValidatePropositionIds(boolean validatePropositionIdsFlag) Set the value of the flag that determined whether the build method validates proposition IDs.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultQueryBuilder

public DefaultQueryBuilder()

Method Detail

getName

public String getName()

setName

public void setName(String name)

getUsername

public String getUsername()

setUsername

public void setUsername(String username)

getQueryMode

public QueryMode getQueryMode()

setQueryMode

public void setQueryMode(QueryMode queryMode)

getFilters

public final Filter getFilters()

Gets the filters to be applied to this query.

Returns:

a Filter.

setFilters

public final void setFilters(Filter filters)

Sets the filters to apply to this query. Note that in order to serialize this query, the supplied filters must also implement Serializable.

Parameters:

filters - 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.

setKeyIds

public final void setKeyIds(String[] keyIds)

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

Parameters:

keyIds - a String[] of key ids. If null, an empty String[] will be stored.

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.

setPropositionIds

public final void setPropositionIds(String[] propIds)

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

Parameters:

propIds - a String[] of proposition ids. If null, an empty String[] will be stored.

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.

setTermIds

public final void setTermIds(And<String>[] termIds)

Sets the term ids to be queried in disjunctive normal form. If any terms are specified, PROTEMPA will navigate the term's subsumption hierarchy, find proposition definitions that have been annotated with each term, and add those to the query. If and'd term ids are specified, proposition definitions will only match if they are annotated with all of the specified term ids (or terms in their subsumption hierarchies).

Parameters:

termIds - a And[] 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.

setPropositionDefinitions

public final void setPropositionDefinitions(PropositionDefinition[] propDefs)

Returns an optional set of user-specified proposition definitions.

Parameters:

propDefs - an array of PropositionDefinitions.

addPropertyChangeListener

public final void addPropertyChangeListener(PropertyChangeListener listener)

Adds listeners for changes to this Query's properties.

Parameters:

listener - a PropertyChangeListener.

removePropertyChangeListener

public final void removePropertyChangeListener(PropertyChangeListener listener)

Removes listeners for changes to this Query's properties.

Parameters:

listener - a PropertyChangeListener.

addPropertyChangeListener

public final void addPropertyChangeListener(String propertyName,
                                            PropertyChangeListener listener)

Adds listeners for changes to the specified property.

Parameters:

propertyName - the name String of the property of interest.

listener - a PropertyChangeListener.

removePropertyChangeListener

public final void removePropertyChangeListener(String propertyName,
                                               PropertyChangeListener listener)

Removes listeners for changes to the specified property.

Parameters:

propertyName - the name String of the property that is no longer of interest.

listener - a PropertyChangeListener.

build

public Query build(KnowledgeSource knowledgeSource,
                   AlgorithmSource algorithmSource)
            throws QueryBuildException

Description copied from interface: QueryBuilder

Builds a Query. This method could validate the query specification using the knowledge source and algorithm source.

Specified by:

build in interface QueryBuilder

Parameters:

knowledgeSource - a KnowledgeSource.

algorithmSource - a AlgorithmSource.

Returns:

a Query. Guaranteed not null.

Throws:

QueryBuildException - If the query specification failed validation or some other error occurred.

toString

public String toString()

Overrides:

toString in class Object

setValidatePropositionIds

public static void setValidatePropositionIds(boolean validatePropositionIdsFlag)

Set the value of the flag that determined whether the build method validates proposition IDs.

Parameters:

validatePropositionIds - Proposition IDs are validated if, and only if, this is true. The default value for this is true.

isValidatePropositionIds

public static boolean isValidatePropositionIds()