View Javadoc
1   /*
2    *    Copyright 2016-2025 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.dynamic.sql.select;
17  
18  import java.util.Objects;
19  
20  import org.mybatis.dynamic.sql.SortSpecification;
21  import org.mybatis.dynamic.sql.render.RenderingContext;
22  import org.mybatis.dynamic.sql.util.FragmentAndParameters;
23  
24  /**
25   * This class is used for an order by phrase where there is no suitable column name
26   * to use (for example a calculated column or an aggregate column).
27   *
28   * @author Jeff Butler
29   */
30  public class SimpleSortSpecification implements SortSpecification {
31  
32      private final String name;
33      private final String descendingPhrase;
34  
35      private SimpleSortSpecification(String name) {
36          this(name, ""); //$NON-NLS-1$
37      }
38  
39      private SimpleSortSpecification(String name, String descendingPhrase) {
40          this.name = Objects.requireNonNull(name);
41          this.descendingPhrase = descendingPhrase;
42      }
43  
44      @Override
45      public SortSpecification descending() {
46          return new SimpleSortSpecification(name, " DESC"); //$NON-NLS-1$
47      }
48  
49      @Override
50      public FragmentAndParameters renderForOrderBy(RenderingContext renderingContext) {
51          return FragmentAndParameters.fromFragment(name + descendingPhrase);
52      }
53  
54      public static SimpleSortSpecification of(String name) {
55          return new SimpleSortSpecification(name);
56      }
57  }