File	Doc	Category	Size	Date	Package
JDOQLElements.java	API Doc	Glassfish v2 API	9454	Fri May 04 22:34:50 BST 2007	com.sun.jdo.spi.persistence.support.ejb.ejbqlc

JDOQLElements

• java.lang.Object

Fields Summary
private String	candidateClassName The name of the candidate class
private String	parameters The parameter declarations string.
private String	variables The variable declarations string.
private String	filter The filter expression string.
private String	ordering The ordering expression string.
private String	result The result expression.
private String	resultType The result type.
private boolean	isPCResult Flag indicating whether the result element is of a pc class.
private boolean	isAggregate Flag indicating whether the result element is associated to an aggregate function.
private String[]	parameterEjbNames String array contains ejb names corresponding to parameters

Constructors Summary

public JDOQLElements(String candidateClassName, String parameters, String variables, String filter, String ordering, String result, String resultType, boolean isPCResult, boolean isAggregate, String[] parameterEjbNames) Constructor taking JDOQL elements. setCandidateClassName(candidateClassName); setParameters(parameters); setVariables(variables); setFilter(filter); setOrdering(ordering); setResult(result); setResultType(resultType); setPCResult(isPCResult); setAggregate(isAggregate); setParameterEjbNames(parameterEjbNames);

Methods Summary
public java.lang.String	getCandidateClassName() Returns the fully qulified name of the candidate class. return this.candidateClassName;
public java.lang.String	getFilter() Returns the filter expression. return filter;
public java.lang.String	getOrdering() Returns the ordering expression. return ordering;
public java.lang.String[]	getParameterEjbNames() Returns parameterEjbNames array return parameterEjbNames;
public java.lang.String	getParameters() Returns the parameter declaration string. return parameters;
public java.lang.String	getResult() Returns the result expression. return result;
public java.lang.String	getResultType() Returns the result type. The result type is the name of the element type of the JDO query result set. return resultType;
public java.lang.String	getVariables() Returns the variable declarations string. return variables;
public boolean	isAggregate() Returns whether the result of the JDOQL query is associated to an aggregate function. return isAggregate;
public boolean	isPCResult() Returns whether the result of the JDOQL query is a collection of pc instances or not. return isPCResult;
public void	setAggregate(boolean isAggregate) Sets whether the result of the JDOQL query is a associated to an aggregate function. this.isAggregate = isAggregate;
public void	setCandidateClassName(java.lang.String candidateClassName) Sets the fully qulified name of the candidate class. // TBD: check non empty candidateClassName this.candidateClassName = candidateClassName;
public void	setFilter(java.lang.String filter) Sets the filter expression. this.filter = (filter == null) ? "" : filter; //NOI18N
public void	setOrdering(java.lang.String ordering) Sets the ordering expression. this.ordering = (ordering == null) ? "" : ordering; //NOI18N
public void	setPCResult(boolean isPCResult) Sets whether the result of the JDOQL query is a collection of pc instances or not. this.isPCResult = isPCResult;
public void	setParameterEjbNames(java.lang.String[] parameterEjbNames) set parameterEjbNames array this.parameterEjbNames = parameterEjbNames;
public void	setParameters(java.lang.String parameters) Sets the parameter declarations string. this.parameters = (parameters == null) ? "" : parameters; //NOI18N
public void	setResult(java.lang.String result) Sets the result expression. this.result = (result == null) ? "" : result; //NOI18N
public void	setResultType(java.lang.String resultType) Sets the result type. The result type is the name of the element type of the JDO query result set. this.resultType = resultType;
public void	setVariables(java.lang.String variables) Sets the variable declarations string. this.variables = (variables == null) ? "" : variables; //NOI18N
public java.lang.String	toString() Returns a string representation of this JDOQLElements instance. StringBuffer repr = new StringBuffer(); repr.append("JDOQLElements("); //NOI18N repr.append("candidateClass: "); //NOI18N repr.append(candidateClassName); if (parameters != null && parameters.length() > 0) { repr.append(", parameters: "); //NOI18N repr.append(parameters); } if (variables != null && variables.length() > 0) { repr.append(", variables: "); //NOI18N repr.append(variables); } if (filter != null && filter.length() > 0) { repr.append(", filter: "); //NOI18N repr.append(filter); } if (ordering != null && ordering.length() > 0) { repr.append(", ordering: "); //NOI18N repr.append(ordering); } if (result != null && result.length() > 0) { repr.append(", result: "); //NOI18N repr.append(result); repr.append(", resultType: "); //NOI18N repr.append(resultType); repr.append(", isPCResult: "); //NOI18N repr.append(isPCResult); } repr.append(", isAggregate: "); repr.append(isAggregate); if (parameterEjbNames != null && parameterEjbNames.length > 0) { repr.append(", parameterEjbNames: "); //NOI18N for (int i = 0; i < parameterEjbNames.length; i++) { repr.append(i); repr.append(": "); repr.append(parameterEjbNames[i]); repr.append(", "); } } repr.append(")"); //NOI18N return repr.toString();