org.apache.ws.jaxme
Class PMParams

java.lang.Object
  org.apache.ws.jaxme.PMParams

All Implemented Interfaces:

java.io.Serializable

public class PMParams
extends java.lang.Object
implements java.io.Serializable

Implementation of a parameter object for use in PM.select(Observer, String, PMParams).

Author:

Jochen Wiedmann

See Also:

Serialized Form

Nested Class Summary

static class

PMParams.Param A single parameter.

Constructor Summary

PMParams()

Method Summary

void	addDateParam(java.util.Calendar pParam) Adds a Date parameter.
void	addDateTimeParam(java.util.Calendar pParam) Adds a DateTime parameter.
void	addParam(byte pParam) Adds a byte parameter.
void	addParam(java.lang.Byte pParam) Adds a Byte parameter.
void	addParam(byte[] pParam) Adds a VARBINARY parameter.
void	addParam(int pParam) Adds an int parameter.
void	addParam(java.lang.Integer pParam) Adds an Integer parameter.
void	addParam(long pParam) Adds a long parameter.
void	addParam(java.lang.Long pParam) Adds a Long parameter.
void	addParam(PMParams.Param pParam) Adds a new parameter.
void	addParam(short pParam) Adds a short parameter.
void	addParam(java.lang.Short pParam) Adds a Short parameter.
void	addParam(java.lang.String pParam) Adds a String parameter.
void	addTimeParam(java.util.Calendar pParam) Adds a Time parameter.
int	getMaxResultDocuments() Returns the maximum number of result documents or 0 (default) for an unlimited number.
int	getNumParams() Returns the number of parameters added with addParam().
java.util.Iterator	getParams() Returns an Iterator to the list of parameters.
int	getSkippedResultDocuments() Sets the maximum number of documents to skip at the beginning or 0 (default) to skip no documents.
boolean	isDistinct() Returns whether the query should guarantee to return only distinct objects by activating the DISTINCT clause.
void	setDistinct(boolean pDistinct) Sets whether the query should guarantee to return only distinct objects by activating the DISTINCT clause.
void	setMaxResultDocuments(int pMax) Sets the maximum number of result documents.
void	setSkippedResultDocuments(int pStart) Sets the maximum number of documents to skip at the beginning (soft cursoring).

Methods inherited from class java.lang.Object

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

Constructor Detail

PMParams

public PMParams()

Method Detail

addParam

public void addParam(PMParams.Param pParam)

Adds a new parameter.

addParam

public void addParam(java.lang.String pParam)

Adds a String parameter.

addParam

public void addParam(java.lang.Long pParam)

Adds a Long parameter.

addParam

public void addParam(long pParam)

Adds a long parameter.

addParam

public void addParam(java.lang.Integer pParam)

Adds an Integer parameter.

addParam

public void addParam(int pParam)

Adds an int parameter.

addParam

public void addParam(java.lang.Short pParam)

Adds a Short parameter.

addParam

public void addParam(short pParam)

Adds a short parameter.

addParam

public void addParam(java.lang.Byte pParam)

Adds a Byte parameter.

addParam

public void addParam(byte pParam)

Adds a byte parameter.

addDateTimeParam

public void addDateTimeParam(java.util.Calendar pParam)

Adds a DateTime parameter.

addParam

public void addParam(byte[] pParam)

Adds a VARBINARY parameter.

addDateParam

public void addDateParam(java.util.Calendar pParam)

Adds a Date parameter.

addTimeParam

public void addTimeParam(java.util.Calendar pParam)

Adds a Time parameter.

setMaxResultDocuments

public void setMaxResultDocuments(int pMax)

Sets the maximum number of result documents.

getMaxResultDocuments

public int getMaxResultDocuments()

Returns the maximum number of result documents or 0 (default) for an unlimited number.

setSkippedResultDocuments

public void setSkippedResultDocuments(int pStart)

Sets the maximum number of documents to skip at the beginning (soft cursoring).

getSkippedResultDocuments

public int getSkippedResultDocuments()

Sets the maximum number of documents to skip at the beginning or 0 (default) to skip no documents.

getNumParams

public int getNumParams()

Returns the number of parameters added with addParam().

getParams

public java.util.Iterator getParams()

Returns an Iterator to the list of parameters. Any element in the list is an instance of PMParams.Param.

setDistinct

public void setDistinct(boolean pDistinct)

Sets whether the query should guarantee to return only distinct objects by activating the DISTINCT clause.

isDistinct

public boolean isDistinct()

Returns whether the query should guarantee to return only distinct objects by activating the DISTINCT clause.