ome.services.query

Class CollectionQueryParameterDef

java.lang.Object

ome.services.query.QueryParameterDef

ome.services.query.CollectionQueryParameterDef

public class CollectionQueryParameterDef
extends QueryParameterDef

extension of QueryParameterDef which restricts the type to a Collection, and specifies the element types of that Collection. Also overrides validation to check that type.

Since:

OMERO 3.0

Version:

1.0 (Internal version: $Rev$ $Date$)

Author:

Josh Moore, josh.moore@gmx.de

Field Summary

Fields

Modifier and Type	Field and Description
Class	elementType

Fields inherited from class ome.services.query.QueryParameterDef

name, optional, type

Constructor Summary

Constructors

Constructor and Description
CollectionQueryParameterDef(String name, boolean optional, Class elementType)

Method Summary

Methods

Modifier and Type	Method and Description
void	errorIfInvalid(QueryParameter parameter) validation method called by Query.checkParameters().

Methods inherited from class java.lang.Object

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

Field Detail

elementType

public Class elementType

Constructor Detail

CollectionQueryParameterDef

public CollectionQueryParameterDef(String name,
                           boolean optional,
                           Class elementType)

Method Detail

errorIfInvalid

public void errorIfInvalid(QueryParameter parameter)

Description copied from class: QueryParameterDef

validation method called by Query.checkParameters(). Subclasses should be very careful to call super.errorIfInvalid.

Overrides:

errorIfInvalid in class QueryParameterDef

Parameters:

parameter - Parameter with a matching name to be validated.