de.ispsoft.jaxme.generator.parserdata
Class JdbcListMethod

java.lang.Object
  de.ispsoft.jaxme.generator.parserdata.JdbcListMethod

public class JdbcListMethod

extends java.lang.Object

Holds the necessary data for a single "list" method, that is generated for a view.

Author:

Jochen Wiedmann

Constructor Summary

JdbcListMethod()
Creates a new instance of JdbcListMethod.

Method Summary

void	addParam(JdbcAbstractParameter pParam) Adds a new parameter to the list of parameters.
void	clearParams() Clears the list of parameters.
JdbcAbstractParameter[]	getAllParams() Returns the array of parameters.
java.lang.String	getDescription() Returns the method description.
int	getMaxResultSize() Returns the maximum result size, -1 for "unbounded".
int	getMinResultSize() Returns the minimum result size.
java.lang.String	getName() Returns the method name.
JdbcParam[]	getParams() Returns the array of placeholders.
java.lang.String	getPatternPart(int pNum) Returns the fixed part of the query with the given number.
JdbcPattern[]	getPatterns() Returns the array of patterns.
JdbcPlaceHolders[]	getPlaceHolders() Returns the array of placeholder arrays.
java.lang.String	getQuery() Returns the query.
boolean	isResultCollection() Returns true, if the maximum result size is > 1 or -1 ("unbounded").
void	setDescription(java.lang.String pDescription) Sets the method description.
void	setMaxResultSize(int pMaxResultSize) Sets the maximum result size.
void	setMinResultSize(int pMinResultSize) Sets the minimum result size.
void	setName(java.lang.String pName) Sets the method name.
void	setQuery(java.lang.String pQuery) Sets the query.

Methods inherited from class java.lang.Object

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

Constructor Detail

JdbcListMethod

public JdbcListMethod()

Creates a new instance of JdbcListMethod.

Method Detail

getName

public java.lang.String getName()

Returns the method name.

setName

public void setName(java.lang.String pName)

Sets the method name.

getQuery

public java.lang.String getQuery()

Returns the query.

setQuery

public void setQuery(java.lang.String pQuery)

Sets the query.

getAllParams

public JdbcAbstractParameter[] getAllParams()

Returns the array of parameters.

getParams

public JdbcParam[] getParams()

Returns the array of placeholders.

getPatterns

public JdbcPattern[] getPatterns()

Returns the array of patterns.

getPlaceHolders

public JdbcPlaceHolders[] getPlaceHolders()

Returns the array of placeholder arrays.

addParam

public void addParam(JdbcAbstractParameter pParam)

Adds a new parameter to the list of parameters.

clearParams

public void clearParams()

Clears the list of parameters.

getMinResultSize

public int getMinResultSize()

Returns the minimum result size.

setMinResultSize

public void setMinResultSize(int pMinResultSize)

Sets the minimum result size.

getMaxResultSize

public int getMaxResultSize()

Returns the maximum result size, -1 for "unbounded".

setMaxResultSize

public void setMaxResultSize(int pMaxResultSize)

Sets the maximum result size. Use -1 for "unbounded".

isResultCollection

public boolean isResultCollection()

Returns true, if the maximum result size is > 1 or -1 ("unbounded").

getPatternPart

public java.lang.String getPatternPart(int pNum)

Returns the fixed part of the query with the given number. For example, a query like

   SELECT * FROM {tables} WHERE {constraints} SORT BY {something}
 

consists of four fixed parts:

• The string SELECT * FROM
• The string WHERE
• The string SORT BY
• And the empty string (following the dynamic part {something})

setDescription

public void setDescription(java.lang.String pDescription)

Sets the method description.

getDescription

public java.lang.String getDescription()

Returns the method description.