View Javadoc
1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one or more
3    * contributor license agreements.  See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * The ASF licenses this file to You under the Apache License, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License.  You may obtain a copy of the License at
8    *
9    *     http://www.apache.org/licenses/LICENSE-2.0
10   *
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the License for the specific language governing permissions and
15   * limitations under the License.
16   */
17  
18  package org.apache.shardingsphere.infra.executor.sql.execute.result.query;
19  
20  import org.apache.shardingsphere.infra.executor.sql.execute.result.ExecuteResult;
21  
22  import java.io.InputStream;
23  import java.io.Reader;
24  import java.sql.SQLException;
25  import java.util.Calendar;
26  
27  /**
28   * Query result.
29   */
30  public interface QueryResult extends ExecuteResult, AutoCloseable {
31      
32      /**
33       * Iterate next data.
34       *
35       * @return has next data
36       * @throws SQLException SQL exception
37       */
38      boolean next() throws SQLException;
39      
40      /**
41       * Get data value.
42       *
43       * @param columnIndex column index
44       * @param type class type of data value
45       * @return data value
46       * @throws SQLException SQL exception
47       */
48      Object getValue(int columnIndex, Class<?> type) throws SQLException;
49      
50      /**
51       * Get calendar value.
52       *
53       * @param columnIndex column index
54       * @param type class type of data value
55       * @param calendar calendar
56       * @return calendar value
57       * @throws SQLException SQL exception
58       */
59      Object getCalendarValue(int columnIndex, Class<?> type, Calendar calendar) throws SQLException;
60      
61      /**
62       * Get input stream.
63       *
64       * @param columnIndex column index
65       * @param type class type of data value
66       * @return input stream
67       * @throws SQLException SQL exception
68       */
69      InputStream getInputStream(int columnIndex, String type) throws SQLException;
70      
71      /**
72       * Get CharacterStream.
73       *
74       * @param columnIndex column index
75       * @return reader
76       * @throws SQLException SQL exception
77       */
78      Reader getCharacterStream(int columnIndex) throws SQLException;
79      
80      /**
81       * Judge result set is null or not.
82       *
83       * @return result set is null or not
84       * @throws SQLException SQL exception
85       */
86      boolean wasNull() throws SQLException;
87      
88      /**
89       * Get query result meta data.
90       * 
91       * @return query result meta data
92       */
93      QueryResultMetaData getMetaData();
94  }