EclipseLink Core 4.0.2 · org.eclipse.persistence.internal.expressions.ParameterExpression

Modifier and Type	Field and Description
protected Boolean	canBind 'True' indicates this expression can bind parameters 'False' indicates this expression cannot bind parameters Defaults to 'null' to indicate specific no preference
protected DatabaseField	field The parameter field or name.
protected boolean	isProperty
protected Expression	localBase The opposite side of the relation, this is used for conversion of the parameter using the others mapping.
pack-priv Object	type The inferred type of the parameter.

Access	Constructor and Description
public	ParameterExpression()
public	ParameterExpression(String fieldName)
public	ParameterExpression(DatabaseField field)
public	ParameterExpression(String fieldName, Expression localbaseExpression, Object type)
public	ParameterExpression(DatabaseField field, Expression localbaseExpression)

Method Summary

Modifier and Type	Method and Description
public String	basicDescription() Return description.
public Boolean	canBind() INTERNAL: true indicates this expression can bind parameters false indicates this expression cannot bind parameters Defaults to null to indicate no specific preference
public int	computeHashCode() Overrides org.eclipse.persistence.expressions.Expression.computeHashCode. INTERNAL: Compute a consistent hash-code for the expression.
public String	descriptionOfNodeType() Overrides org.eclipse.persistence.expressions.Expression.descriptionOfNodeType. INTERNAL: Used for debug printing.
public boolean	equals(Object the reference object with which to compare. object) Overrides org.eclipse.persistence.expressions.Expression.equals. INTERNAL: Return if the expression is equal to the other.
public Expression	get(String attributeOrQueryKey) Overrides org.eclipse.persistence.expressions.Expression.get. This allows for nesting of parameterized expression.
public ExpressionBuilder	getBuilder() Overrides org.eclipse.persistence.internal.expressions.BaseExpression.getBuilder. Return the expression builder which is the ultimate base of this expression, or null if there isn't one (shouldn't happen if we start from a root)
public DatabaseField	getField()
public Expression	getField(DatabaseField field) Overrides org.eclipse.persistence.expressions.Expression.getField. This allows for nesting of parametrized expression.
public Expression	getLocalBase() The opposite side of the relation, this is used for conversion of the parameter using the others mapping.
public Object	getType() The inferred type of this parameter.
public Object	getValue(AbstractRecord translationRow, AbstractSession session) Extract the value from the row.
public Object	getValue(AbstractRecord translationRow, DatabaseQuery query, AbstractSession session) Extract the value from the row.
public boolean	isParameterExpression() Overrides org.eclipse.persistence.expressions.Expression.isParameterExpression. INTERNAL:
public boolean	isProperty() INTERNAL: Return true if this parameter expression maps to a property.
public boolean	isValueExpression() Overrides org.eclipse.persistence.expressions.Expression.isValueExpression. INTERNAL:
protected void	postCopyIn(Map<K, V> alreadyDone) Overrides org.eclipse.persistence.internal.expressions.BaseExpression.postCopyIn. INTERNAL: Used for cloning.
public void	printJava(ExpressionJavaPrinter printer) Overrides org.eclipse.persistence.expressions.Expression.printJava. INTERNAL: Print java for project class generation
public void	printSQL(ExpressionSQLPrinter printer) Implements abstract org.eclipse.persistence.expressions.Expression.printSQL. INTERNAL: Print SQL onto the stream, using the ExpressionPrinter for context
public Expression	rebuildOn(Expression newBase) Implements abstract org.eclipse.persistence.expressions.Expression.rebuildOn. INTERNAL: This expression is built on a different base than the one we want.
public void	resetPlaceHolderBuilder(ExpressionBuilder queryBuilder) Overrides org.eclipse.persistence.internal.expressions.BaseExpression.resetPlaceHolderBuilder. INTERNAL: Search the tree for any expressions (like SubSelectExpressions) that have been built using a builder that is not attached to the query.
public void	setCanBind(Boolean canBind) INTERNAL: Set to true if this expression can bind parameters Set to false if this expression cannot bind parameters Set to null to indicate no specific preference
public void	setField(DatabaseField field) INTERNAL: Used to set the internal field value.
public void	setIsProperty(boolean isProperty) INTERNAL: Set to true if this parameter expression maps to a property value.
public void	setLocalBase(Expression localBase) Overrides org.eclipse.persistence.expressions.Expression.setLocalBase. The opposite side of the relation, this is used for conversion of the parameter using the others mapping.
public void	setType(Object type) The inferred type of this parameter.
public Expression	twistedForBaseAndContext(Expression newBase, Expression context, Expression oldBase) Overrides org.eclipse.persistence.expressions.Expression.twistedForBaseAndContext. INTERNAL: Rebuild against the base, with the values of parameters supplied by the context expression.
protected void	validateParameterValueAgainstMapping(Object value, boolean useBaseExpression) INTERNAL Validate the passed parameter against the local base mapping.
public Object	valueFromObject(Object object, AbstractSession session, AbstractRecord translationRow, int valueHolderPolicy, boolean true if object possibly not a clone, but is being conformed against the unit of work cache. isObjectUnregistered) Overrides org.eclipse.persistence.expressions.Expression.valueFromObject. INTERNAL: Return the value for in memory comparison.
public void	writeDescriptionOn(BufferedWriter writer) Overrides org.eclipse.persistence.expressions.Expression.writeDescriptionOn. INTERNAL: Used to print a debug form of the expression tree.
public void	writeFields(ExpressionSQLPrinter printer, List<DatabaseField> newFields, SQLSelectStatement statement) Overrides org.eclipse.persistence.expressions.Expression.writeFields. INTERNAL: Append the parameter into the printer.
public void	writeSubexpressionsTo(BufferedWriter writer, int indent) Overrides org.eclipse.persistence.expressions.Expression.writeSubexpressionsTo. Print the base for debuggin purposes.

Inherited from org.eclipse.persistence.internal.expressions.BaseExpression:: getBaseExpression setBaseExpression shallowClone

canBind	back to summary
protected Boolean canBind 'True' indicates this expression can bind parameters 'False' indicates this expression cannot bind parameters Defaults to 'null' to indicate specific no preference

field	back to summary
protected DatabaseField field The parameter field or name.

isProperty	back to summary
protected boolean isProperty

localBase	back to summary
protected Expression localBase The opposite side of the relation, this is used for conversion of the parameter using the others mapping.

type	back to summary
pack-priv Object type The inferred type of the parameter. Please note that the type might not be always initialized to correct value. It might be null if not initialized correctly.

ParameterExpression	back to summary
public ParameterExpression()

ParameterExpression	back to summary
public ParameterExpression(String fieldName)

ParameterExpression	back to summary
public ParameterExpression(DatabaseField field)

ParameterExpression	back to summary
public ParameterExpression(String fieldName, Expression localbaseExpression, Object type)

ParameterExpression	back to summary
public ParameterExpression(DatabaseField field, Expression localbaseExpression)

Method Detail

basicDescription	back to summary
public String basicDescription() Return description. Used for toString.

canBind	back to summary
public Boolean canBind() INTERNAL: true indicates this expression can bind parameters false indicates this expression cannot bind parameters Defaults to null to indicate no specific preference

computeHashCode	back to summary
public int computeHashCode() Overrides org.eclipse.persistence.expressions.Expression.computeHashCode. INTERNAL: Compute a consistent hash-code for the expression. This is used to allow dynamic expression's SQL to be cached. Annotations @Override

computeHashCode

back to summary

public int computeHashCode()

Overrides org.eclipse.persistence.expressions.Expression.computeHashCode.

INTERNAL: Compute a consistent hash-code for the expression. This is used to allow dynamic expression's SQL to be cached.

Annotations

@Override

descriptionOfNodeType	back to summary
public String descriptionOfNodeType() Overrides org.eclipse.persistence.expressions.Expression.descriptionOfNodeType. INTERNAL: Used for debug printing. Annotations @Override

descriptionOfNodeType

back to summary

public String descriptionOfNodeType()

Overrides org.eclipse.persistence.expressions.Expression.descriptionOfNodeType.

INTERNAL: Used for debug printing.

Annotations

@Override

equals back to summary

equals	back to summary
public boolean equals(Object object) Overrides org.eclipse.persistence.expressions.Expression.equals. INTERNAL: Return if the expression is equal to the other. This is used to allow dynamic expression's SQL to be cached. Parameters object:Object Doc from java.lang.Object.equals. the reference object with which to compare. Returns:boolean Doc from java.lang.Object.equals. `true` if this object is the same as the obj argument; `false` otherwise. Annotations @Override

public boolean equals(Object object)

Overrides org.eclipse.persistence.expressions.Expression.equals.

INTERNAL: Return if the expression is equal to the other. This is used to allow dynamic expression's SQL to be cached.

Parameters

object:Object

Doc from java.lang.Object.equals.

the reference object with which to compare.

Returns:boolean

Doc from java.lang.Object.equals.

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

get	back to summary
public Expression get(String attributeOrQueryKey) Overrides org.eclipse.persistence.expressions.Expression.get. This allows for nesting of parameterized expression. This is used for parameterizing object comparisons. Annotations @Override

get

back to summary

public Expression get(String attributeOrQueryKey)

Overrides org.eclipse.persistence.expressions.Expression.get.

This allows for nesting of parameterized expression. This is used for parameterizing object comparisons.

Annotations

@Override

getBuilder	back to summary
public ExpressionBuilder getBuilder() Overrides org.eclipse.persistence.internal.expressions.BaseExpression.getBuilder. Return the expression builder which is the ultimate base of this expression, or null if there isn't one (shouldn't happen if we start from a root) Annotations @Override

getBuilder

back to summary

public ExpressionBuilder getBuilder()

Overrides org.eclipse.persistence.internal.expressions.BaseExpression.getBuilder.

Return the expression builder which is the ultimate base of this expression, or null if there isn't one (shouldn't happen if we start from a root)

Annotations

@Override

getField	back to summary
public DatabaseField getField()

getField	back to summary
public Expression getField(DatabaseField field) Overrides org.eclipse.persistence.expressions.Expression.getField. This allows for nesting of parametrized expression. This is used for parameterizing object comparisons. Annotations @Override

getField

back to summary

public Expression getField(DatabaseField field)

Overrides org.eclipse.persistence.expressions.Expression.getField.

This allows for nesting of parametrized expression. This is used for parameterizing object comparisons.

Annotations

@Override

getLocalBase	back to summary
public Expression getLocalBase() The opposite side of the relation, this is used for conversion of the parameter using the others mapping.

getType	back to summary
public Object getType() The inferred type of this parameter. Please note that the type might not be always initialized to correct value. It might be null if not initialized correctly

getValue	back to summary
public Object getValue(AbstractRecord translationRow, AbstractSession session) Extract the value from the row. This may require recursion if it is a nested parameter.

getValue	back to summary
public Object getValue(AbstractRecord translationRow, DatabaseQuery query, AbstractSession session) Extract the value from the row. This may require recursion if it is a nested parameter.

isParameterExpression	back to summary
public boolean isParameterExpression() Overrides org.eclipse.persistence.expressions.Expression.isParameterExpression. Doc from org.eclipse.persistence.expressions.Expression.isParameterExpression. INTERNAL: Annotations @Override

isParameterExpression

back to summary

public boolean isParameterExpression()

Overrides org.eclipse.persistence.expressions.Expression.isParameterExpression.

Doc from org.eclipse.persistence.expressions.Expression.isParameterExpression.

INTERNAL:

Annotations

@Override

isProperty	back to summary
public boolean isProperty() INTERNAL: Return true if this parameter expression maps to a property.

isValueExpression	back to summary
public boolean isValueExpression() Overrides org.eclipse.persistence.expressions.Expression.isValueExpression. INTERNAL: Annotations @Override

isValueExpression

back to summary

public boolean isValueExpression()

Overrides org.eclipse.persistence.expressions.Expression.isValueExpression.

INTERNAL:

Annotations

@Override

postCopyIn	back to summary
protected void postCopyIn(Map<K, V> alreadyDone) Overrides org.eclipse.persistence.internal.expressions.BaseExpression.postCopyIn. INTERNAL: Used for cloning. Annotations @Override

postCopyIn

back to summary

protected void postCopyIn(Map<K, V> alreadyDone)

Overrides org.eclipse.persistence.internal.expressions.BaseExpression.postCopyIn.

INTERNAL: Used for cloning.

Annotations

@Override

printJava	back to summary
public void printJava(ExpressionJavaPrinter printer) Overrides org.eclipse.persistence.expressions.Expression.printJava. INTERNAL: Print java for project class generation Annotations @Override

printJava

back to summary

public void printJava(ExpressionJavaPrinter printer)

Overrides org.eclipse.persistence.expressions.Expression.printJava.

INTERNAL: Print java for project class generation

Annotations

@Override

printSQL	back to summary
public void printSQL(ExpressionSQLPrinter printer) Implements abstract org.eclipse.persistence.expressions.Expression.printSQL. INTERNAL: Print SQL onto the stream, using the ExpressionPrinter for context Annotations @Override

printSQL

back to summary

public void printSQL(ExpressionSQLPrinter printer)

Implements abstract org.eclipse.persistence.expressions.Expression.printSQL.

INTERNAL: Print SQL onto the stream, using the ExpressionPrinter for context

Annotations

@Override

rebuildOn	back to summary
public Expression rebuildOn(Expression newBase) Implements abstract org.eclipse.persistence.expressions.Expression.rebuildOn. INTERNAL: This expression is built on a different base than the one we want. Rebuild it and return the root of the new tree Annotations @Override

rebuildOn

back to summary

public Expression rebuildOn(Expression newBase)

Implements abstract org.eclipse.persistence.expressions.Expression.rebuildOn.

INTERNAL: This expression is built on a different base than the one we want. Rebuild it and return the root of the new tree

Annotations

@Override

resetPlaceHolderBuilder	back to summary
public void resetPlaceHolderBuilder(ExpressionBuilder queryBuilder) Overrides org.eclipse.persistence.internal.expressions.BaseExpression.resetPlaceHolderBuilder. INTERNAL: Search the tree for any expressions (like SubSelectExpressions) that have been built using a builder that is not attached to the query. This happens in case of an Exists call using a new ExpressionBuilder(). This builder needs to be replaced with one from the query. Annotations @Override

resetPlaceHolderBuilder

back to summary

public void resetPlaceHolderBuilder(ExpressionBuilder queryBuilder)

Overrides org.eclipse.persistence.internal.expressions.BaseExpression.resetPlaceHolderBuilder.

INTERNAL: Search the tree for any expressions (like SubSelectExpressions) that have been built using a builder that is not attached to the query. This happens in case of an Exists call using a new ExpressionBuilder(). This builder needs to be replaced with one from the query.

Annotations

@Override

setCanBind	back to summary
public void setCanBind(Boolean canBind) INTERNAL: Set to true if this expression can bind parameters Set to false if this expression cannot bind parameters Set to null to indicate no specific preference

setField	back to summary
public void setField(DatabaseField field) INTERNAL: Used to set the internal field value.

setIsProperty	back to summary
public void setIsProperty(boolean isProperty) INTERNAL: Set to true if this parameter expression maps to a property value.

setLocalBase	back to summary
public void setLocalBase(Expression localBase) Overrides org.eclipse.persistence.expressions.Expression.setLocalBase. The opposite side of the relation, this is used for conversion of the parameter using the others mapping. Annotations @Override

setLocalBase

back to summary

public void setLocalBase(Expression localBase)

Overrides org.eclipse.persistence.expressions.Expression.setLocalBase.

The opposite side of the relation, this is used for conversion of the parameter using the others mapping.

Annotations

@Override

setType	back to summary
public void setType(Object type) The inferred type of this parameter. Please note that the type might not be always initialized to correct value. It might be null if not initialized correctly

twistedForBaseAndContext	back to summary
public Expression twistedForBaseAndContext(Expression newBase, Expression context, Expression oldBase) Overrides org.eclipse.persistence.expressions.Expression.twistedForBaseAndContext. INTERNAL: Rebuild against the base, with the values of parameters supplied by the context expression. This is used for transforming a standalone expression (e.g. the join criteria of a mapping) into part of some larger expression. You normally would not call this directly, instead calling twist, (see the comment there for more details). Annotations @Override

twistedForBaseAndContext

back to summary

public Expression twistedForBaseAndContext(Expression newBase, Expression context, Expression oldBase)

Overrides org.eclipse.persistence.expressions.Expression.twistedForBaseAndContext.

INTERNAL: Rebuild against the base, with the values of parameters supplied by the context expression. This is used for transforming a standalone expression (e.g. the join criteria of a mapping) into part of some larger expression. You normally would not call this directly, instead calling twist, (see the comment there for more details).

Annotations

@Override

validateParameterValueAgainstMapping	back to summary
protected void validateParameterValueAgainstMapping(Object value, boolean useBaseExpression) INTERNAL Validate the passed parameter against the local base mapping. Throw a QueryException if the parameter is of an incorrect class for object comparison. Added for Bug 245268

valueFromObject	back to summary
public Object valueFromObject(Object object, AbstractSession session, AbstractRecord translationRow, int valueHolderPolicy, boolean isObjectUnregistered) Overrides org.eclipse.persistence.expressions.Expression.valueFromObject. INTERNAL: Return the value for in memory comparison. This is only valid for valueable expressions. Parameters isObjectUnregistered:boolean Doc from org.eclipse.persistence.expressions.Expression.valueFromObject. true if object possibly not a clone, but is being conformed against the unit of work cache. Annotations @Override

valueFromObject

back to summary

public Object valueFromObject(Object object, AbstractSession session, AbstractRecord translationRow, int valueHolderPolicy, boolean isObjectUnregistered)

Overrides org.eclipse.persistence.expressions.Expression.valueFromObject.

INTERNAL: Return the value for in memory comparison. This is only valid for valueable expressions.

Parameters

isObjectUnregistered:boolean

Doc from org.eclipse.persistence.expressions.Expression.valueFromObject.

true if object possibly not a clone, but is being conformed against the unit of work cache.

Annotations

@Override

writeDescriptionOn	back to summary
public void writeDescriptionOn(BufferedWriter writer) throws IOException Overrides org.eclipse.persistence.expressions.Expression.writeDescriptionOn. INTERNAL: Used to print a debug form of the expression tree. Annotations @Override

writeDescriptionOn

back to summary

public void writeDescriptionOn(BufferedWriter writer) throws IOException

Overrides org.eclipse.persistence.expressions.Expression.writeDescriptionOn.

INTERNAL: Used to print a debug form of the expression tree.

Annotations

@Override

writeFields	back to summary
public void writeFields(ExpressionSQLPrinter printer, List<DatabaseField> newFields, SQLSelectStatement statement) Overrides org.eclipse.persistence.expressions.Expression.writeFields. INTERNAL: Append the parameter into the printer. "Normal" ReadQuery never has ParameterExpression in it's select clause hence for a "normal" ReadQuery this method is never called. The reason this method was added is that UpdateAllQuery (in case temporary storage is required) creates a "helper" ReportQuery with ReportItem corresponding to each update expression - and update expression may be a ParameterExpression. The call created by "helper" ReportQuery is never executed - it's used during construction of insert call into temporary storage. Annotations @Override

writeFields

back to summary

public void writeFields(ExpressionSQLPrinter printer, List<DatabaseField> newFields, SQLSelectStatement statement)

Overrides org.eclipse.persistence.expressions.Expression.writeFields.

INTERNAL: Append the parameter into the printer. "Normal" ReadQuery never has ParameterExpression in it's select clause hence for a "normal" ReadQuery this method is never called. The reason this method was added is that UpdateAllQuery (in case temporary storage is required) creates a "helper" ReportQuery with ReportItem corresponding to each update expression - and update expression may be a ParameterExpression. The call created by "helper" ReportQuery is never executed - it's used during construction of insert call into temporary storage.

Annotations

@Override

writeSubexpressionsTo	back to summary
public void writeSubexpressionsTo(BufferedWriter writer, int indent) throws IOException Overrides org.eclipse.persistence.expressions.Expression.writeSubexpressionsTo. Print the base for debuggin purposes. Annotations @Override

writeSubexpressionsTo

back to summary

public void writeSubexpressionsTo(BufferedWriter writer, int indent) throws IOException

Overrides org.eclipse.persistence.expressions.Expression.writeSubexpressionsTo.

Print the base for debuggin purposes.

Annotations

@Override

public Class ParameterExpression

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail