org.apache.ws.jaxme

Class PMParams

Implemented Interfaces:
Serializable

public class PMParams
extends java.lang.Object
implements Serializable

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

Nested Class Summary

static class
PMParams.Param
A single parameter.

Method Summary

void
addDateParam(Calendar pParam)
Adds a Date parameter.
void
addDateTimeParam(Calendar pParam)
Adds a DateTime parameter.
void
addParam(Byte pParam)
Adds a Byte parameter.
void
addParam(Integer pParam)
Adds an Integer parameter.
void
addParam(Long pParam)
Adds a Long parameter.
void
addParam(Short pParam)
Adds a Short parameter.
void
addParam(String pParam)
Adds a String parameter.
void
addParam(byte pParam)
Adds a byte parameter.
void
addParam(byte[] pParam)
Adds a VARBINARY parameter.
void
addParam(int pParam)
Adds an int parameter.
void
addParam(long pParam)
Adds a long parameter.
void
addParam(PMParams.Param pParam)
Adds a new parameter.
void
addParam(short pParam)
Adds a short parameter.
void
addTimeParam(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().
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).

Method Details

addDateParam

public void addDateParam(Calendar pParam)
Adds a Date parameter.

addDateTimeParam

public void addDateTimeParam(Calendar pParam)
Adds a DateTime parameter.

addParam

public void addParam(Byte pParam)
Adds a Byte parameter.

addParam

public void addParam(Integer pParam)
Adds an Integer parameter.

addParam

public void addParam(Long pParam)
Adds a Long parameter.

addParam

public void addParam(Short pParam)
Adds a Short parameter.

addParam

public void addParam(String pParam)
Adds a String parameter.

addParam

public void addParam(byte pParam)
Adds a byte parameter.

addParam

public void addParam(byte[] pParam)
Adds a VARBINARY parameter.

addParam

public void addParam(int pParam)
Adds an int parameter.

addParam

public void addParam(long pParam)
Adds a long parameter.

addParam

public void addParam(PMParams.Param pParam)
Adds a new parameter.

addParam

public void addParam(short pParam)
Adds a short parameter.

addTimeParam

public void addTimeParam(Calendar pParam)
Adds a Time parameter.

getMaxResultDocuments

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

getNumParams

public int getNumParams()
Returns the number of parameters added with addParam().

getParams

public Iterator getParams()

getSkippedResultDocuments

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

isDistinct

public boolean isDistinct()
Returns whether the query should guarantee to return only distinct objects by activating the DISTINCT clause.

setDistinct

public void setDistinct(boolean pDistinct)
Sets whether the query should guarantee to return only distinct objects by activating the DISTINCT clause.

setMaxResultDocuments

public void setMaxResultDocuments(int pMax)
Sets the maximum number of result documents.

setSkippedResultDocuments

public void setSkippedResultDocuments(int pStart)
Sets the maximum number of documents to skip at the beginning (soft cursoring).