public class ParametersI extends Parameters
Parameters
for simplifying method
parameter creation.
As of 4.0, this takes over for PojoOptions. See ticket:67.__ids, map, serialVersionUID, theFilter, theOptions
Constructor and Description |
---|
ParametersI()
Default constructor creates the
Parameters.map instance to prevent later
NullPointerException s. |
ParametersI(java.util.Map<java.lang.String,RType> map)
Uses (and does not copy) the given
Map<String, RType> as the
named parameter store in this instance. |
Modifier and Type | Method and Description |
---|---|
ParametersI |
acquisitionData()
Sets the
acquisition data parameter to true . |
ParametersI |
add(java.lang.String name,
RType r) |
ParametersI |
addId(long id) |
ParametersI |
addId(RLong id) |
ParametersI |
addIds(java.util.Collection<java.lang.Long> longs) |
ParametersI |
addLong(java.lang.String name,
long l) |
ParametersI |
addLong(java.lang.String name,
RLong l) |
ParametersI |
addLongs(java.lang.String name,
java.util.Collection<java.lang.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 |
cache()
Deprecated.
experimental: may be wholly removed in next major version
|
ParametersI |
endTime(RTime endTime)
Sets the value of the
end time parameter. |
ParametersI |
exp(RLong i)
Sets the value of the
experimenter parameter. |
RBool |
getAcquisitionData() |
RBool |
getCache() |
RTime |
getEndTime()
Returns the value of the
end time parameter. |
RLong |
getExperimenter()
Returns the value of the
experimenter parameter. |
RLong |
getGroup()
Returns the value of the
group parameter. |
RBool |
getLeaves() |
RInt |
getLimit()
Returns the value of the
limit parameter. |
RInt |
getOffset()
Returns the value of the
offset parameter. |
RBool |
getOrphan() |
RTime |
getStartTime()
Returns the value of the
start time parameter. |
RBool |
getUnique() |
ParametersI |
grp(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 |
noAcquisitionData()
Sets the
acquisition data parameter to false . |
ParametersI |
noCache()
Set queries to not be cacheable.
|
ParametersI |
noLeaves()
Sets the
leaf parameter to false . |
ParametersI |
noOrphan()
Sets the
orphan parameter to false . |
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(RInt offset,
RInt limit)
|
ParametersI |
startTime(RTime startTime)
Sets the value of the
start time parameter. |
ParametersI |
unique() |
__readImpl, __writeImpl, clone, ice_factory, ice_id, ice_id, ice_ids, ice_ids, ice_isA, ice_isA, ice_staticId
public ParametersI()
Parameters.map
instance to prevent later
NullPointerException
s. To save memory, it is possible to pass
null to ParametersI(Map)
.public ParametersI(java.util.Map<java.lang.String,RType> map)
Map<String, RType>
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.map
- the named parameter store to usepublic Parameters noPage()
Filter.limit
and Filter.offset
values.public ParametersI page(int offset, int limit)
Filter.limit
and Filter.offset
values by
wrapping the arguments in RInt
and passing the values to
page(RInt, RInt)
offset
- the offset (to start from)limit
- the limit (maximum to return)public ParametersI page(RInt offset, RInt limit)
offset
- the offset (to start from)limit
- the limit (maximum to return)public boolean isPagination()
true
if the filter contains a limit
OR a offset
, false
otherwise.public RInt getOffset()
offset
parameter.public RInt getLimit()
limit
parameter.public ParametersI unique()
public ParametersI noUnique()
public RBool getUnique()
public ParametersI exp(RLong i)
experimenter
parameter.i
- The Id of the experimenter.public ParametersI allExps()
experimenter
parameter from the map.public boolean isExperimenter()
true
if the filter contains and ownerId
parameter, false
otherwise.public RLong getExperimenter()
experimenter
parameter.public ParametersI grp(RLong i)
group
parameter.i
- The value to set.public ParametersI allGrps()
group
parameter from the map.public boolean isGroup()
true
if the filter contains an groupId
,
false
otherwise.public RLong getGroup()
group
parameter.public ParametersI startTime(RTime startTime)
start time
parameter.startTime
- The time to set.public ParametersI endTime(RTime endTime)
end time
parameter.endTime
- The time to set.public ParametersI allTimes()
public boolean isStartTime()
true
if the map contains the start time
parameter, false
otherwise.public boolean isEndTime()
true
if the map contains the end time
parameter, false
otherwise.public RTime getStartTime()
start time
parameter.public RTime getEndTime()
end time
parameter.public ParametersI leaves()
leaf
parameter to true
.public ParametersI noLeaves()
leaf
parameter to false
.public RBool getLeaves()
public ParametersI orphan()
orphan
parameter to true
.public ParametersI noOrphan()
orphan
parameter to false
.public RBool getOrphan()
public ParametersI acquisitionData()
acquisition data
parameter to true
.public ParametersI noAcquisitionData()
acquisition data
parameter to false
.public RBool getAcquisitionData()
public ParametersI cache()
public ParametersI noCache()
public RBool getCache()
public ParametersI add(java.lang.String name, RType r)
public ParametersI addId(long id)
public ParametersI addId(RLong id)
public ParametersI addIds(java.util.Collection<java.lang.Long> longs)
public ParametersI addLong(java.lang.String name, long l)
public ParametersI addLong(java.lang.String name, RLong l)
public ParametersI addLongs(java.lang.String name, java.util.Collection<java.lang.Long> longs)