Package ubic.gemma.model.common.search

Class SearchSettings.SearchSettingsBuilder

java.lang.Object

ubic.gemma.model.common.search.SearchSettings.SearchSettingsBuilder

Enclosing class:

SearchSettings

public static class SearchSettings.SearchSettingsBuilder
extends Object

Method Summary

Modifier and Type	Method	Description
SearchSettings	build()
SearchSettings.SearchSettingsBuilder	clearResultTypes()
SearchSettings.SearchSettingsBuilder	experimentConstraint(ExpressionExperiment experimentConstraint)
SearchSettings.SearchSettingsBuilder	fillResults(boolean fillResults)	Indicate if result objects (i.e.
SearchSettings.SearchSettingsBuilder	maxResults(int maxResults)	Limit for the number of results per result type.
SearchSettings.SearchSettingsBuilder	mode(SearchSettings.SearchMode mode)	Indicate the search mode to use.
SearchSettings.SearchSettingsBuilder	platformConstraint(ArrayDesign platformConstraint)
SearchSettings.SearchSettingsBuilder	query(String query)	Processed query for performing a search.
SearchSettings.SearchSettingsBuilder	resultType(Class<? extends Identifiable> resultType)
SearchSettings.SearchSettingsBuilder	resultTypes(Collection<? extends Class<? extends Identifiable>> resultTypes)
SearchSettings.SearchSettingsBuilder	taxonConstraint(Taxon taxonConstraint)
String	toString()
SearchSettings.SearchSettingsBuilder	useDatabase(boolean useDatabase)	Use the database for finding results.
SearchSettings.SearchSettingsBuilder	useFullTextIndex(boolean useFullTextIndex)	Use the full-text index for finding results.
SearchSettings.SearchSettingsBuilder	useGeneOntology(boolean useGeneOntology)	Include results from the Gene Ontology (GO).
SearchSettings.SearchSettingsBuilder	useOntology(boolean useOntology)	Use the ontology and ontology inference for finding results.

Methods inherited from class java.lang.Object

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

Method Details

query

public SearchSettings.SearchSettingsBuilder query(String query)

Processed query for performing a search.

Returns:

this.

resultType

public SearchSettings.SearchSettingsBuilder resultType(Class<? extends Identifiable> resultType)

resultTypes

public SearchSettings.SearchSettingsBuilder resultTypes(Collection<? extends Class<? extends Identifiable>> resultTypes)

clearResultTypes

public SearchSettings.SearchSettingsBuilder clearResultTypes()

platformConstraint

public SearchSettings.SearchSettingsBuilder platformConstraint(@Nullable
 ArrayDesign platformConstraint)

Returns:

this.

experimentConstraint

public SearchSettings.SearchSettingsBuilder experimentConstraint(@Nullable
 ExpressionExperiment experimentConstraint)

Returns:

this.

taxonConstraint

public SearchSettings.SearchSettingsBuilder taxonConstraint(@Nullable
 Taxon taxonConstraint)

Returns:

this.

useDatabase

public SearchSettings.SearchSettingsBuilder useDatabase(boolean useDatabase)

Use the database for finding results.

Returns:

this.

useOntology

public SearchSettings.SearchSettingsBuilder useOntology(boolean useOntology)

Use the ontology and ontology inference for finding results.

Results from the Gene Ontology (GO) are not included in this setting, use SearchSettings.setUseGeneOntology(boolean) for that purpose.

Returns:

this.

useGeneOntology

public SearchSettings.SearchSettingsBuilder useGeneOntology(boolean useGeneOntology)

Include results from the Gene Ontology (GO).

Returns:

this.

useFullTextIndex

public SearchSettings.SearchSettingsBuilder useFullTextIndex(boolean useFullTextIndex)

Use the full-text index for finding results.

Returns:

this.

maxResults

public SearchSettings.SearchSettingsBuilder maxResults(int maxResults)

Limit for the number of results per result type.

The default is relatively large and given by SearchSettings.DEFAULT_MAX_RESULTS_PER_RESULT_TYPE. Any value less than one indicate no limit.

Returns:

this.

fillResults

public SearchSettings.SearchSettingsBuilder fillResults(boolean fillResults)

Indicate if result objects (i.e. SearchResult.getResultObject() should be filled, otherwise only the class and ID will be populated.

Returns:

this.

mode

public SearchSettings.SearchSettingsBuilder mode(SearchSettings.SearchMode mode)

Indicate the search mode to use.

Defaults to balanced.

Returns:

this.

build

public SearchSettings build()

toString

public String toString()

Overrides:

toString in class Object