001: /*
002: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
003: *
004: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
005: *
006: * The contents of this file are subject to the terms of either the GNU
007: * General Public License Version 2 only ("GPL") or the Common
008: * Development and Distribution License("CDDL") (collectively, the
009: * "License"). You may not use this file except in compliance with the
010: * License. You can obtain a copy of the License at
011: * http://www.netbeans.org/cddl-gplv2.html
012: * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
013: * specific language governing permissions and limitations under the
014: * License. When distributing the software, include this License Header
015: * Notice in each file and include the License file at
016: * nbbuild/licenses/CDDL-GPL-2-CP. Sun designates this
017: * particular file as subject to the "Classpath" exception as provided
018: * by Sun in the GPL Version 2 section of the License file that
019: * accompanied this code. If applicable, add the following below the
020: * License Header, with the fields enclosed by brackets [] replaced by
021: * your own identifying information:
022: * "Portions Copyrighted [year] [name of copyright owner]"
023: *
024: * Contributor(s):
025: *
026: * The Original Software is NetBeans. The Initial Developer of the Original
027: * Software is Sun Microsystems, Inc. Portions Copyright 1997-2007 Sun
028: * Microsystems, Inc. All Rights Reserved.
029: *
030: * If you wish your version of this file to be governed by only the CDDL
031: * or only the GPL Version 2, indicate your decision by adding
032: * "[Contributor] elects to include this software in this distribution
033: * under the [CDDL or GPL Version 2] license." If you do not indicate a
034: * single choice of license, a recipient has the option to distribute
035: * your version of this file under either the CDDL, the GPL Version 2 or
036: * to extend the choice of license to its licensees as provided above.
037: * However, if you add GPL Version 2 code and therefore, elected the GPL
038: * Version 2 license, then the option applies only if the new code is
039: * made subject to such option by the copyright holder.
040: */
041: package org.netbeans.modules.sql.framework.model;
042:
043: import org.netbeans.modules.sql.framework.model.DBColumn;
044: import java.util.List;
045:
046: /**
047: * Interface describing index metadata for data sources providing information
048: * in a database or database-like format. Implementing classes must support the
049: * Cloneable interface.
050: *
051: * @author Jonathan Giron
052: */
053: public interface Index extends Cloneable {
054:
055: /**
056: * Gets (optional) name of this index.
057: *
058: * @return Index name, or null if none was defined
059: */
060: public String getName();
061:
062: /**
063: * Gets reference to ETLTable that owns this Index.
064: *
065: * @return parent ETLTable
066: */
067: public DBTable getParent();
068:
069: /**
070: * Gets type of index.
071: *
072: * @return index type, as enumerated in DatabaseMetaData
073: * @see java.sql.DatabaseMetaData#tableIndexClustered
074: * @see java.sql.DatabaseMetaData#tableIndexHashed
075: * @see java.sql.DatabaseMetaData#tableIndexOther
076: */
077: public int getType();
078:
079: /**
080: * Indicates whether this index enforces uniqueness
081: *
082: * @return true if index enforces uniqueness, false otherwise
083: */
084: public boolean isUnique();
085:
086: /**
087: * Gets sort order, if any, used in this index
088: *
089: * @return String indicating sort order; 'A' for ascending, 'D' for
090: * descending, null if no sort order is established
091: */
092: public String getSortSequence();
093:
094: /**
095: * Gets cardinality of this index
096: *
097: * @return value representing cardinality of the index
098: */
099: public int getCardinality();
100:
101: /**
102: * Gets read-only List of Strings (in sequential order) representing names
103: * of indexed columns.
104: *
105: * @return List of names of indexed columns
106: */
107: public List<String> getColumnNames();
108:
109: /**
110: * Gets count of indexed columns.
111: *
112: * @return column count
113: */
114: public int getColumnCount();
115:
116: /**
117: * Gets ordinal (base-one) sequence of the given DBColumn in this Index,
118: * provided it exists. The return value ranges from 1 (first column) to n,
119: * where n is the total number of columns indexed, or -1 if col
120: * is not indexed by this instance.
121: *
122: * @param col DBColumn whose sequence is requested
123: * @return ordinal sequence of col, starting with 1 if the column is the
124: * first in a composite index; -1 if col is not indexed by this instance
125: */
126: public int getSequence(DBColumn col);
127:
128: /**
129: * Gets name of the column positioned as the iColumn-th column, if any,
130: * indexed by this Index. iColumn ranges from 1 (first column)
131: * to n, where n is the total number of columns indexed.
132: *
133: * @param iColumn index of column whose name is requested
134: * @return name of iColumn-th indexed column, or null if no column exists
135: * at the given position.
136: */
137: public String getColumnName(int iColumn);
138:
139: /**
140: * Indicates whether the column represented by the given columnName
141: * is indexed by this instance.
142: *
143: * @param columnName name of column to test
144: * @return true if columnName is indexed by this instance, false otherwise.
145: */
146: public boolean contains(String columnName);
147:
148: /**
149: * Indicates whether this column is indexed by this instance.
150: *
151: * @param col DBColumn to test
152: * @return true if columnName is indexed by this instance, false otherwise.
153: */
154: public boolean contains(DBColumn col);
155: }
|