omero.sys
Class ParametersI

java.lang.Object
  extended by Ice.ObjectImpl
      extended by omero.sys.Parameters
          extended by omero.sys.ParametersI
All Implemented Interfaces:
Ice.Object, Serializable, Cloneable

public class ParametersI
extends omero.sys.Parameters

Helper subclass of Parameters for simplifying method parameter creation. As of 4.0, this takes over for PojoOptions. See ticket:67.

See Also:
Serialized Form

Field Summary
 
Fields inherited from class omero.sys.Parameters
__ids, map, theFilter, theOptions
 
Constructor Summary
ParametersI()
          Default constructor creates the map() instance to prevent later NullPointerExceptions.
ParametersI(Map<String,omero.RType> map)
          Uses (and does not copy) the given Map as the named parameter store in this instance.
 
Method Summary
 ParametersI acquisitionData()
          Sets the acquisition data parameter to true.
 ParametersI add(String name, omero.RType r)
           
 ParametersI addId(long id)
           
 ParametersI addId(omero.RLong id)
           
 ParametersI addIds(Collection<Long> longs)
           
 ParametersI addLong(String name, long l)
           
 ParametersI addLong(String name, omero.RLong l)
           
 ParametersI addLongs(String name, Collection<Long> longs)
           
 ParametersI allExps()
          Removes the experimenter parameter from the map.
 ParametersI allGrps()
          Removes the group parameter from the map.
 ParametersI allTimes()
          Removes the time parameters from the map.
 ParametersI endTime(omero.RTime endTime)
          Sets the value of the end time parameter.
 ParametersI exp(omero.RLong i)
          Sets the value of the experimenter parameter.
 omero.RBool getAcquisitionData()
           
 omero.RTime getEndTime()
          Returns the value of the end time parameter.
 omero.RLong getExperimenter()
          Returns the value of the experimenter parameter.
 omero.RLong getGroup()
          Returns the value of the group parameter.
 omero.RBool getLeaves()
           
 omero.RInt getLimit()
          Returns the value of the limit parameter.
 omero.RInt getOffset()
          Returns the value of the offset parameter.
 omero.RBool getOrphan()
           
 omero.RTime getStartTime()
          Returns the value of the start time parameter.
 omero.RBool getUnique()
           
 ParametersI grp(omero.RLong i)
          Sets the value of the group parameter.
 boolean isEndTime()
          Returns true if the map contains the end time parameter, false otherwise.
 boolean isExperimenter()
          Returns true if the filter contains and ownerId parameter, false otherwise.
 boolean isGroup()
          Returns true if the filter contains an groupId, false otherwise.
 boolean isPagination()
          Returns true if the filter contains a limit OR a offset, false otherwise.
 boolean isStartTime()
          Returns true if the map contains the start time parameter, false otherwise.
 ParametersI leaves()
          Sets the leaf parameter to true.
 ParametersI map()
          Deprecated. 
 ParametersI noAcquisitionData()
          Sets the acquisition data parameter to false.
 ParametersI noLeaves()
          Sets the leaf parameter to false.
 ParametersI noOrphan()
          Sets the orphan parameter to false.
 omero.sys.Parameters noPage()
          Nulls both the Filter.limit and Filter.offset values.
 ParametersI noUnique()
           
 ParametersI orphan()
          Sets the orphan parameter to true.
 ParametersI page(int offset, int limit)
          Sets both the Filter.limit and Filter.offset values by wrapping the arguments in RInt and passing the values to page(RInt, RInt)
 ParametersI page(omero.RInt offset, omero.RInt limit)
          Creates a Filter if necessary and sets both Filter.limit and Filter.offset.
 ParametersI startTime(omero.RTime startTime)
          Sets the value of the start time parameter.
 ParametersI unique()
           
 
Methods inherited from class omero.sys.Parameters
__read, __read, __write, __write, ice_factory, ice_id, ice_id, ice_ids, ice_ids, ice_isA, ice_isA, ice_staticId
 
Methods inherited from class Ice.ObjectImpl
___ice_id, ___ice_ids, ___ice_isA, ___ice_ping, __checkMode, __collocDispatch, __dispatch, clone, ice_dispatch, ice_hash, ice_operationAttributes, ice_ping, ice_ping, ice_postUnmarshal, ice_preMarshal
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface Ice.Object
equals
 

Constructor Detail

ParametersI

public ParametersI()
Default constructor creates the map() instance to prevent later NullPointerExceptions. To save memory, it is possible to pass null to ParametersI(Map).


ParametersI

public ParametersI(Map<String,omero.RType> map)
Uses (and does not copy) the given Map as the named parameter store in this instance. Be careful if either null is passed or if this instance is being used in a multi-threaded environment. No synchronization takes place.

Method Detail

noPage

public omero.sys.Parameters noPage()
Nulls both the Filter.limit and Filter.offset values.


page

public ParametersI page(int offset,
                        int limit)
Sets both the Filter.limit and Filter.offset values by wrapping the arguments in RInt and passing the values to page(RInt, RInt)


page

public ParametersI page(omero.RInt offset,
                        omero.RInt limit)
Creates a Filter if necessary and sets both Filter.limit and Filter.offset.


isPagination

public boolean isPagination()
Returns true if the filter contains a limit OR a offset, false otherwise.

Returns:
See above.

getOffset

public omero.RInt getOffset()
Returns the value of the offset parameter.

Returns:
See above.

getLimit

public omero.RInt getLimit()
Returns the value of the limit parameter.

Returns:
See above.

unique

public ParametersI unique()

noUnique

public ParametersI noUnique()

getUnique

public omero.RBool getUnique()

exp

public ParametersI exp(omero.RLong i)
Sets the value of the experimenter parameter.

Parameters:
i - The Id of the experimenter.
Returns:
Returns the current object.

allExps

public ParametersI allExps()
Removes the experimenter parameter from the map.

Returns:
Returns the current object.

isExperimenter

public boolean isExperimenter()
Returns true if the filter contains and ownerId parameter, false otherwise.

Returns:
See above.

getExperimenter

public omero.RLong getExperimenter()
Returns the value of the experimenter parameter.

Returns:
See above.

grp

public ParametersI grp(omero.RLong i)
Sets the value of the group parameter.

Parameters:
i - The value to set.
Returns:
See above.

allGrps

public ParametersI allGrps()
Removes the group parameter from the map.

Returns:
Returns the current object.

isGroup

public boolean isGroup()
Returns true if the filter contains an groupId, false otherwise.

Returns:
See above.

getGroup

public omero.RLong getGroup()
Returns the value of the group parameter.

Returns:
See above.

startTime

public ParametersI startTime(omero.RTime startTime)
Sets the value of the start time parameter.

Parameters:
startTime - The time to set.
Returns:
Returns the current object.

endTime

public ParametersI endTime(omero.RTime endTime)
Sets the value of the end time parameter.

Parameters:
endTime - The time to set.
Returns:
Returns the current object.

allTimes

public ParametersI allTimes()
Removes the time parameters from the map.

Returns:
Returns the current object.

isStartTime

public boolean isStartTime()
Returns true if the map contains the start time parameter, false otherwise.

Returns:
See above.

isEndTime

public boolean isEndTime()
Returns true if the map contains the end time parameter, false otherwise.

Returns:
See above.

getStartTime

public omero.RTime getStartTime()
Returns the value of the start time parameter.

Returns:
See above.

getEndTime

public omero.RTime getEndTime()
Returns the value of the end time parameter.

Returns:
See above.

leaves

public ParametersI leaves()
Sets the leaf parameter to true.

Returns:
Returns the current object.

noLeaves

public ParametersI noLeaves()
Sets the leaf parameter to false.

Returns:
Returns the current object.

getLeaves

public omero.RBool getLeaves()

orphan

public ParametersI orphan()
Sets the orphan parameter to true.

Returns:
Returns the current object.

noOrphan

public ParametersI noOrphan()
Sets the orphan parameter to false.

Returns:
Returns the current object.

getOrphan

public omero.RBool getOrphan()

acquisitionData

public ParametersI acquisitionData()
Sets the acquisition data parameter to true.

Returns:
Returns the current object.

noAcquisitionData

public ParametersI noAcquisitionData()
Sets the acquisition data parameter to false.

Returns:
Returns the current object.

getAcquisitionData

public omero.RBool getAcquisitionData()

add

public ParametersI add(String name,
                       omero.RType r)

addId

public ParametersI addId(long id)

addId

public ParametersI addId(omero.RLong id)

addIds

public ParametersI addIds(Collection<Long> longs)

addLong

public ParametersI addLong(String name,
                           long l)

addLong

public ParametersI addLong(String name,
                           omero.RLong l)

addLongs

public ParametersI addLongs(String name,
                            Collection<Long> longs)

map

@Deprecated
public ParametersI map()
Deprecated. 

Pre-4.0, pojoOptions.map() was a common idiom for passing the into methods, to keep those uses valid, the map() method is defined.



OmeroJava Api

Version: Beta4.2.1-r8614-Beta4.2-b41

Copyright © 2009 The University of Dundee. All Rights Reserved.