View Javadoc
1   /*
2    *    Copyright 2006-2023 the original author or authors.
3    *
4    *    Licensed under the Apache License, Version 2.0 (the "License");
5    *    you may not use this file except in compliance with the License.
6    *    You may obtain a copy of the License at
7    *
8    *       https://www.apache.org/licenses/LICENSE-2.0
9    *
10   *    Unless required by applicable law or agreed to in writing, software
11   *    distributed under the License is distributed on an "AS IS" BASIS,
12   *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   *    See the License for the specific language governing permissions and
14   *    limitations under the License.
15   */
16  package org.mybatis.generator.codegen.mybatis3.javamapper.elements;
17  
18  import java.util.Set;
19  import java.util.TreeSet;
20  
21  import org.mybatis.generator.api.dom.java.FullyQualifiedJavaType;
22  import org.mybatis.generator.api.dom.java.Interface;
23  import org.mybatis.generator.api.dom.java.JavaVisibility;
24  import org.mybatis.generator.api.dom.java.Method;
25  import org.mybatis.generator.api.dom.java.Parameter;
26  
27  public class SelectByExampleWithBLOBsMethodGenerator extends AbstractJavaMapperMethodGenerator {
28  
29      public SelectByExampleWithBLOBsMethodGenerator() {
30          super();
31      }
32  
33      @Override
34      public void addInterfaceElements(Interface interfaze) {
35          Set<FullyQualifiedJavaType> importedTypes = new TreeSet<>();
36          FullyQualifiedJavaType type = new FullyQualifiedJavaType(introspectedTable.getExampleType());
37          importedTypes.add(type);
38          importedTypes.add(FullyQualifiedJavaType.getNewListInstance());
39  
40          Method method = new Method(introspectedTable.getSelectByExampleWithBLOBsStatementId());
41          method.setVisibility(JavaVisibility.PUBLIC);
42          method.setAbstract(true);
43  
44          FullyQualifiedJavaType returnType = FullyQualifiedJavaType.getNewListInstance();
45          FullyQualifiedJavaType listType;
46          if (introspectedTable.getRules().generateRecordWithBLOBsClass()) {
47              listType = new FullyQualifiedJavaType(introspectedTable.getRecordWithBLOBsType());
48          } else {
49              // the blob fields must be rolled up into the base class
50              listType = new FullyQualifiedJavaType(introspectedTable.getBaseRecordType());
51          }
52  
53          importedTypes.add(listType);
54          returnType.addTypeArgument(listType);
55          method.setReturnType(returnType);
56          method.addParameter(new Parameter(type, "example")); //$NON-NLS-1$
57  
58          context.getCommentGenerator().addGeneralMethodComment(method, introspectedTable);
59  
60          addMapperAnnotations(interfaze, method);
61  
62          if (context.getPlugins()
63                  .clientSelectByExampleWithBLOBsMethodGenerated(method, interfaze, introspectedTable)) {
64              addExtraImports(interfaze);
65              interfaze.addImportedTypes(importedTypes);
66              interfaze.addMethod(method);
67          }
68      }
69  
70      public void addMapperAnnotations(Interface interfaze, Method method) {
71          // extension point for subclasses
72      }
73  
74      public void addExtraImports(Interface interfaze) {
75          // extension point for subclasses
76      }
77  }