github/jooq
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[#2430] Add CustomQueryPart for use with plain SQL and other places

Browse Source
This commit is contained in:
Lukas Eder 2013-05-03 11:04:47 +02:00
parent 868b1ac275
commit b93e8f84d2
2 changed files with 199 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

113
jOOQ/src/main/java/org/jooq/impl/CustomQueryPart.java Normal file
View File

@ -0,0 +1,113 @@
/**
* Copyright (c) 2009-2013, Lukas Eder, lukas.eder@gmail.com
* All rights reserved.
*
* This software is licensed to you under the Apache License, Version 2.0
* (the "License"); You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* . Redistributions of source code must retain the above copyright notice, this
* list of conditions and the following disclaimer.
*
* . Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* . Neither the name "jOOQ" nor the names of its contributors may be
* used to endorse or promote products derived from this software without
* specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*/
package org.jooq.impl;
import org.jooq.BindContext;
import org.jooq.QueryPart;
import org.jooq.RenderContext;
import org.jooq.exception.DataAccessException;
/**
* A base class for custom {@link QueryPart} implementations in client code.
* <p>
* Client code may provide proper {@link QueryPart} implementations extending
* this useful base class. All necessary parts of the {@link QueryPart}
* interface are already implemented. Only these two methods need further
* implementation:
* <ul>
* <li>{@link #toSQL(org.jooq.RenderContext)}</li>
* <li>{@link #bind(org.jooq.BindContext)}</li>
* </ul>
* Refer to those methods' Javadoc for further details about their expected
* behaviour.
* <p>
* Such custom <code>QueryPart</code> implementations can be useful in any of
* these scenarios:
* <ul>
* <li>When reusing a custom <code>QueryPart</code> in other custom
* <code>QueryPart</code>s, e.g. in {@link CustomCondition}, {@link CustomField}, {@link CustomTable}, etc.</li>
* <li>When inlining a custom <code>QueryPart</code> in plain SQL methods, such
* as {@link DSL#condition(String, QueryPart...)},
* {@link DSL#field(String, QueryPart...)},
* {@link DSL#table(String, QueryPart...)}</li>
* </ul>
*
* @author Lukas Eder
*/
public abstract class CustomQueryPart extends AbstractQueryPart {
/**
* Generated UID
*/
private static final long serialVersionUID = -3439681086987884991L;
protected CustomQueryPart() {
}
// -------------------------------------------------------------------------
// Implementation required
// -------------------------------------------------------------------------
/**
* Subclasses must implement this method
* <hr/>
* {@inheritDoc}
*/
@Override
public abstract void toSQL(RenderContext context);
/**
* Subclasses must implement this method
* <hr/>
* {@inheritDoc}
*/
@Override
public abstract void bind(BindContext context) throws DataAccessException;
// -------------------------------------------------------------------------
// No further overrides allowed
// -------------------------------------------------------------------------
@Override
public final boolean declaresFields() {
return super.declaresFields();
}
@Override
public final boolean declaresTables() {
return super.declaresTables();
}
}

86
jOOQ/src/test/java/org/jooq/test/CustomQueryPartTest.java Normal file
View File

@ -0,0 +1,86 @@
/**
* Copyright (c) 2009-2013, Lukas Eder, lukas.eder@gmail.com
* All rights reserved.
*
* This software is licensed to you under the Apache License, Version 2.0
* (the "License"); You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* . Redistributions of source code must retain the above copyright notice, this
* list of conditions and the following disclaimer.
*
* . Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* . Neither the name "jOOQ" nor the names of its contributors may be
* used to endorse or promote products derived from this software without
* specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*/
package org.jooq.test;
import static junit.framework.Assert.assertEquals;
import static org.jooq.impl.DSL.val;
import org.jooq.BindContext;
import org.jooq.QueryPart;
import org.jooq.RenderContext;
import org.jooq.impl.CustomQueryPart;
import org.jooq.impl.DSL;
import org.jmock.Expectations;
import org.junit.Test;
/**
* Test cases for custom {@link QueryPart}s.
*
* @author Lukas Eder
*/
public class CustomQueryPartTest extends AbstractTest {
@SuppressWarnings("serial")
@Test
public void testCustomQueryPart() throws Exception {
QueryPart p = new CustomQueryPart() {
@Override
public void toSQL(RenderContext ctx) {
ctx.sql(val("abc"));
}
@Override
public void bind(BindContext ctx) {
ctx.bind(val("abc"));
}
};
assertEquals("(x = ?)", r_ref().render(DSL.condition("x = {0}", p)));
assertEquals("(x = :1)", r_refP().render(DSL.condition("x = {0}", p)));
assertEquals("(x = 'abc')", r_refI().render(DSL.condition("x = {0}", p)));
context.checking(new Expectations() {{
oneOf(statement).setString(1, "abc");
}});
int i = b_ref().bind(DSL.condition("x = {0}", p)).peekIndex();
assertEquals(2, i);
context.assertIsSatisfied();
}
}