Package org.rcsb.strucmotif.domain.query

Class QueryBuilder.OptionalStepBuilder

java.lang.Object

org.rcsb.strucmotif.domain.query.QueryBuilder.OptionalStepBuilder

Enclosing class:

QueryBuilder

public class QueryBuilder.OptionalStepBuilder
extends Object

Optional parameters of the algorithm.

Method Summary

Modifier and Type	Method	Description
QueryBuilder.OptionalStepBuilder	addPositionSpecificExchange(LabelSelection labelSelection, Collection<ResidueType> residueTypes)	Register an exchange by specifying a 'range'/collection of component types.
QueryBuilder.OptionalStepBuilder	blacklist(Collection<String> structureIdentifiers)	Filter out hits from the specified entries.
MotifSearchQuery	buildQuery()	Build the actual container.
QueryBuilder.OptionalStepBuilder	whitelist(Collection<String> structureIdentifiers)	Narrow down the search space to the specified entries.

Methods inherited from class java.lang.Object

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

Method Details

addPositionSpecificExchange

public QueryBuilder.OptionalStepBuilder addPositionSpecificExchange(LabelSelection labelSelection,
 Collection<ResidueType> residueTypes)

Register an exchange by specifying a 'range'/collection of component types.

Parameters:

labelSelection - the position referenced

residueTypes - all allowed types

Returns:

this builder

whitelist

public QueryBuilder.OptionalStepBuilder whitelist(Collection<String> structureIdentifiers)

Narrow down the search space to the specified entries. Leave empty to search everything.

Parameters:

structureIdentifiers - a collection of structure identifiers

Returns:

this builder

blacklist

public QueryBuilder.OptionalStepBuilder blacklist(Collection<String> structureIdentifiers)

Filter out hits from the specified entries.

Parameters:

structureIdentifiers - a collection of structure identifiers

Returns:

this builder

buildQuery

public MotifSearchQuery buildQuery()

Build the actual container.

Returns:

the immutable instance of all query parameters