Parameters (OMERO (OME Remote Objects) Server)

java.lang.Object
- ome.parameters.Parameters

All Implemented Interfaces:

Serializable
```
public class Parameters
extends Object
implements Serializable
```
container object for QueryParameter and Filter instances. Parameters are provided to IQuery calls IQuery#findByQuery(String, Parameters) and IQuery#findAllByQuery(String, Parameters), and define all named query parameters needed for the call. The public Strings available here are used throughout this class and should also be used in query strings as named parameteres. For example, the field ID has the value "id", and a query which would like to use the addId(Long) method, should define a named parameter of the form ":id".

Since:

3.0-M2

Version:

3.0 (Internal version: $Revision$ $Date$)

Author:

Josh Moore josh.moore@gmx.de

See Also:
Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ALGORITHM` named parameter "algorithm".
`static String`	`CLASS` named parameter "class".
`static String`	`GROUP_ID` named parameter "groupId".
`static String`	`ID` named parameter "id".
`static String`	`IDS` named parameter "ids".
`static String`	`OWNER_ID` named parameter "ownerId".

Constructor Summary

Constructors
Constructor and Description
`Parameters()` default constructor.
`Parameters(Filter filter)` Filter constructor.
`Parameters(Parameters old)` copy constructor.
`Parameters(QueryParameter[] queryParameters)` copy constructor.

Method Summary

Methods
Modifier and Type	Method and Description
`Parameters`	`add(QueryParameter parameter)`
`Parameters`	`addAlgorithm(String algo)`
`Parameters`	`addAll(Parameters old)` adds all the information from the passed in Parameters instance to this instance.
`Parameters`	`addAll(QueryParameter[] queryParameters)` adds all the information from the passed in Parameters instance to this instance.
`Parameters`	`addBoolean(String name, Boolean value)`
`Parameters`	`addClass(Class klass)`
`Parameters`	`addClass(String name, Class value)`
`Parameters`	`addId(Long id)`
`Parameters`	`addIds(Collection ids)`
`Parameters`	`addInteger(String name, Integer value)`
`Parameters`	`addList(String name, List value)`
`Parameters`	`addLong(String name, Long value)`
`Parameters`	`addMap(String name, Map value)`
`Parameters`	`addSet(String name, Set value)`
`Parameters`	`addString(String name, String value)`
`Parameters`	`allExps()`
`Parameters`	`endTime(Timestamp timestamp)`
`Parameters`	`exp(long id)`
`QueryParameter`	`get(String name)` lookup a QueryParameter by name.
`Timestamp`	`getEndTime()`
`Long`	`getExperimenter()` Fulfills the old PojoOptions requirement for returning null if no owner set.
`Long`	`getGroup()` Fulfills the old PojoOptions requirement for returning null if no owner set.
`Integer`	`getLimit()`
`Integer`	`getOffset()`
`Timestamp`	`getStartTime()`
`long`	`group()`
`Parameters`	`grp(long id)`
`boolean`	`isAcquisitionData()`
`boolean`	`isExperimenter()`
`boolean`	`isGroup()`
`boolean`	`isLeaves()`
`boolean`	`isOrphan()`
`boolean`	`isPagination()`
`boolean`	`isUnique()`
`Set<String>`	`keySet()` the Set of all names which would would return a non-null value from `get(String)`
`Parameters`	`leaves()`
`Parameters`	`noLeaves()`
`Parameters`	`noOrphan()`
`Parameters`	`orphan()`
`long`	`owner()`
`Parameters`	`page(Integer offset, Integer limit)`
`Parameters`	`paginate(Integer offset, Integer limit)`
`QueryParameter[]`	`queryParameters()` copies all QueryParameters to an array.
`Parameters`	`setFilter(Filter filter)`
`Parameters`	`setOptions(Options options)`
`Parameters`	`startTime(Timestamp timestamp)`
`String`	`toString()`
`Parameters`	`unique()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail
- ID
```
public static final String ID
```
  named parameter "id". Used in query strings as ":id"
  
  See Also:
  Constant Field Values
- IDS
```
public static final String IDS
```
  named parameter "ids". Used in query strings as ":ids"
  
  See Also:
  Constant Field Values
- CLASS
```
public static final String CLASS
```
  named parameter "class". Used in query strings as ":class"
  
  See Also:
  Constant Field Values
- ALGORITHM
```
public static final String ALGORITHM
```
  named parameter "algorithm". Used in query strings as ":algorithm"
  
  See Also:
  Constant Field Values
- OWNER_ID
```
public static final String OWNER_ID
```
  named parameter "ownerId". Used in query strings as ":ownerId"
  
  See Also:
  Constant Field Values
- GROUP_ID
```
public static final String GROUP_ID
```
  named parameter "groupId". Used in query strings as ":groupId"
  
  See Also:
  Constant Field Values

Constructor Detail
- Parameters
```
public Parameters()
```
  default constructor. Filter is left null. queryParameters collection is initialized to empty Collection
- Parameters
```
public Parameters(Filter filter)
```
  Filter constructor. Allows for the simple specification of "unique" results. new Parameters( new Filter().unique() ); Filter can be null since this is the default behavior anyway.
- Parameters
```
public Parameters(Parameters old)
```
  copy constructor. Filter is taken from old instance and queryParameters are merged.
  
  Parameters:
  old -
- Parameters
```
public Parameters(QueryParameter[] queryParameters)
```
  copy constructor. Merges QueryParameters.

Method Detail

queryParameters
```
public QueryParameter[] queryParameters()
```
copies all QueryParameters to an array. Changes to this array do not effect the internal QueryParameters.

Returns:
array of QueryParameter.

get

public QueryParameter get(String name)

lookup a QueryParameter by name.

keySet
```
public Set<String> keySet()
```
the Set of all names which would would return a non-null value from get(String)

Returns:
a Set of Strings.

setFilter

public Parameters setFilter(Filter filter)

setOptions

public Parameters setOptions(Options options)

add

public Parameters add(QueryParameter parameter)

addAll
```
public Parameters addAll(Parameters old)
```
adds all the information from the passed in Parameters instance to this instance. All QueryParameters are added, and the Filter instance is added if the current

Parameters:
old - Non-null Parameters instance.

Returns:
this

addAll
```
public Parameters addAll(QueryParameter[] queryParameters)
```
adds all the information from the passed in Parameters instance to this instance. All QueryParameters are added, and the Filter instance is added if the current

Parameters:
queryParameters - Non-null array of QueryParameters.

Returns:
this

addClass

public Parameters addClass(Class klass)

addClass

public Parameters addClass(String name,
                  Class value)

addBoolean

public Parameters addBoolean(String name,
                    Boolean value)

addInteger

public Parameters addInteger(String name,
                    Integer value)

addLong

public Parameters addLong(String name,
                 Long value)

addSet

public Parameters addSet(String name,
                Set value)

addList

public Parameters addList(String name,
                 List value)

addMap

public Parameters addMap(String name,
                Map value)

addString

public Parameters addString(String name,
                   String value)

addId
```
public Parameters addId(Long id)
```

addIds

public Parameters addIds(Collection ids)

addAlgorithm

public Parameters addAlgorithm(String algo)

exp
```
public Parameters exp(long id)
```

allExps
```
public Parameters allExps()
```

owner
```
public long owner()
```

isExperimenter
```
public boolean isExperimenter()
```

getExperimenter
```
public Long getExperimenter()
```
Fulfills the old PojoOptions requirement for returning null if no owner set.

grp
```
public Parameters grp(long id)
```

group
```
public long group()
```

getGroup
```
public Long getGroup()
```
Fulfills the old PojoOptions requirement for returning null if no owner set.

isGroup
```
public boolean isGroup()
```

startTime

public Parameters startTime(Timestamp timestamp)

getStartTime
```
public Timestamp getStartTime()
```

endTime

public Parameters endTime(Timestamp timestamp)

getEndTime
```
public Timestamp getEndTime()
```

paginate

public Parameters paginate(Integer offset,
                  Integer limit)

getLimit
```
public Integer getLimit()
```

getOffset
```
public Integer getOffset()
```

isPagination
```
public boolean isPagination()
```

page

public Parameters page(Integer offset,
              Integer limit)

unique
```
public Parameters unique()
```

isUnique
```
public boolean isUnique()
```

isAcquisitionData
```
public boolean isAcquisitionData()
```

isLeaves
```
public boolean isLeaves()
```

leaves
```
public Parameters leaves()
```

noLeaves
```
public Parameters noLeaves()
```

orphan
```
public Parameters orphan()
```

noOrphan
```
public Parameters noOrphan()
```

isOrphan
```
public boolean isOrphan()
```

toString
```
public String toString()
```
Overrides:

toString in class Object

Class Parameters

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ID

IDS

CLASS

ALGORITHM

OWNER_ID

GROUP_ID

Constructor Detail

Parameters

Parameters

Parameters

Parameters

Method Detail

queryParameters

get

keySet

setFilter

setOptions

add

addAll

addAll

addClass

addClass

addBoolean

addInteger

addLong

addSet

addList

addMap

addString

addId

addIds

addAlgorithm

exp

allExps

owner

isExperimenter

getExperimenter

grp

group

getGroup

isGroup

startTime

getStartTime

endTime

getEndTime

paginate

getLimit

getOffset

isPagination

page

unique

isUnique

isAcquisitionData

isLeaves

leaves

noLeaves

orphan

noOrphan

isOrphan

toString