package org.apache.torque.sql.whereclausebuilder;
/*
* 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.
*/
import org.apache.torque.TorqueException;
import org.apache.torque.adapter.Adapter;
import org.apache.torque.criteria.PreparedStatementPart;
import org.apache.torque.criteria.SqlEnum;
import org.apache.torque.sql.WhereClauseExpression;
/**
* Builds a PreparedStatementPart from a WhereClauseExpression containing
* a <code>SqlEnum.CUSTOM</code> operator.
*
* @version $Id: CustomBuilder.java 1448414 2013-02-20 21:06:35Z tfischer $
*/
public class CustomBuilder implements WhereClausePsPartBuilder
{
/**
* Builds the PS part for a WhereClauseExpression with a
* <code>SqlEnum.CUSTOM</code> operator.
* The rendered SQL contains only the RHS of the whereClauseExpression
* as String.
*
* @param whereClausePart the part of the where clause to build.
* Can be modified in this method.
* @param ignoreCase If true and columns represent Strings, the appropriate
* function defined for the database will be used to ignore
* differences in case.
* @param adapter The adapter for the database for which the SQL
* should be created, not null.
*
* @return the rendered SQL for the WhereClauseExpression
*/
public PreparedStatementPart buildPs(
WhereClauseExpression whereClausePart,
boolean ignoreCase,
Adapter adapter)
throws TorqueException
{
if (!(whereClausePart.getRValue() instanceof String))
{
throw new TorqueException(
"rValue must be a String for the operator "
+ whereClausePart.getOperator());
}
PreparedStatementPart result = new PreparedStatementPart();
result.getSql().append(whereClausePart.getRValue());
return result;
}
/**
* Returns whether this WhereClausePsPartBuilder is applicable for
* a given WhereClauseExpression.
*
* @param whereClauseExpression the WhereClauseExpression in question.
* @param adapter The adapter for the database for which the SQL
* should be created, not null.
*
* @return true if applicable, false otherwise.
*/
public boolean isApplicable(
WhereClauseExpression whereClauseExpression,
Adapter adapter)
{
if (whereClauseExpression.getOperator().equals(SqlEnum.CUSTOM))
{
return true;
}
return false;
}
}