1 /*
2    Copyright (c) 2010, Oracle and/or its affiliates. All rights reserved.
3 
4    This program is free software; you can redistribute it and/or modify
5    it under the terms of the GNU General Public License, version 2.0,
6    as published by the Free Software Foundation.
7 
8    This program is also distributed with certain software (including
9    but not limited to OpenSSL) that is licensed under separate terms,
10    as designated in a particular file or component or in included license
11    documentation.  The authors of MySQL hereby grant you an additional
12    permission to link the program and your derivative works with the
13    separately licensed software that they have included with MySQL.
14 
15    This program is distributed in the hope that it will be useful,
16    but WITHOUT ANY WARRANTY; without even the implied warranty of
17    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18    GNU General Public License, version 2.0, for more details.
19 
20    You should have received a copy of the GNU General Public License
21    along with this program; if not, write to the Free Software
22    Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301  USA
23 */
24 
25 package com.mysql.clusterj.core.store;
26 
27 /**
28  *
29  */
30 public interface Index {
31 
32     /** Is this index unique?
33      *
34      * @return true if the index is unique
35      */
isUnique()36     public boolean isUnique();
37 
38     /** Get the external name of the index,
39      * i.e the name used to create the index.
40      *
41      * @return the name
42      */
getName()43     public String getName();
44 
45     /** Get the actual name of the index,
46      * e.g. idx_name_hash$unique.
47      *
48      * @return the actual name of the index
49      */
getInternalName()50     public String getInternalName();
51 
52     /** Get the names of the columns in this index, in the order
53      * they are declared in the KEY clause of the CREATE TABLE
54      * statement.
55      *
56      * @return the column names
57      */
getColumnNames()58     public String[] getColumnNames();
59 
60 }
61