LikeEscapeOperatorNode.java
| Index Score | ||
|---|---|---|
 |
 |
org.apache.derby.impl.sql.compile |
 |
 |
Apache Derby |
View: Reasons, Metrics, Source Code
These are the metrics that contribute to the Enerjy Score for this file, ranked by impact. So the metrics listed at the top influence the score to a greater extent that the metrics listed at the bottom.
| Metric | Description | |
|---|---|---|
| EXEC_COMMENTS | Comments in executable code |  |
| LINE_COMMENT | Number of line comments | |
| BLOCK_COMMENT | Number of block comment lines | |
| RETURNS | Number of return points from functions | |
| COMMENTS | Comment lines | |
| SIZE | Size of the file in bytes | |
| LINES | Number of lines in the source file | |
| INTERFACE_COMPLEXITY | Interface complexity | |
| LOC | Lines of code | |
| ELOC | Effective lines of code | |
| JAVA0075 | JAVA0075 Method parameter hides field | |
| JAVA0034 | JAVA0034 Missing braces in if statement | |
| JAVA0177 | JAVA0177 Variable declaration missing initializer | |
| EXITS | Procedure exits | |
| JAVA0285 | JAVA0285 Dereference of potentially null variable | |
| OPERATORS | Number of operators | |
| PROGRAM_LENGTH | Halstead program length | |
| WHITESPACE | Number of whitespace lines | |
| OPERANDS | Number of operands | |
| JAVA0080 | JAVA0080 Import declaration not used | |
| COMPARISONS | Number of comparison operators | |
| JAVA0117 | JAVA0117 Missing javadoc: method 'method' | |
| PROGRAM_VOLUME | Halstead program volume | |
| JAVA0174 | JAVA0174 Assigned local variable never used | |
| JAVA0106 | JAVA0106 Unnecessary import from current package | |
| JAVA0126 | JAVA0126 Method declares unchecked exception in throws | |
| UNIQUE_OPERANDS | Number of unique operands | |
| JAVA0110 | JAVA0110 Incorrect javadoc: no @return tag | |
| PROGRAM_VOCAB | Halstead program vocabulary | |
| JAVA0171 | JAVA0171 Unused local variable | |
| DOC_COMMENT | Number of javadoc comment lines | |
| LOOPS | Number of loops | |
| JAVA0108 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| FUNCTIONS | Number of function declarations | |
| CYCLOMATIC | Cyclomatic complexity | |
| LOGICAL_LINES | Number of statements | |
| JAVA0145 | JAVA0145 Tab character used in source file | |
/*
Derby - Class org.apache.derby.impl.sql.compile.LikeEscapeOperatorNode
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
this work for additional information regarding copyright ownership.
The ASF licenses this file to you under the Apache License, Version 2.0
(the "License"); you may not use this file except in compliance with
the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
package org.apache.derby.impl.sql.compile;
import org.apache.derby.iapi.services.compiler.MethodBuilder;
import org.apache.derby.iapi.sql.compile.C_NodeTypes;
import org.apache.derby.iapi.services.sanity.SanityManager;
import org.apache.derby.iapi.error.StandardException;
import org.apache.derby.iapi.sql.dictionary.DataDictionary;
import org.apache.derby.iapi.sql.conn.LanguageConnectionContext;
import org.apache.derby.iapi.types.TypeId;
import org.apache.derby.iapi.types.StringDataValue;
import org.apache.derby.iapi.types.DataTypeDescriptor;
import org.apache.derby.iapi.sql.compile.TypeCompiler;
import org.apache.derby.iapi.reference.SQLState;
import org.apache.derby.impl.sql.compile.ExpressionClassBuilder;
import org.apache.derby.iapi.services.compiler.LocalField;
import org.apache.derby.iapi.util.ReuseFactory;
import java.lang.reflect.Modifier;
import org.apache.derby.iapi.services.classfile.VMOpcode;
import org.apache.derby.iapi.types.Like;
import java.sql.Types;
import org.apache.derby.iapi.reference.ClassName;
import java.util.Vector;
/**
This node represents a like comparison operator (no escape)
If the like pattern is a constant or a parameter then if possible
the like is modified to include a >= and < operator. In some cases
the like can be eliminated. By adding =, >= or < operators it may
allow indexes to be used to greatly narrow the search range of the
query, and allow optimizer to estimate number of rows to affected.
constant or parameter LIKE pattern with prefix followed by optional wild
card e.g. Derby%
CHAR(n), VARCHAR(n) where n < 255
>= prefix padded with '\u0000' to length n -- e.g. Derby\u0000\u0000
<= prefix appended with '\uffff' -- e.g. Derby\uffff
[ can eliminate LIKE if constant. ]
CHAR(n), VARCHAR(n), LONG VARCHAR where n >= 255
>= prefix backed up one characer
<= prefix appended with '\uffff'
no elimination of like
parameter like pattern starts with wild card e.g. %Derby
CHAR(n), VARCHAR(n) where n <= 256
>= '\u0000' padded with '\u0000' to length n
<= '\uffff'
no elimination of like
CHAR(n), VARCHAR(n), LONG VARCHAR where n > 256
>= NULL
<= '\uffff'
Note that the Unicode value '\uffff' is defined as not a character value
and can be used by a program for any purpose. We use it to set an upper
bound on a character range with a less than predicate. We only need a single
'\uffff' appended because the string 'Derby\uffff\uffff' is not a valid
String because '\uffff' is not a valid character.
**/
public final class LikeEscapeOperatorNode extends TernaryOperatorNode
{
/**************************************************************************
* Fields of the class
**************************************************************************
*/
boolean addedEquals;
String escape;
/**
* Initializer for a LikeEscapeOperatorNode
*
* receiver like pattern [ escape escapeValue ]
*
* @param receiver The left operand of the like:
* column, CharConstant or Parameter
* @param leftOperand The right operand of the like: the pattern
* @param rightOperand The optional escape clause, null if not present
*/
public void init(
Object receiver,
Object leftOperand,
Object rightOperand)
{
/* By convention, the method name for the like operator is "like" */
super.init(
receiver, leftOperand, rightOperand,
ReuseFactory.getInteger(TernaryOperatorNode.LIKE), null);
}
/**
* implement binding for like expressions.
* <p>
* overrides BindOperatorNode.bindExpression because like has special
* requirements for parameter binding.
*
* @return The new top of the expression tree.
*
* @exception StandardException thrown on failure
*/
public ValueNode bindExpression(
FromList fromList,
SubqueryList subqueryList,
Vector aggregateVector)
throws StandardException
{
super.bindExpression(fromList, subqueryList, aggregateVector);
String pattern = null;
// pattern must be a string or a parameter
if (!(leftOperand.requiresTypeFromContext()) &&
!(leftOperand.getTypeId().isStringTypeId()))
{
throw StandardException.newException(
SQLState.LANG_DB2_FUNCTION_INCOMPATIBLE, "LIKE", "FUNCTION");
}
// escape must be a string or a parameter
if ((rightOperand != null) &&
!(rightOperand.requiresTypeFromContext()) &&
!(rightOperand.getTypeId().isStringTypeId()))
{
throw StandardException.newException(
SQLState.LANG_DB2_FUNCTION_INCOMPATIBLE, "LIKE", "FUNCTION");
}
// deal with operand parameters
/*
* Is there a ? parameter on the left? ie. "? like 'Derby'"
*
* Do left first because its length is always maximum;
* a parameter on the right copies its length from
* the left, since it won't match if it is any longer than it.
*/
if (receiver.requiresTypeFromContext())
{
receiver.setType(
new DataTypeDescriptor(
TypeId.getBuiltInTypeId(Types.VARCHAR), true));
//check if this parameter can pick up it's collation from pattern
//or escape clauses in that order. If not, then it will take it's
//collation from the compilation schema.
if (!leftOperand.requiresTypeFromContext()) {
receiver.setCollationInfo(leftOperand.getTypeServices());
} else if (rightOperand != null && !rightOperand.requiresTypeFromContext()) {
receiver.setCollationInfo(rightOperand.getTypeServices());
} else {
receiver.setCollationUsingCompilationSchema();
}
}
/*
* Is there a ? parameter for the PATTERN of LIKE? ie. "column like ?"
*
* Copy from the receiver -- legal if both are parameters,
* both will be max length.
* REMIND: should nullability be copied, or set to true?
*/
if (leftOperand.requiresTypeFromContext())
{
/*
* Set the pattern to the type of the left parameter, if
* the left is a string, otherwise set it to be VARCHAR.
*/
if (receiver.getTypeId().isStringTypeId())
{
leftOperand.setType(receiver.getTypeServices());
}
else
{
leftOperand.setType(
new DataTypeDescriptor(
TypeId.getBuiltInTypeId(Types.VARCHAR), true));
}
//collation of ? operand should be picked up from the context.
//By the time we come here, receiver will have correct collation
//set on it and hence we can rely on it to get correct collation
//for the other ? in LIKE clause
leftOperand.setCollationInfo(receiver.getTypeServices());
}
/*
* Is there a ? parameter for the ESCAPE of LIKE?
* Copy from the receiver -- legal if both are parameters,
* both will be max length. nullability is set to true.
*/
if (rightOperand != null && rightOperand.requiresTypeFromContext())
{
/*
* Set the pattern to the type of the left parameter, if
* the left is a string, otherwise set it to be VARCHAR.
*/
if (receiver.getTypeId().isStringTypeId())
{
rightOperand.setType(receiver.getTypeServices());
}
else
{
rightOperand.setType(
new DataTypeDescriptor(
TypeId.getBuiltInTypeId(Types.VARCHAR), true));
}
//collation of ? operand should be picked up from the context.
//By the time we come here, receiver will have correct collation
//set on it and hence we can rely on it to get correct collation
//for the other ? in LIKE clause
rightOperand.setCollationInfo(receiver.getTypeServices());
}
bindToBuiltIn();
TypeCompiler receiverTC = receiver.getTypeCompiler();
TypeCompiler leftTC = leftOperand.getTypeCompiler();
/* The receiver must be a string type
*/
if (! receiver.getTypeId().isStringTypeId())
{
throw StandardException.newException(
SQLState.LANG_DB2_FUNCTION_INCOMPATIBLE, "LIKE", "FUNCTION");
}
/* If either the left or right operands are non-string types,
* then we generate an implicit cast to VARCHAR.
*/
if (!leftOperand.getTypeId().isStringTypeId())
{
leftOperand = castArgToString(leftOperand);
leftTC = leftOperand.getTypeCompiler();
}
if (rightOperand != null)
{
rightOperand = castArgToString(rightOperand);
}
/*
* Remember whether or not the right side (the like pattern) is a string
* constant. We need to remember here so that we can transform LIKE
* 'constant' into = 'constant' for non unicode based collation columns.
*/
boolean leftConstant = (leftOperand instanceof CharConstantNode);
if (leftConstant)
{
pattern = ((CharConstantNode) leftOperand).getString();
}
boolean rightConstant = (rightOperand instanceof CharConstantNode);
if (rightConstant)
{
escape = ((CharConstantNode) rightOperand).getString();
if (escape.length() != 1)
{
throw StandardException.newException(
SQLState.LANG_INVALID_ESCAPE_CHARACTER, escape);
}
}
else if (rightOperand == null)
{
// No Escape clause: Let optimization continue for the = case below
rightConstant = true;
}
/* If we are comparing a UCS_BASIC char with a terriotry based char
* then we generate a cast above the receiver to force preprocess to
* not attempt any of the > <= optimizations since there is no
* way to determine the 'next' character for the <= operand.
*
* TODO-COLLATE - probably need to do something about different
* collation types here.
*/
// The left and the pattern of the LIKE must be same collation type
// and derivation.
if (!receiver.getTypeServices().compareCollationInfo(
leftOperand.getTypeServices()))
{
// throw error.
throw StandardException.newException(
SQLState.LANG_LIKE_COLLATION_MISMATCH,
receiver.getTypeServices().getSQLstring(),
receiver.getTypeServices().getCollationName(),
leftOperand.getTypeServices().getSQLstring(),
leftOperand.getTypeServices().getCollationName());
}
/* If the left side of LIKE is a ColumnReference and right side is a
* string constant without a wildcard (eg. column LIKE 'Derby') then we
* transform the LIKE into the equivalent LIKE AND =.
* If we have an escape clause it also must be a constant
* (eg. column LIKE 'Derby' ESCAPE '%').
*
* These types of transformations are normally done at preprocess time,
* but we make an exception and do this one at bind time because we
* transform a NOT LIKE 'a' into (a LIKE 'a') = false prior to
* preprocessing.
*
* The transformed tree will become:
*
* AND
* / \
* LIKE =
*/
if ((receiver instanceof ColumnReference) &&
leftConstant &&
rightConstant)
{
if (Like.isOptimizable(pattern))
{
String newPattern = null;
/*
* If our pattern has no pattern chars (after stripping them out
* for the ESCAPE case), we are good to apply = to this match
*/
if (escape != null)
{
/* we return a new pattern stripped of ESCAPE chars */
newPattern =
Like.stripEscapesNoPatternChars(
pattern, escape.charAt(0));
}
else if (pattern.indexOf('_') == -1 &&
pattern.indexOf('%') == -1)
{
// no pattern characters.
newPattern = pattern;
}
if (newPattern != null)
{
// met all conditions, transform LIKE into a "LIKE and ="
ValueNode leftClone = receiver.getClone();
// Remember that we did xform, see preprocess()
addedEquals = true;
// create equals node of the form (eg. column like 'Derby' :
// =
// / \
// column 'Derby'
BinaryComparisonOperatorNode equals =
(BinaryComparisonOperatorNode) getNodeFactory().getNode(
C_NodeTypes.BINARY_EQUALS_OPERATOR_NODE,
leftClone,
(ValueNode) getNodeFactory().getNode(
C_NodeTypes.CHAR_CONSTANT_NODE,
newPattern,
getContextManager()),
getContextManager());
// Set forQueryRewrite to bypass comparability checks
equals.setForQueryRewrite(true);
equals = (BinaryComparisonOperatorNode)
equals.bindExpression(
fromList, subqueryList, aggregateVector);
// create new and node and hook in "equals" the new "=' node
//
// AND
// / \
// LIKE =
// / \
// column 'Derby'
AndNode newAnd =
(AndNode) getNodeFactory().getNode(
C_NodeTypes.AND_NODE,
this,
equals,
getContextManager());
finishBindExpr();
newAnd.postBindFixup();
return newAnd;
}
}
}
finishBindExpr();
return this;
}
private void finishBindExpr()
throws StandardException
{
// deal with compatability of operands and result type
bindComparisonOperator();
/*
** The result type of LIKE is Boolean
*/
boolean nullableResult =
receiver.getTypeServices().isNullable() ||
leftOperand.getTypeServices().isNullable();
if (rightOperand != null)
{
nullableResult |= rightOperand.getTypeServices().isNullable();
}
setType(new DataTypeDescriptor(TypeId.BOOLEAN_ID, nullableResult));
}
/**
* Bind this operator
*
* @exception StandardException Thrown on error
*/
public void bindComparisonOperator()
throws StandardException
{
TypeId receiverType = receiver.getTypeId();
TypeId leftType = leftOperand.getTypeId();
/*
** Check the type of the operands - this function is allowed only on
** string types.
*/
if (!receiverType.isStringTypeId())
{
throw StandardException.newException(
SQLState.LANG_LIKE_BAD_TYPE, receiverType.getSQLTypeName());
}
if (!leftType.isStringTypeId())
{
throw StandardException.newException(
SQLState.LANG_LIKE_BAD_TYPE, leftType.getSQLTypeName());
}
if (rightOperand != null && ! rightOperand.getTypeId().isStringTypeId())
{
throw StandardException.newException(
SQLState.LANG_LIKE_BAD_TYPE,
rightOperand.getTypeId().getSQLTypeName());
}
}
/**
* Preprocess an expression tree. We do a number of transformations
* here (including subqueries, IN lists, LIKE and BETWEEN) plus
* subquery flattening.
* NOTE: This is done before the outer ResultSetNode is preprocessed.
*
* @param numTables Number of tables in the DML Statement
* @param outerFromList FromList from outer query block
* @param outerSubqueryList SubqueryList from outer query block
* @param outerPredicateList PredicateList from outer query block
*
* @return The modified expression
*
* @exception StandardException Thrown on error
*/
public ValueNode preprocess(
int numTables,
FromList outerFromList,
SubqueryList outerSubqueryList,
PredicateList outerPredicateList)
throws StandardException
{
boolean eliminateLikeComparison = false;
String greaterEqualString = null;
String lessThanString = null;
/* We must 1st preprocess the component parts */
super.preprocess(
numTables, outerFromList, outerSubqueryList, outerPredicateList);
/* Don't try to optimize for (C)LOB type since it doesn't allow
* comparison.
* RESOLVE: should this check be for LONG VARCHAR also?
*/
if (receiver.getTypeId().getSQLTypeName().equals("CLOB"))
{
return this;
}
/* No need to consider transformation if we already did transformation
* that added = * at bind time.
*/
if (addedEquals)
{
return this;
}
/* if like pattern is not a constant and not a parameter,
* then can't optimize, eg. column LIKE column
*/
if (!(leftOperand instanceof CharConstantNode) &&
!(leftOperand.requiresTypeFromContext()))
{
return this;
}
/* This transformation is only worth doing if it is pushable, ie, if
* the receiver is a ColumnReference.
*/
if (!(receiver instanceof ColumnReference))
{
// We also do an early return here if in bindExpression we found
// we had a territory based Char and put a CAST above the receiver.
//
return this;
}
/*
* In first implementation of non default collation don't attempt
* any transformations for LIKE.
*
* Future possibilities:
* o is it valid to produce a >= clause for a leading constant with
* a wildcard that works across all possible collations? Is
* c1 like a% the same as c1 like a% and c1 >= a'\u0000''\u0000',... ?
*
* This is what was done for national char's. It seems like a
* given collation could sort: ab, a'\u0000'. Is there any guarantee
* about the sort of the unicode '\u0000'.
*
* o National char's didn't try to produce a < than, is there a way
* in collation?
*/
if (receiver.getTypeServices().getCollationType() !=
StringDataValue.COLLATION_TYPE_UCS_BASIC)
{
// don't do any < or >= transformations for non default collations.
return this;
}
/* This is where we do the transformation for LIKE to make it
* optimizable.
* c1 LIKE 'asdf%' -> c1 LIKE 'asdf%' AND c1 >= 'asdf' AND c1 < 'asdg'
* c1 LIKE ? -> c1 LIKE ? and c1 >= ?
* where ? gets calculated at the beginning of execution.
*/
// Build String constants if right side (pattern) is a constant
if (leftOperand instanceof CharConstantNode)
{
String pattern = ((CharConstantNode) leftOperand).getString();
if (!Like.isOptimizable(pattern))
{
return this;
}
int maxWidth = receiver.getTypeServices().getMaximumWidth();
greaterEqualString =
Like.greaterEqualString(pattern, escape, maxWidth);
lessThanString =
Like.lessThanString(pattern, escape, maxWidth);
eliminateLikeComparison =
!Like.isLikeComparisonNeeded(pattern);
}
/* For some unknown reason we need to clone the receiver if it is
* a ColumnReference because reusing them in Qualifiers for a scan
* does not work.
*/
/* The transformed tree has to be normalized. Either:
* AND AND
* / \ / \
* LIKE AND OR: LIKE AND
* / \ / \
* >= AND >= TRUE
* / \
* < TRUE
* unless the like string is of the form CONSTANT%, in which
* case we can do away with the LIKE altogether:
* AND AND
* / \ / \
* >= AND OR: >= TRUE
* / \
* < TRUE
*/
AndNode newAnd = null;
ValueNode trueNode =
(ValueNode) getNodeFactory().getNode(
C_NodeTypes.BOOLEAN_CONSTANT_NODE,
Boolean.TRUE,
getContextManager());
/* Create the AND <, if lessThanString is non-null or
* leftOperand is a parameter.
*/
if (lessThanString != null ||
leftOperand.requiresTypeFromContext())
{
QueryTreeNode likeLTopt;
if (leftOperand.requiresTypeFromContext())
{
// pattern string is a parameter
likeLTopt =
setupOptimizeStringFromParameter(
leftOperand,
rightOperand,
"lessThanStringFromParameter",
receiver.getTypeServices().getMaximumWidth());
}
else
{
// pattern string is a constant
likeLTopt =
getNodeFactory().getNode(
C_NodeTypes.CHAR_CONSTANT_NODE,
lessThanString,
getContextManager());
}
BinaryComparisonOperatorNode lessThan =
(BinaryComparisonOperatorNode) getNodeFactory().getNode(
C_NodeTypes.BINARY_LESS_THAN_OPERATOR_NODE,
receiver.getClone(),
likeLTopt,
getContextManager());
// Disable comparability checks
lessThan.setForQueryRewrite(true);
/* Set type info for the operator node */
lessThan.bindComparisonOperator();
// Use between selectivity for the <
lessThan.setBetweenSelectivity();
/* Create the AND */
newAnd = (AndNode) getNodeFactory().getNode(
C_NodeTypes.AND_NODE,
lessThan,
trueNode,
getContextManager());
newAnd.postBindFixup();
}
/* Create the AND >=. Right side could be a CharConstantNode or a
* ParameterNode.
*/
ValueNode likeGEopt;
if (leftOperand.requiresTypeFromContext())
{
// the pattern is a ?, eg. c1 LIKE ?
// Create an expression off the parameter
// new SQLChar(Like.greaterEqualString(?));
likeGEopt =
setupOptimizeStringFromParameter(
leftOperand,
rightOperand,
"greaterEqualStringFromParameter",
receiver.getTypeServices().getMaximumWidth());
}
else
{
// the pattern is a constant, eg. c1 LIKE 'Derby'
likeGEopt =
(ValueNode) getNodeFactory().getNode(
C_NodeTypes.CHAR_CONSTANT_NODE,
greaterEqualString,
getContextManager());
}
// greaterEqual from (reciever LIKE pattern):
// >=
// / \
// reciever pattern
BinaryComparisonOperatorNode greaterEqual =
(BinaryComparisonOperatorNode) getNodeFactory().getNode(
C_NodeTypes.BINARY_GREATER_EQUALS_OPERATOR_NODE,
receiver.getClone(),
likeGEopt,
getContextManager());
// Disable comparability checks
greaterEqual.setForQueryRewrite(true);
/* Set type info for the operator node */
greaterEqual.bindComparisonOperator();
// Use between selectivity for the >=
greaterEqual.setBetweenSelectivity();
/* Create the AND */
if (newAnd == null)
{
newAnd = (AndNode) getNodeFactory().getNode(
C_NodeTypes.AND_NODE,
greaterEqual,
trueNode,
getContextManager());
}
else
{
newAnd = (AndNode) getNodeFactory().getNode(
C_NodeTypes.AND_NODE,
greaterEqual,
newAnd,
getContextManager());
}
newAnd.postBindFixup();
/* Finally, we put an AND LIKE on top of the left deep tree, but
* only if it is still necessary.
*/
if (!eliminateLikeComparison)
{
newAnd = (AndNode)
getNodeFactory().getNode(
C_NodeTypes.AND_NODE,
this,
newAnd,
getContextManager());
newAnd.postBindFixup();
}
/* Mark this node as transformed so that we don't get
* calculated into the selectivity multiple times.
*/
setTransformed();
return newAnd;
}
/**
* Do code generation for this binary operator.
*
* This code was copied from BinaryOperatorNode and stripped down
*
* @param acb The ExpressionClassBuilder for the class we're generating
* @param mb The method the code to place the code
*
*
* @exception StandardException Thrown on error
*/
public void generateExpression(
ExpressionClassBuilder acb,
MethodBuilder mb)
throws StandardException
{
/*
** if i have a operator.getOrderableType() == constant, then just cache
** it in a field. if i have QUERY_INVARIANT, then it would be good to
** cache it in something that is initialized each execution,
** but how?
*/
/*
** let the receiver type be determined by an
** overridable method so that if methods are
** not implemented on the lowest interface of
** a class, they can note that in the implementation
** of the node that uses the method.
*/
// receiverType = getReceiverInterfaceName();
/*
** Generate LHS (field = <receiver operand>). This assignment is
** used as the receiver of the method call for this operator.
**
** (<receiver operand>).method(
** <left operand>,
** <right operand>,
** [<escaperightOp>,]
** result field>)
*/
receiver.generateExpression(acb, mb); // first arg
receiverInterfaceType = receiver.getTypeCompiler().interfaceName();
mb.upCast(receiverInterfaceType); // cast the method instance
leftOperand.generateExpression(acb, mb);
mb.upCast(leftInterfaceType); // first arg with cast
if (rightOperand != null)
{
rightOperand.generateExpression(acb, mb);
mb.upCast(rightInterfaceType); // second arg with cast
}
/* Figure out the result type name */
// resultTypeName = getTypeCompiler().interfaceName();
mb.callMethod(
VMOpcode.INVOKEINTERFACE,
null,
methodName,
resultInterfaceType,
rightOperand == null ? 1 : 2);
}
private ValueNode setupOptimizeStringFromParameter(
ValueNode parameterNode,
ValueNode escapeNode,
String methodName,
int maxWidth)
throws StandardException
{
Vector param;
if (escapeNode != null)
{
param = new Vector(2);
methodName += "WithEsc";
}
else
{
param = new Vector(1);
}
StaticMethodCallNode methodCall = (StaticMethodCallNode)
getNodeFactory().getNode(
C_NodeTypes.STATIC_METHOD_CALL_NODE,
methodName,
"org.apache.derby.iapi.types.Like",
getContextManager());
// using a method call directly, thus need internal sql capability
methodCall.internalCall = true;
param.addElement(parameterNode);
if (escapeNode != null)
param.addElement(escapeNode);
QueryTreeNode maxWidthNode = getNodeFactory().getNode(
C_NodeTypes.INT_CONSTANT_NODE,
new Integer(maxWidth),
getContextManager());
param.addElement(maxWidthNode);
methodCall.addParms(param);
ValueNode java2SQL =
(ValueNode) getNodeFactory().getNode(
C_NodeTypes.JAVA_TO_SQL_VALUE_NODE,
methodCall,
getContextManager());
java2SQL = (ValueNode) java2SQL.bindExpression(null, null, null);
CastNode likeOpt = (CastNode)
getNodeFactory().getNode(
C_NodeTypes.CAST_NODE,
java2SQL,
parameterNode.getTypeServices(),
getContextManager());
likeOpt.bindCastNodeOnly();
return likeOpt;
}
}
The table below shows all metrics for LikeEscapeOperatorNode.java.
| Metric | Value | Description | |
|---|---|---|---|
| BLOCKS | 54.00 | Number of blocks | |
| BLOCK_COMMENT | 191.00 | Number of block comment lines | |
| COMMENTS | 354.00 | Comment lines | |
| COMMENT_DENSITY | 1.04 | Comment density | |
| COMPARISONS | 45.00 | Number of comparison operators | |
| CYCLOMATIC | 59.00 | Cyclomatic complexity | |
| DECL_COMMENTS | 8.00 | Comments in declarations | |
| DOC_COMMENT | 107.00 | Number of javadoc comment lines | |
| ELOC | 342.00 | Effective lines of code | |
| EXEC_COMMENTS | 68.00 | Comments in executable code | |
| EXITS | 54.00 | Procedure exits | |
| FUNCTIONS | 7.00 | Number of function declarations | |
| HALSTEAD_DIFFICULTY | 75.00 | Halstead difficulty | |
| HALSTEAD_EFFORT | 0.00 | Halstead effort | |
| INTERFACE_COMPLEXITY | 110.00 | Interface complexity | |
| JAVA0001 | 0.00 | JAVA0001 Package name does not contain only lower case letters | |
| JAVA0002 | 0.00 | JAVA0002 Package name does not begin with a top level domain name or country code | |
| JAVA0003 | 0.00 | JAVA0003 Minimize use of on-demand (.*) imports | |
| JAVA0004 | 0.00 | JAVA0004 Unnecessary import from java.lang | |
| JAVA0005 | 1.00 | JAVA0005 Imports not in specified order | |
| JAVA0006 | 0.00 | JAVA0006 Empty finally block | |
| JAVA0007 | 0.00 | JAVA0007 Should not declare public field | |
| JAVA0008 | 0.00 | JAVA0008 Empty catch block | |
| JAVA0009 | 0.00 | JAVA0009 Protected member in final class | |
| JAVA0010 | 0.00 | JAVA0010 Non-instantiable class does not contain a non-private static member | |
| JAVA0011 | 0.00 | JAVA0011 Abstract class does not contain an abstract method | |
| JAVA0012 | 0.00 | JAVA0012 Non-constructor method with same name as declaring class | |
| JAVA0013 | 0.00 | JAVA0013 Non-blank final field is not static | |
| JAVA0014 | 0.00 | JAVA0014 Class with only static members has non-private constructor | |
| JAVA0015 | 0.00 | JAVA0015 Package class contains public nested type | |
| JAVA0016 | 0.00 | JAVA0016 Abstract class contains public constructor | |
| JAVA0017 | 0.00 | JAVA0017 Class name does not have required form | |
| JAVA0018 | 0.00 | JAVA0018 Method name does not have required form | |
| JAVA0019 | 0.00 | JAVA0019 Interface name does not have required form | |
| JAVA0020 | 0.00 | JAVA0020 Field name does not have required form | |
| JAVA0021 | 0.00 | JAVA0021 Interface method name does not have required form | |
| JAVA0022 | 0.00 | JAVA0022 Static final field name does not have required form | |
| JAVA0023 | 0.00 | JAVA0023 Empty finalize method | |
| JAVA0024 | 0.00 | JAVA0024 Empty class | |
| JAVA0025 | 0.00 | JAVA0025 Method override is empty | |
| JAVA0026 | 0.00 | JAVA0026 Finalize method with parameters | |
| JAVA0029 | 0.00 | JAVA0029 Private method not used | |
| JAVA0030 | 0.00 | JAVA0030 Private field not used | |
| JAVA0031 | 0.00 | JAVA0031 Case statement not properly closed | |
| JAVA0032 | 0.00 | JAVA0032 Switch statement missing default | |
| JAVA0033 | 0.00 | JAVA0033 default: not last case in switch statement | |
| JAVA0034 | 1.00 | JAVA0034 Missing braces in if statement | |
| JAVA0035 | 0.00 | JAVA0035 Missing braces in for statement | |
| JAVA0036 | 0.00 | JAVA0036 Missing braces in while statement | |
| JAVA0038 | 0.00 | JAVA0038 Non-case label in switch statement | |
| JAVA0039 | 0.00 | JAVA0039 Break statement with label | |
| JAVA0040 | 0.00 | JAVA0040 Switch statement contains N cases (maximum: M) | |
| JAVA0041 | 0.00 | JAVA0041 Nested synchronized block | |
| JAVA0042 | 0.00 | JAVA0042 Empty synchronized statement | |
| JAVA0043 | 0.00 | JAVA0043 Inner class does not use outer class | |
| JAVA0044 | 0.00 | JAVA0044 Serializable class with no instance variables | |
| JAVA0045 | 0.00 | JAVA0045 Serializable class with only transient fields | |
| JAVA0046 | 0.00 | JAVA0046 Name of class not derived from Exception ends with 'Exception' | |
| JAVA0047 | 0.00 | JAVA0047 Serializable class derives from invalid base class | |
| JAVA0048 | 0.00 | JAVA0048 Name of class derived from Exception does not end with 'Exception' | |
| JAVA0049 | 0.00 | JAVA0049 Nested block at depth N (maximum: M) | |
| JAVA0050 | 0.00 | JAVA0050 Class derives from java.lang.Error | |
| JAVA0051 | 0.00 | JAVA0051 Class derives from java.lang.RuntimeException | |
| JAVA0052 | 0.00 | JAVA0052 Class derives from java.lang.Throwable | |
| JAVA0053 | 0.00 | JAVA0053 Unused label | |
| JAVA0054 | 1.00 | JAVA0054 Inheritance depth N exceeds maximum M | |
| JAVA0055 | 0.00 | JAVA0055 Class should be interface | |
| JAVA0056 | 0.00 | JAVA0056 Unnecessary abstract modifier for interface or annotation | |
| JAVA0057 | 0.00 | JAVA0057 Unnecessary default constructor | |
| JAVA0058 | 0.00 | JAVA0058 Constructor calls super() | |
| JAVA0059 | 0.00 | JAVA0059 Method override only calls super() | |
| JAVA0061 | 0.00 | JAVA0061 Inaccessible member in anonymous class | |
| JAVA0062 | 0.00 | JAVA0062 Public class missing public member or protected constructor | |
| JAVA0063 | 0.00 | JAVA0063 Identifier name should not contain '$' | |
| JAVA0064 | 0.00 | JAVA0064 N variations of identifier name (maximum: M) | |
| JAVA0065 | 0.00 | JAVA0065 Unnecessary final modifier for method in final class | |
| JAVA0066 | 0.00 | JAVA0066 Unnecessary modifier for interface nested type | |
| JAVA0067 | 0.00 | JAVA0067 Array descriptor on identifier name | |
| JAVA0068 | 0.00 | JAVA0068 Modifiers not declared in recommended order | |
| JAVA0071 | 0.00 | JAVA0071 Strings compared with == | |
| JAVA0073 | 0.00 | JAVA0073 Integer division in floating-point context | |
| JAVA0074 | 0.00 | JAVA0074 Use of Object.notify() | |
| JAVA0075 | 3.00 | JAVA0075 Method parameter hides field | |
| JAVA0076 | 0.00 | JAVA0076 Use of magic number | |
| JAVA0077 | 0.00 | JAVA0077 Private field not used in declaring class | |
| JAVA0078 | 0.00 | JAVA0078 Floating point values compared with == | |
| JAVA0079 | 0.00 | JAVA0079 Use of instance to reference static member | |
| JAVA0080 | 6.00 | JAVA0080 Import declaration not used | |
| JAVA0081 | 0.00 | JAVA0081 Boolean literal in comparison | |
| JAVA0082 | 1.00 | JAVA0082 Unnecessary widening cast | |
| JAVA0083 | 0.00 | JAVA0083 Unnecessary instanceof test | |
| JAVA0084 | 0.00 | JAVA0084 Should use compound assignment operator | |
| JAVA0085 | 0.00 | JAVA0085 Use of sun.* class | |
| JAVA0087 | 0.00 | JAVA0087 Use of Thread.sleep() | |
| JAVA0089 | 0.00 | JAVA0089 Use of restricted package | |
| JAVA0092 | 0.00 | JAVA0092 Use of restricted type | |
| JAVA0093 | 0.00 | JAVA0093 Redundant assignment | |
| JAVA0094 | 0.00 | JAVA0094 Field hides a superclass field | |
| JAVA0095 | 0.00 | JAVA0095 Uninitialized private field | |
| JAVA0096 | 0.00 | JAVA0096 Field in nested class hides outer field | |
| JAVA0098 | 1.00 | JAVA0098 Minimize use of implicit field initializers | |
| JAVA0100 | 0.00 | JAVA0100 Class contains N non-final fields (maximum: M) | |
| JAVA0101 | 0.00 | JAVA0101 Unnecessary modifier for field in interface | |
| JAVA0102 | 0.00 | JAVA0102 Last statement in finalize() not super.finalize() | |
| JAVA0103 | 0.00 | JAVA0103 Explicit call to finalize() | |
| JAVA0104 | 0.00 | JAVA0104 finalize() only calls super.finalize() | |
| JAVA0105 | 0.00 | JAVA0105 Duplicate import declaration | |
| JAVA0106 | 1.00 | JAVA0106 Unnecessary import from current package | |
| JAVA0108 | 0.00 | JAVA0108 Incorrect javadoc: no @param tag for 'parameter' | |
| JAVA0109 | 0.00 | JAVA0109 Incorrect javadoc: no parameter 'parameter' | |
| JAVA0110 | 0.00 | JAVA0110 Incorrect javadoc: no @return tag | |
| JAVA0111 | 0.00 | JAVA0111 Incorrect javadoc: @return tag for void method | |
| JAVA0112 | 0.00 | JAVA0112 Incorrect javadoc: no exception 'exception' in throws | |
| JAVA0113 | 1.00 | JAVA0113 Incorrect javadoc: no @author tag | |
| JAVA0114 | 1.00 | JAVA0114 Incorrect javadoc: no @version tag | |
| JAVA0115 | 0.00 | JAVA0115 Incorrect javadoc: no @throws or @exception tag for 'exception' | |
| JAVA0116 | 0.00 | JAVA0116 Missing javadoc: field 'field' | |
| JAVA0117 | 0.00 | JAVA0117 Missing javadoc: method 'method' | |
| JAVA0118 | 0.00 | JAVA0118 Missing javadoc: type 'type' | |
| JAVA0119 | 0.00 | JAVA0119 Control variable changed within body of for loop | |
| JAVA0123 | 0.00 | JAVA0123 Use all three components of for loop | |
| JAVA0125 | 0.00 | JAVA0125 Continue statement with label | |
| JAVA0126 | 0.00 | JAVA0126 Method declares unchecked exception in throws | |
| JAVA0128 | 0.00 | JAVA0128 Public constructor in non-public class | |
| JAVA0130 | 0.00 | JAVA0130 Non-static method does not use instance fields | |
| JAVA0131 | 0.00 | JAVA0131 Compatible method does not override base | |
| JAVA0132 | 0.00 | JAVA0132 Method overload with compatible signature | |
| JAVA0133 | 0.00 | JAVA0133 Non-synchronized method overrides synchronized method | |
| JAVA0135 | 0.00 | JAVA0135 Only one of Object.equals and Object.hashCode defined: missing 'method' | |
| JAVA0136 | 0.00 | JAVA0136 N methods defined in class (maximum: M) | |
| JAVA0137 | 1.00 | JAVA0137 Non-abstract class missing constructor | |
| JAVA0138 | 0.00 | JAVA0138 N parameters defined for method (maximum: M) | |
| JAVA0139 | 0.00 | JAVA0139 Definition of main other than public static void main(java.lang.String[]) | |
| JAVA0141 | 0.00 | JAVA0141 Unnecessary modifier for method in interface | |
| JAVA0143 | 0.00 | JAVA0143 Synchronized method | |
| JAVA0144 | 0.00 | JAVA0144 Line exceeds maximum M characters | |
| JAVA0145 | 15.00 | JAVA0145 Tab character used in source file | |
| JAVA0150 | 0.00 | JAVA0150 java.lang.Error (or subclass) thrown | |
| JAVA0153 | 0.00 | JAVA0153 Inefficient conversion of integer to string | |
| JAVA0159 | 0.00 | JAVA0159 Inefficient conversion of string to integer | |
| JAVA0160 | 0.00 | JAVA0160 Method does not throw specified exception | |
| JAVA0161 | 0.00 | JAVA0161 Conditional wait() not in loop | |
| JAVA0163 | 0.00 | JAVA0163 Empty statement | |
| JAVA0165 | 0.00 | JAVA0165 Conflicting return statement in finally block | |
| JAVA0166 | 0.00 | JAVA0166 Generic exception caught | |
| JAVA0167 | 0.00 | JAVA0167 ThreadDeath not rethrown | |
| JAVA0169 | 0.00 | JAVA0169 Unnecessary catch block: exception 'exception' | |
| JAVA0170 | 0.00 | JAVA0170 Caught exception not derived from java.lang.Exception | |
| JAVA0171 | 1.00 | JAVA0171 Unused local variable | |
| JAVA0173 | 0.00 | JAVA0173 Unused method parameter | |
| JAVA0174 | 1.00 | JAVA0174 Assigned local variable never used | |
| JAVA0175 | 0.00 | JAVA0175 Successive assignment to variable | |
| JAVA0176 | 0.00 | JAVA0176 Local variable name does not have required form | |
| JAVA0177 | 3.00 | JAVA0177 Variable declaration missing initializer | |
| JAVA0179 | 0.00 | JAVA0179 Local variable hides visible field | |
| JAVA0233 | 0.00 | JAVA0233 Definition of serialVersionUID other than 'private static final long serialVersionUID' | |
| JAVA0234 | 0.00 | JAVA0234 Class is Serializable but does not define serialVersionUID | |
| JAVA0235 | 0.00 | JAVA0235 Class defines serialVersionUID but does not implement Serializable | |
| JAVA0236 | 0.00 | JAVA0236 Attempt to clone an object which does not implement Cloneable | |
| JAVA0237 | 0.00 | JAVA0237 Class implements Cloneable but does not have public clone method | |
| JAVA0238 | 0.00 | JAVA0238 Clone method does not call super.clone() | |
| JAVA0239 | 0.00 | JAVA0239 Class declares 'readObject' or 'writeObject' but does not implement Serializable | |
| JAVA0240 | 0.00 | JAVA0240 Serializable class which declares readObject or writeObject but not both | |
| JAVA0241 | 0.00 | JAVA0241 'readObject' or 'writeObject' should be declared private in Serializable class | |
| JAVA0242 | 0.00 | JAVA0242 Transient field in non-Serializable class | |
| JAVA0243 | 0.00 | JAVA0243 'readResolve' or 'writeReplace' should be declared private or protected | |
| JAVA0244 | 0.00 | JAVA0244 Field or method name in subclass differs only by case from inherited field or method | |
| JAVA0245 | 0.00 | JAVA0245 JUnit TestCase with non-trivial constructor | |
| JAVA0246 | 0.00 | JAVA0246 JUnit assertXXX statement missing message parameter | |
| JAVA0247 | 0.00 | JAVA0247 JUnit 'setUp()' and 'tearDown()' should call super method | |
| JAVA0248 | 0.00 | JAVA0248 JUnit method 'setUp' or 'tearDown' with incorrect signature | |
| JAVA0249 | 0.00 | JAVA0249 JUnit TestCase 'suite()' should be declared static | |
| JAVA0250 | 0.00 | JAVA0250 JUnit TestCase declares testXXX method with incorrect signature | |
| JAVA0251 | 0.00 | JAVA0251 Use '%n' for line breaks in printf/format for platform independence | |
| JAVA0252 | 0.00 | JAVA0252 'enum' is a Java 1.5 reserved word | |
| JAVA0253 | 0.00 | JAVA0253 Not all enum constants consumed in switch statement | |
| JAVA0254 | 0.00 | JAVA0254 Use enhanced for loop construct instead of Iterator | |
| JAVA0255 | 0.00 | JAVA0255 Result of method invocation not used | |
| JAVA0256 | 0.00 | JAVA0256 Assignment of external collection/array to field | |
| JAVA0257 | 0.00 | JAVA0257 Use of 'Constant Interface' anti-pattern | |
| JAVA0258 | 0.00 | JAVA0258 Implement Iterable for foreach compatibility | |
| JAVA0259 | 0.00 | JAVA0259 Return of collection/array field | |
| JAVA0260 | 0.00 | JAVA0260 Use 'enum' instead of Enumerated Type pattern | |
| JAVA0261 | 0.00 | JAVA0261 Use specialized Enum collection types | |
| JAVA0262 | 0.00 | JAVA0262 Use of char in integer context | |
| JAVA0263 | 0.00 | JAVA0263 Long literal ends with 'l' instead of 'L' | |
| JAVA0264 | 0.00 | JAVA0264 Integer math in long context - check for overflow | |
| JAVA0265 | 0.00 | JAVA0265 Use of Throwable.printStackTrace() | |
| JAVA0266 | 0.00 | JAVA0266 Use of System.out | |
| JAVA0267 | 0.00 | JAVA0267 Use of System.err | |
| JAVA0269 | 0.00 | JAVA0269 Contents of StringBuffer never used | |
| JAVA0270 | 0.00 | JAVA0270 Use Java 5.0 enhanced for loop construct to iterate over all elements in an array | |
| JAVA0271 | 0.00 | JAVA0271 Minimize use of on-demand (.*) static imports | |
| JAVA0272 | 0.00 | JAVA0272 Thread.run() called | |
| JAVA0273 | 0.00 | JAVA0273 Non-final derivative of Thread calls start() in constructor | |
| JAVA0274 | 0.00 | JAVA0274 Serializable class has a synchronized readObject() | |
| JAVA0275 | 0.00 | JAVA0275 Serializable class has a synchronized writeObject() and no other synchronized methods | |
| JAVA0276 | 0.00 | JAVA0276 Unnecessary use of String constructor | |
| JAVA0277 | 0.00 | JAVA0277 Iterator.next() implementation does not throw NoSuchElementException | |
| JAVA0278 | 0.00 | JAVA0278 Unnecessary use of Boolean constructor | |
| JAVA0279 | 0.00 | JAVA0279 Serialization method readObject or readObjectNoData calls an overridable method | |
| JAVA0280 | 0.00 | JAVA0280 IllegalMonitorStateException caught | |
| JAVA0281 | 0.00 | JAVA0281 Iterator.next() not called in loop | |
| JAVA0282 | 0.00 | JAVA0282 Call to Iterator.next() in loop which does not test Iterator.hasNext() | |
| JAVA0283 | 0.00 | JAVA0283 Control variable not updated in loop body | |
| JAVA0284 | 0.00 | JAVA0284 Explicit garbage collection | |
| JAVA0285 | 2.00 | JAVA0285 Dereference of potentially null variable | |
| JAVA0286 | 0.00 | JAVA0286 Dereference of null variable | |
| JAVA0287 | 0.00 | JAVA0287 Unnecessary null check | |
| JAVA0288 | 0.00 | JAVA0288 Inconsistent null check | |
| LINES | 933.00 | Number of lines in the source file | |
| LINE_COMMENT | 56.00 | Number of line comments | |
| LOC | 447.00 | Lines of code | |
| LOGICAL_LINES | 139.00 | Number of statements | |
| LOOPS | 0.00 | Number of loops | |
| NEST_DEPTH | 4.00 | Maximum nesting depth | |
| OPERANDS | 780.00 | Number of operands | |
| OPERATORS | 1500.00 | Number of operators | |
| PARAMS | 16.00 | Number of formal parameter declarations | |
| PROGRAM_LENGTH | 2280.00 | Halstead program length | |
| PROGRAM_VOCAB | 248.00 | Halstead program vocabulary | |
| PROGRAM_VOLUME | 0.00 | Halstead program volume | |
| RETURNS | 94.00 | Number of return points from functions | |
| SIZE | 32038.00 | Size of the file in bytes | |
| UNIQUE_OPERANDS | 208.00 | Number of unique operands | |
| UNIQUE_OPERATORS | 40.00 | Number of unique operators | |
| WHITESPACE | 132.00 | Number of whitespace lines | |