Package ch.ethz.sis.openbis.generic.asapi.v3.dto.common.search

Class AbstractEntitySearchCriteria<ID extends IObjectId>

java.lang.Object

ch.ethz.sis.openbis.generic.asapi.v3.dto.common.search.AbstractSearchCriteria

ch.ethz.sis.openbis.generic.asapi.v3.dto.common.search.AbstractCompositeSearchCriteria

ch.ethz.sis.openbis.generic.asapi.v3.dto.common.search.AbstractObjectSearchCriteria<ID>

ch.ethz.sis.openbis.generic.asapi.v3.dto.common.search.AbstractEntitySearchCriteria<ID>

All Implemented Interfaces:

ISearchCriteria, Serializable

Direct Known Subclasses:

AbstractDataSetSearchCriteria, AbstractSampleSearchCriteria, ExperimentSearchCriteria

@JsonObject("as.dto.common.search.AbstractEntitySearchCriteria")
public abstract class AbstractEntitySearchCriteria<ID extends IObjectId>
extends AbstractObjectSearchCriteria<ID>

See Also:

• Serialized Form

Field Summary

Fields inherited from class ch.ethz.sis.openbis.generic.asapi.v3.dto.common.search.AbstractCompositeSearchCriteria

criteria, operator

Constructor Summary

Constructors

Constructor	Description
AbstractEntitySearchCriteria()

Method Summary

Modifier and Type	Method	Description
protected SearchCriteriaToStringBuilder	createBuilder()
boolean	isNegated()
protected AbstractEntitySearchCriteria<ID>	negate()
protected void	setNegated(boolean negated)
abstract AbstractEntitySearchCriteria<ID>	withAndOperator()
AnyBooleanPropertySearchCriteria	withAnyBooleanProperty()
AnyDatePropertySearchCriteria	withAnyDateProperty()
AnyFieldSearchCriteria	withAnyField()
AnyNumberPropertySearchCriteria	withAnyNumberProperty()
AnyPropertySearchCriteria	withAnyProperty()	Deprecated. This method does not cast any string to the actual type of the property being queried.
AnyStringPropertySearchCriteria	withAnyStringProperty()
BooleanPropertySearchCriteria	withBooleanProperty(String propertyName)
CodeSearchCriteria	withCode()
CodesSearchCriteria	withCodes()
DatePropertySearchCriteria	withDateProperty(String propertyName)
ModificationDateSearchCriteria	withModificationDate()
ModifierSearchCriteria	withModifier()
NumberPropertySearchCriteria	withNumberProperty(String propertyName)
abstract AbstractEntitySearchCriteria<ID>	withOrOperator()
PermIdSearchCriteria	withPermId()
StringPropertySearchCriteria	withProperty(String propertyName)	Deprecated. This method casts any string to the actual type of the property being queried.
RegistrationDateSearchCriteria	withRegistrationDate()
RegistratorSearchCriteria	withRegistrator()
SamplePropertySearchCriteria	withSampleProperty(String propertyName)
StrictlyStringPropertySearchCriteria	withStringProperty(String propertyName)
TagSearchCriteria	withTag()
ControlledVocabularyPropertySearchCriteria	withVocabularyProperty(String propertyName)

Methods inherited from class ch.ethz.sis.openbis.generic.asapi.v3.dto.common.search.AbstractObjectSearchCriteria

withId

Methods inherited from class ch.ethz.sis.openbis.generic.asapi.v3.dto.common.search.AbstractCompositeSearchCriteria

getCriteria, getOperator, setCriteria, toString, toString, with, withOperator

Methods inherited from class ch.ethz.sis.openbis.generic.asapi.v3.dto.common.search.AbstractSearchCriteria

equals, hashCode

Methods inherited from class java.lang.Object

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

Constructor Details

AbstractEntitySearchCriteria

public AbstractEntitySearchCriteria()

Method Details

withCode

public CodeSearchCriteria withCode()

withCodes

public CodesSearchCriteria withCodes()

withPermId

public PermIdSearchCriteria withPermId()

withRegistrator

public RegistratorSearchCriteria withRegistrator()

withModifier

public ModifierSearchCriteria withModifier()

withRegistrationDate

public RegistrationDateSearchCriteria withRegistrationDate()

withModificationDate

public ModificationDateSearchCriteria withModificationDate()

withTag

public TagSearchCriteria withTag()

withNumberProperty

public NumberPropertySearchCriteria withNumberProperty(String propertyName)

withProperty

@Deprecated
public StringPropertySearchCriteria withProperty(String propertyName)

Deprecated.

This method casts any string to the actual type of the property being queried. This leads in some cases to cast errors or missing operators for the type later on during query parsing. More often than not, these errors are completely avoidable simply by using the typed methods: withDateProperty(String) withNumberProperty(String) withStringProperty(String) withBooleanProperty(String)

withStringProperty

public StrictlyStringPropertySearchCriteria withStringProperty(String propertyName)

withDateProperty

public DatePropertySearchCriteria withDateProperty(String propertyName)

withBooleanProperty

public BooleanPropertySearchCriteria withBooleanProperty(String propertyName)

withSampleProperty

public SamplePropertySearchCriteria withSampleProperty(String propertyName)

withVocabularyProperty

public ControlledVocabularyPropertySearchCriteria withVocabularyProperty(String propertyName)

withAnyProperty

@Deprecated
public AnyPropertySearchCriteria withAnyProperty()

Deprecated.

This method does not cast any string to the actual type of the property being queried. Instead it does string comparison, which is inconsistent with the rest of the query engine. It is an inefficient replacement of full text search that actually does a very slow full table scan that can lead to heavy slowdowns on big databases. withAnyDateProperty() withAnyNumberProperty() withAnyStringProperty() withAnyBooleanProperty()

withAnyStringProperty

public AnyStringPropertySearchCriteria withAnyStringProperty()

withAnyNumberProperty

public AnyNumberPropertySearchCriteria withAnyNumberProperty()

withAnyDateProperty

public AnyDatePropertySearchCriteria withAnyDateProperty()

withAnyBooleanProperty

public AnyBooleanPropertySearchCriteria withAnyBooleanProperty()

withAnyField

public AnyFieldSearchCriteria withAnyField()

withOrOperator

public abstract AbstractEntitySearchCriteria<ID> withOrOperator()

withAndOperator

public abstract AbstractEntitySearchCriteria<ID> withAndOperator()

setNegated

protected void setNegated(boolean negated)

Overrides:

setNegated in class AbstractSearchCriteria

isNegated

public boolean isNegated()

Specified by:

isNegated in interface ISearchCriteria

Overrides:

isNegated in class AbstractSearchCriteria

negate

protected AbstractEntitySearchCriteria<ID> negate()

createBuilder

protected SearchCriteriaToStringBuilder createBuilder()

Overrides:

createBuilder in class AbstractCompositeSearchCriteria